TeamsInfo class
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.
Methods
Method Details
cancelOperation(TurnContext, string)
Cancels an operation.
static function cancelOperation(context: TurnContext, operationId: string): Promise<CancelOperationResponse>Parameters
- context
- TurnContext
The turn context.
- operationId
-
string
The operation ID.
Returns
Promise<CancelOperationResponse>
- The cancel operation response.
getFailedEntries(TurnContext, string)
Gets the failed entries of an operation.
static function getFailedEntries(context: TurnContext, operationId: string): Promise<BatchFailedEntriesResponse>Parameters
- context
- TurnContext
The turn context.
- operationId
-
string
The operation ID.
Returns
Promise<BatchFailedEntriesResponse>
- The failed entries response.
getMeetingInfo(TurnContext, string)
Gets the meeting information.
static function getMeetingInfo(context: TurnContext, meetingId?: string): Promise<MeetingInfo>Parameters
- context
- TurnContext
The turn context.
- meetingId
-
string
The meeting ID.
Returns
Promise<MeetingInfo>
- The meeting information.
getMeetingParticipant(TurnContext, string, string, string)
Gets the meeting participant information.
static function getMeetingParticipant(context: TurnContext, meetingId?: string, participantId?: string, tenantId?: string): Promise<TeamsMeetingParticipant<TurnState<DefaultConversationState, DefaultUserState, DefaultTempState>>>Parameters
- context
- TurnContext
The turn context.
- meetingId
-
string
The meeting ID.
- participantId
-
string
The participant ID.
- tenantId
-
string
The tenant ID.
Returns
Promise<TeamsMeetingParticipant<TurnState<DefaultConversationState, DefaultUserState, DefaultTempState>>>
- The meeting participant information.
getMember(TurnContext, string)
Gets a member of a team or conversation.
static function getMember(context: TurnContext, userId: string): Promise<TeamsChannelAccount>Parameters
- context
- TurnContext
The turn context.
- userId
-
string
The user ID.
Returns
Promise<TeamsChannelAccount>
- The member information.
getOperationState(TurnContext, string)
Gets the operation state.
static function getOperationState(context: TurnContext, operationId: string): Promise<BatchOperationStateResponse>Parameters
- context
- TurnContext
The turn context.
- operationId
-
string
The operation ID.
Returns
Promise<BatchOperationStateResponse>
- The operation state response.
getPagedMembers(TurnContext, number, string)
Gets the paged members of a team or conversation.
static function getPagedMembers(context: TurnContext, pageSize?: number, continuationToken?: string): Promise<TeamsPagedMembersResult>Parameters
- context
- TurnContext
The turn context.
- pageSize
-
number
The page size.
- continuationToken
-
string
The continuation token.
Returns
Promise<TeamsPagedMembersResult>
- The paged members result.
getPagedTeamMembers(TurnContext, string, number, string)
Gets the paged members of a team.
static function getPagedTeamMembers(context: TurnContext, teamId?: string, pageSize?: number, continuationToken?: string): Promise<TeamsPagedMembersResult>Parameters
- context
- TurnContext
The turn context.
- teamId
-
string
The team ID.
- pageSize
-
number
The page size.
- continuationToken
-
string
The continuation token.
Returns
Promise<TeamsPagedMembersResult>
- The paged members result.
getTeamChannels(TurnContext, string)
Gets the channels of a team.
static function getTeamChannels(context: TurnContext, teamId?: string): Promise<ChannelInfo[]>Parameters
- context
- TurnContext
The turn context.
- teamId
-
string
The team ID.
Returns
Promise<ChannelInfo[]>
- The list of channels.
getTeamDetails(TurnContext, string)
Gets the team details.
static function getTeamDetails(context: TurnContext, teamId?: string): Promise<TeamDetails>Parameters
- context
- TurnContext
The turn context.
- teamId
-
string
The team ID.
Returns
Promise<TeamDetails>
- The team details.
getTeamMember(TurnContext, string, string)
Gets a member of a team.
static function getTeamMember(context: TurnContext, teamId: string, userId: string): Promise<TeamsChannelAccount>Parameters
- context
- TurnContext
The turn context.
- teamId
-
string
The team ID.
- userId
-
string
The user ID.
Returns
Promise<TeamsChannelAccount>
- The member information.
sendMeetingNotification(TurnContext, TargetedMeetingNotification, string)
Sends a meeting notification.
static function sendMeetingNotification(context: TurnContext, notification: TargetedMeetingNotification, meetingId?: string): Promise<MeetingNotificationResponse>Parameters
- context
- TurnContext
The turn context.
- notification
- TargetedMeetingNotification
The meeting notification.
- meetingId
-
string
The meeting ID.
Returns
Promise<MeetingNotificationResponse>
- The meeting notification response.
sendMessageToAllUsersInTeam(TurnContext, Activity, string, string)
Sends a message to all users in a team.
static function sendMessageToAllUsersInTeam(context: TurnContext, activity: Activity, tenantId: string, teamId: string): Promise<BatchOperationResponse>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.
sendMessageToAllUsersInTenant(TurnContext, Activity, string)
Sends a message to all users in a tenant.
static function sendMessageToAllUsersInTenant(context: TurnContext, activity: Activity, tenantId: string): Promise<BatchOperationResponse>Parameters
- context
- TurnContext
The turn context.
- activity
- Activity
The activity to send.
- tenantId
-
string
The tenant ID.
Returns
Promise<BatchOperationResponse>
- The batch operation response.
sendMessageToListOfChannels(TurnContext, Activity, string, TeamsMember[])
Sends a message to a list of channels.
static function sendMessageToListOfChannels(context: TurnContext, activity: Activity, tenantId: string, members: TeamsMember[]): Promise<BatchOperationResponse>Parameters
- context
- TurnContext
The turn context.
- activity
- Activity
The activity to send.
- tenantId
-
string
The tenant ID.
- members
The list of members.
Returns
Promise<BatchOperationResponse>
- The batch operation response.
sendMessageToListOfUsers(TurnContext, Activity, string, TeamsMember[])
Sends a message to a list of users.
static function sendMessageToListOfUsers(context: TurnContext, activity: Activity, tenantId: string, members: TeamsMember[]): Promise<BatchOperationResponse>Parameters
- context
- TurnContext
The turn context.
- activity
- Activity
The activity to send.
- tenantId
-
string
The tenant ID.
- members
The list of members.
Returns
Promise<BatchOperationResponse>
- The batch operation response.
sendMessageToTeamsChannel(TurnContext, Activity, string, string)
Sends a message to a Teams channel.
static function sendMessageToTeamsChannel(context: TurnContext, activity: Activity, teamsChannelId: string, appId?: string): Promise<[ConversationReference, string]>Parameters
- context
- TurnContext
The turn context.
- activity
- Activity
The activity to send.
- teamsChannelId
-
string
The Teams channel ID.
- appId
-
string
The application ID.
Returns
Promise<[ConversationReference, string]>
- The conversation reference and new activity ID.