Class TeamsInfo

Provides utility methods for interacting with Microsoft Teams-specific features. This class includes methods for retrieving team details, meeting information, sending messages, and managing operations within the Teams environment.

Index

Constructors

constructor

Methods

cancelOperation getFailedEntries getMeetingInfo getMeetingParticipant getMember getOperationState getPagedMembers getPagedTeamMembers getTeamChannels getTeamDetails getTeamMember sendMeetingNotification sendMessageToAllUsersInTeam sendMessageToAllUsersInTenant sendMessageToListOfChannels sendMessageToListOfUsers sendMessageToTeamsChannel

Constructors

constructor

new TeamsInfo(): TeamsInfo
Returns TeamsInfo

Methods

`Static`cancelOperation

cancelOperation(
context: TurnContext,
operationId: string,
): Promise<CancelOperationResponse>
Cancels an operation.
Parameters
- context: TurnContext
  The turn context.
- operationId: string
  The operation ID.
Returns Promise<CancelOperationResponse>
- The cancel operation response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:414

`Static`getFailedEntries

getFailedEntries(
context: TurnContext,
operationId: string,
): Promise<BatchFailedEntriesResponse>
Gets the failed entries of an operation.
Parameters
- context: TurnContext
  The turn context.
- operationId: string
  The operation ID.
Returns Promise<BatchFailedEntriesResponse>
- The failed entries response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:399

`Static`getMeetingInfo

getMeetingInfo(context: TurnContext, meetingId?: string): Promise<MeetingInfo>
Gets the meeting information.
Parameters
- context: TurnContext
  The turn context.
- OptionalmeetingId: string
  The meeting ID.
Returns Promise<MeetingInfo>
- The meeting information.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:81

`Static`getMeetingParticipant

getMeetingParticipant(
    context: TurnContext,
    meetingId?: string,
    participantId?: string,
    tenantId?: string,
): Promise<
    TeamsMeetingParticipant<
        TurnState<DefaultConversationState, DefaultUserState>,
    >,
>
Gets the meeting participant information.
Parameters
- context: TurnContext
  The turn context.
- OptionalmeetingId: string
  The meeting ID.
- OptionalparticipantId: string
  The participant ID.
- OptionaltenantId: string
  The tenant ID.
Returns Promise<
    TeamsMeetingParticipant<
        TurnState<DefaultConversationState, DefaultUserState>,
    >,
>
- The meeting participant information.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:34

`Static`getMember

getMember(context: TurnContext, userId: string): Promise<TeamsChannelAccount>
Gets a member of a team or conversation.
Parameters
- context: TurnContext
  The turn context.
- userId: string
  The user ID.
Returns Promise<TeamsChannelAccount>
- The member information.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:215

`Static`getOperationState

getOperationState(
context: TurnContext,
operationId: string,
): Promise<BatchOperationStateResponse>
Gets the operation state.
Parameters
- context: TurnContext
  The turn context.
- operationId: string
  The operation ID.
Returns Promise<BatchOperationStateResponse>
- The operation state response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:384

`Static`getPagedMembers

getPagedMembers(
    context: TurnContext,
    pageSize?: number,
    continuationToken?: string,
): Promise<TeamsPagedMembersResult>
Gets the paged members of a team or conversation.
Parameters
- context: TurnContext
  The turn context.
- OptionalpageSize: number
  The page size.
- OptionalcontinuationToken: string
  The continuation token.
Returns Promise<TeamsPagedMembersResult>
- The paged members result.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:196

`Static`getPagedTeamMembers

getPagedTeamMembers(
    context: TurnContext,
    teamId?: string,
    pageSize?: number,
    continuationToken?: string,
): Promise<TeamsPagedMembersResult>
Gets the paged members of a team.
Parameters
- context: TurnContext
  The turn context.
- OptionalteamId: string
  The team ID.
- OptionalpageSize: number
  The page size.
- OptionalcontinuationToken: string
  The continuation token.
Returns Promise<TeamsPagedMembersResult>
- The paged members result.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:235

`Static`getTeamChannels

getTeamChannels(context: TurnContext, teamId?: string): Promise<ChannelInfo[]>
Gets the channels of a team.
Parameters
- context: TurnContext
  The turn context.
- OptionalteamId: string
  The team ID.
Returns Promise<ChannelInfo[]>
- The list of channels.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:177

`Static`getTeamDetails

getTeamDetails(context: TurnContext, teamId?: string): Promise<TeamDetails>
Gets the team details.
Parameters
- context: TurnContext
  The turn context.
- OptionalteamId: string
  The team ID.
Returns Promise<TeamDetails>
- The team details.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:97

`Static`getTeamMember

getTeamMember(
    context: TurnContext,
    teamId: string,
    userId: string,
): Promise<TeamsChannelAccount>
Gets a member of a team.
Parameters
- context: TurnContext
  The turn context.
- teamId: string
  The team ID.
- userId: string
  The user ID.
Returns Promise<TeamsChannelAccount>
- The member information.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:262

`Static`sendMeetingNotification

sendMeetingNotification(
    context: TurnContext,
    notification: TargetedMeetingNotification,
    meetingId?: string,
): Promise<MeetingNotificationResponse>
Sends a meeting notification.
Parameters
- context: TurnContext
  The turn context.
