TeamsInfo class

套件:

botbuilder

為 Microsoft Teams 內發生的事件和互動提供公用程式方法。

方法

getMeetingInfo(TurnContext, string)	取得指定會議識別碼的資訊。
getMeetingParticipant(TurnContext, string, string, string)	取得指定會議識別碼和參與者識別碼的會議參與者。這僅適用于小組範圍會議交談。
getMember(TurnContext, string)	取得單一交談成員的帳戶。
getMembers(TurnContext)	取得一對一或群組聊天的交談成員。
getPagedMembers(TurnContext, number, string)	取得一對一、群組或小組交談成員的編頁清單。
getPagedTeamMembers(TurnContext, string, number, string)	取得小組成員的編頁清單。
getTeamChannels(TurnContext, string)	傳回小組中的頻道清單。 這僅適用于小組範圍交談。
getTeamDetails(TurnContext, string)	取得指定小組識別碼的詳細資料。這僅適用于小組範圍交談。
getTeamMember(TurnContext, string, string)	取得小組範圍交談中成員的帳戶。
getTeamMembers(TurnContext, string)	取得 小組內的 TeamsChannelAccount 清單。
sendMessageToTeamsChannel(TurnContext, Activity, string, string)	在 Teams 聊天中建立新的執行緒，並將 活動 傳送至該新執行緒。

方法詳細資料

getMeetingInfo(TurnContext, string)

取得指定會議識別碼的資訊。

static function getMeetingInfo(context: TurnContext, meetingId?: string): Promise<TeamsMeetingInfo>

參數

context

TurnContext

此回合的 TurnCoNtext 。

meetingId

string

Teams 會議的 BASE64 編碼識別碼。

傳回

Promise<TeamsMeetingInfo>

已擷取TeamsMeetingInfo

getMeetingParticipant(TurnContext, string, string, string)

取得指定會議識別碼和參與者識別碼的會議參與者。這僅適用于小組範圍會議交談。

static function getMeetingParticipant(context: TurnContext, meetingId?: string, participantId?: string, tenantId?: string): Promise<TeamsMeetingParticipant>

參數

context

TurnContext

此回合的 TurnCoNtext 。

meetingId

string

要擷取的會議識別碼

participantId

string

要擷取的參與者識別碼

tenantId

string

界定要求時要使用的租使用者識別碼

傳回

Promise<TeamsMeetingParticipant>

已擷取TeamsMeetingParticipant

getMember(TurnContext, string)

取得單一交談成員的帳戶。

static function getMember(context: TurnContext, userId: string): Promise<TeamsChannelAccount>

參數

context

TurnContext

此回合的 TurnCoNtext 。

userId

string

有問題的使用者識別碼。

傳回

Promise<TeamsChannelAccount>

成員的 TeamsChannelAccount 。

getMembers(TurnContext)

警告

此 API 現已淘汰。

Use getPagedTeamMembers instead.

取得一對一或群組聊天的交談成員。

static function getMembers(context: TurnContext): Promise<TeamsChannelAccount[]>

參數

context

TurnContext

此回合的 TurnCoNtext 。

傳回

Promise<TeamsChannelAccount[]>

TeamsChannelAccount的清單。

getPagedMembers(TurnContext, number, string)

取得一對一、群組或小組交談成員的編頁清單。

static function getPagedMembers(context: TurnContext, pageSize?: number, continuationToken?: string): Promise<TeamsPagedMembersResult>

參數

context

TurnContext

此回合的 TurnCoNtext 。

pageSize

number

頁面上建議的專案數。

continuationToken

string

接續權杖。

傳回

Promise<TeamsPagedMembersResult>

具有成員清單的 TeamsPagedMembersResult 。

getPagedTeamMembers(TurnContext, string, number, string)

取得小組成員的編頁清單。

static function getPagedTeamMembers(context: TurnContext, teamId?: string, pageSize?: number, continuationToken?: string): Promise<TeamsPagedMembersResult>

參數

context

TurnContext

此回合的 TurnCoNtext 。

teamId

string

Teams 小組的識別碼。

pageSize

number

頁面上的專案數。

continuationToken

string

continuationToken 權杖。

傳回

Promise<TeamsPagedMembersResult>

具有成員清單的 TeamsPagedMembersResult 。

getTeamChannels(TurnContext, string)

傳回小組中的頻道清單。 這僅適用于小組範圍交談。

static function getTeamChannels(context: TurnContext, teamId?: string): Promise<ChannelInfo[]>

參數

context

TurnContext

此回合的 TurnCoNtext 。

teamId

string

Teams 小組的識別碼。

傳回

Promise<ChannelInfo[]>

具有交談的 ChannelInfo 物件清單。

getTeamDetails(TurnContext, string)

取得指定小組識別碼的詳細資料。這僅適用于小組範圍交談。

static function getTeamDetails(context: TurnContext, teamId?: string): Promise<TeamDetails>

參數

context

TurnContext

此回合的 TurnCoNtext 。

teamId

string

Teams 小組的識別碼。

傳回

Promise<TeamDetails>

擷取的 TeamDetails

getTeamMember(TurnContext, string, string)

取得小組範圍交談中成員的帳戶。

static function getTeamMember(context: TurnContext, teamId?: string, userId?: string): Promise<TeamsChannelAccount>

參數

context

TurnContext

此回合的 TurnCoNtext 。

teamId

string

Teams 小組的識別碼。

userId

string

Teams 使用者的識別碼。

傳回

Promise<TeamsChannelAccount>

成員的 TeamsChannelAccount 。

getTeamMembers(TurnContext, string)

警告

此 API 現已淘汰。

Use getPagedTeamMembers instead.

取得 小組內的 TeamsChannelAccount 清單。

static function getTeamMembers(context: TurnContext, teamId?: string): Promise<TeamsChannelAccount[]>

參數

context

TurnContext

此回合的 TurnCoNtext 。

teamId

string

Teams 小組的識別碼。

傳回

Promise<TeamsChannelAccount[]>

成員的 TeamsChannelAccount清單。

sendMessageToTeamsChannel(TurnContext, Activity, string, string)

在 Teams 聊天中建立新的執行緒，並將 活動 傳送至該新執行緒。

static function sendMessageToTeamsChannel(context: TurnContext, activity: Activity, teamsChannelId: string, botAppId?: string): Promise<[ConversationReference, string]>

參數

context

TurnContext

此回合的 TurnCoNtext 。

activity

Activity

要傳送 的活動 。

teamsChannelId

string

小組的頻道識別碼，請注意這與相同名稱的 Bot Framework 活動屬性不同。

botAppId

string

Bot 的 appId。 只有當 coNtext.adapter 是 CloudAdapter 的實例時，才會使用此功能。

傳回

Promise<[ConversationReference, string]>

如果傳送) ，則為 Activity (的ConversationReference和識別碼。