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)	傳回 Team 中的頻道清單。 這隻適用於小組範圍的交談。
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)

傳回 Team 中的頻道清單。 這隻適用於小組範圍的交談。

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]>

ConversationReference 和 活動 的標識碼（如果已傳送）。