@microsoft/agents-hosting-extensions-teams
Version:
Microsoft 365 Agents SDK for JavaScript. Teams extensions
116 lines (115 loc) • 4.56 kB
TypeScript
import { AgentApplication, RouteHandler, TurnState } from '@microsoft/agents-hosting';
/**
* Class that exposes all Teams meeting-related events.
* Provides an organized way to handle meeting events in Microsoft Teams.
*/
export declare class Meeting<TState extends TurnState> {
private _app;
/**
* Creates a new instance of the Meetings class.
* @param app - The agent application
*/
constructor(app: AgentApplication<TState>);
/**
* Triggered when a meeting starts.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onMeetingStart(handler: RouteHandler<TState>): this;
/**
* Triggered when a meeting ends.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onMeetingEnd(handler: RouteHandler<TurnState>): this;
/**
* Triggered when participants join a meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onParticipantsJoin(handler: RouteHandler<TurnState>): this;
/**
* Triggered when participants leave a meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onParticipantsLeave(handler: RouteHandler<TurnState>): this;
/**
* Triggered when a physical meeting room joins a Teams meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onRoomJoin(handler: RouteHandler<TurnState>): this;
/**
* Triggered when a physical meeting room leaves a Teams meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onRoomLeave(handler: RouteHandler<TurnState>): this;
/**
* Triggered when your app is viewed in the meeting stage.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onStageView(handler: RouteHandler<TurnState>): this;
/**
* Processes smart reply recommendations during meetings.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onSmartReply(handler: RouteHandler<TurnState>): this;
/**
* Captures emoji reactions during meetings.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onReaction(handler: RouteHandler<TurnState>): this;
/**
* Processes responses to polls during meetings.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onPollResponse(handler: RouteHandler<TurnState>): this;
/**
* Notifies when apps are installed during a meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onAppsInstalled(handler: RouteHandler<TurnState>): this;
/**
* Notifies when apps are removed during a meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onAppsUninstalled(handler: RouteHandler<TurnState>): this;
/**
* Triggered when a meeting is recorded.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onRecordingStarted(handler: RouteHandler<TurnState>): this;
/**
* Triggered when recording is stopped in a meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onRecordingStopped(handler: RouteHandler<TurnState>): this;
/**
* Triggered when the focus of the meeting changes.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onFocusChange(handler: RouteHandler<TurnState>): this;
/**
* Triggered when screen sharing starts in a meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onScreenShareStart(handler: RouteHandler<TurnState>): this;
/**
* Triggered when screen sharing stops in a meeting.
* @param handler - The handler to call when this event occurs
* @returns this (for method chaining)
*/
onScreenShareStop(handler: RouteHandler<TurnState>): this;
}