TeamsInfo class

包:

botbuilder

为 Microsoft Teams 中发生的事件和交互提供实用工具方法。

方法

getMeetingInfo(TurnContext, string)	获取给定会议 ID 的信息。
getMeetingParticipant(TurnContext, string, string, string)	获取给定会议 ID 和参与者 ID 的会议参与者。这仅适用于团队范围的会议对话。
getMember(TurnContext, string)	获取单个会话成员的帐户。
getMembers(TurnContext)	获取一对一聊天或群组聊天的对话成员。
getPagedMembers(TurnContext, number, string)	获取一对一、组或团队对话的成员的分页列表。
getPagedTeamMembers(TurnContext, string, number, string)	获取团队成员的分页列表。
getTeamChannels(TurnContext, string)	返回团队中的频道列表。 这仅适用于团队范围的对话。
getTeamDetails(TurnContext, string)	获取给定团队 ID 的详细信息。这仅适用于团队范围的对话。
getTeamMember(TurnContext, string, string)	获取团队范围对话中成员的帐户。
getTeamMembers(TurnContext, string)	获取团队中的 TeamsChannelAccount 列表。
sendMessageToTeamsChannel(TurnContext, Activity, string, string)	在 Teams 聊天中创建一个新线程，并将 活动 发送到该新线程。

方法详细信息

getMeetingInfo(TurnContext, string)

获取给定会议 ID 的信息。

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

参数

context

TurnContext

此轮次的 TurnContext 。

meetingId

string

Teams 会议的 BASE64 编码 ID。

返回

Promise<TeamsMeetingInfo>

提取的 TeamsMeetingInfo

getMeetingParticipant(TurnContext, string, string, string)

获取给定会议 ID 和参与者 ID 的会议参与者。这仅适用于团队范围的会议对话。

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

参数

context

TurnContext

此轮次的 TurnContext 。

meetingId

string

要提取的会议 ID

participantId

string

要提取的参与者 ID

tenantId

string

确定请求范围时要使用的租户 ID

返回

Promise<TeamsMeetingParticipant>

提取的 TeamsMeetingParticipant

getMember(TurnContext, string)

获取单个会话成员的帐户。

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

参数

context

TurnContext

此轮次的 TurnContext 。

userId

string

有问题的用户的 ID。

返回

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 团队的 ID。

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 团队的 ID。

返回

Promise<ChannelInfo[]>

包含对话的 ChannelInfo 对象的列表。

getTeamDetails(TurnContext, string)

获取给定团队 ID 的详细信息。这仅适用于团队范围的对话。

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

参数

context

TurnContext

此轮次的 TurnContext 。

teamId

string

Teams 团队的 ID。

返回

Promise<TeamDetails>

提取的 TeamDetails

getTeamMember(TurnContext, string, string)

获取团队范围对话中成员的帐户。

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

参数

context

TurnContext

此轮次的 TurnContext 。

teamId

string

Teams 团队的 ID。

userId

string

Teams 用户的 ID。

返回

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 团队的 ID。

返回

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

团队的频道 ID，请注意，这不同于具有相同名称的 Bot Framework 活动属性。

botAppId

string

机器人的 appId。 仅当 context.adapter 是 CloudAdapter 的实例时，才使用此方法。

返回

Promise<[ConversationReference, string]>

如果发送) ，则活动 (的 ConversationReference 和 ID。