- notification: TargetedMeetingNotification
  The meeting notification.
- OptionalmeetingId: string
  The meeting ID.
Returns Promise<MeetingNotificationResponse>
- The meeting notification response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:274

`Static`sendMessageToAllUsersInTeam

sendMessageToAllUsersInTeam(
    context: TurnContext,
    activity: Activity,
    tenantId: string,
    teamId: string,
): Promise<BatchOperationResponse>
Sends a message to all users in a team.
Parameters
- context: TurnContext
  The turn context.
- activity: Activity
  The activity to send.
- tenantId: string
  The tenant ID.
- teamId: string
  The team ID.
Returns Promise<BatchOperationResponse>
- The batch operation response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:342

`Static`sendMessageToAllUsersInTenant

sendMessageToAllUsersInTenant(
    context: TurnContext,
    activity: Activity,
    tenantId: string,
): Promise<BatchOperationResponse>
Sends a message to all users in a tenant.
Parameters
- context: TurnContext
  The turn context.
- activity: Activity
  The activity to send.
- tenantId: string
  The tenant ID.
Returns Promise<BatchOperationResponse>
- The batch operation response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:322

`Static`sendMessageToListOfChannels

sendMessageToListOfChannels(
    context: TurnContext,
    activity: Activity,
    tenantId: string,
    members: TeamsMember[],
): Promise<BatchOperationResponse>
Sends a message to a list of channels.
Parameters
- context: TurnContext
  The turn context.
- activity: Activity
  The activity to send.
- tenantId: string
  The tenant ID.
- members: TeamsMember[]
  The list of members.
Returns Promise<BatchOperationResponse>
- The batch operation response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:364

`Static`sendMessageToListOfUsers

sendMessageToListOfUsers(
    context: TurnContext,
    activity: Activity,
    tenantId: string,
    members: TeamsMember[],
): Promise<BatchOperationResponse>
Sends a message to a list of users.
Parameters
- context: TurnContext
  The turn context.
- activity: Activity
  The activity to send.
- tenantId: string
  The tenant ID.
- members: TeamsMember[]
  The list of members.
Returns Promise<BatchOperationResponse>
- The batch operation response.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:300

`Static`sendMessageToTeamsChannel

sendMessageToTeamsChannel(
    context: TurnContext,
    activity: Activity,
    teamsChannelId: string,
    appId?: string,
): Promise<[ConversationReference, string]>
Sends a message to a Teams channel.
Parameters
- context: TurnContext
  The turn context.
- activity: Activity
  The activity to send.
- teamsChannelId: string
  The Teams channel ID.
- OptionalappId: string
  The application ID.
Returns Promise<[ConversationReference, string]>
- The conversation reference and new activity ID.
- Defined in packages/agents-hosting-extensions-teams/src/teamsInfo.ts:118

Class TeamsInfo

Index

Constructors

Methods

Constructors

constructor

Returns TeamsInfo

Methods

StaticcancelOperation

Parameters

Returns Promise<CancelOperationResponse>

StaticgetFailedEntries

Parameters

Returns Promise<BatchFailedEntriesResponse>

StaticgetMeetingInfo

Parameters

Returns Promise<MeetingInfo>

StaticgetMeetingParticipant

Parameters

Returns Promise< TeamsMeetingParticipant< TurnState<DefaultConversationState, DefaultUserState>, >,>

StaticgetMember

Parameters

Returns Promise<TeamsChannelAccount>

StaticgetOperationState

Parameters

Returns Promise<BatchOperationStateResponse>

StaticgetPagedMembers

Parameters

Returns Promise<TeamsPagedMembersResult>

StaticgetPagedTeamMembers

Parameters

Returns Promise<TeamsPagedMembersResult>

StaticgetTeamChannels

Parameters

Returns Promise<ChannelInfo[]>

StaticgetTeamDetails

Parameters

Returns Promise<TeamDetails>

StaticgetTeamMember

Parameters

Returns Promise<TeamsChannelAccount>

StaticsendMeetingNotification

Parameters

Returns Promise<MeetingNotificationResponse>

StaticsendMessageToAllUsersInTeam

Parameters

Returns Promise<BatchOperationResponse>

StaticsendMessageToAllUsersInTenant

Parameters

Returns Promise<BatchOperationResponse>

StaticsendMessageToListOfChannels

Parameters

Returns Promise<BatchOperationResponse>

StaticsendMessageToListOfUsers

Parameters

Returns Promise<BatchOperationResponse>

StaticsendMessageToTeamsChannel

Parameters

Returns Promise<[ConversationReference, string]>

Settings

On This Page

`Static`cancelOperation

`Static`getFailedEntries

`Static`getMeetingInfo

`Static`getMeetingParticipant

Returns Promise<
TeamsMeetingParticipant<
TurnState<DefaultConversationState, DefaultUserState>,
>,
>

`Static`getMember

`Static`getOperationState

`Static`getPagedMembers

`Static`getPagedTeamMembers

`Static`getTeamChannels

`Static`getTeamDetails

`Static`getTeamMember

`Static`sendMeetingNotification

`Static`sendMessageToAllUsersInTeam

`Static`sendMessageToAllUsersInTenant

`Static`sendMessageToListOfChannels

`Static`sendMessageToListOfUsers

`Static`sendMessageToTeamsChannel