TeamsInfo class

パッケージ:

botbuilder

Microsoft Teams 内で発生するイベントと相互作用のユーティリティ メソッドを提供します。

メソッド

getMeetingInfo(TurnContext, string)	指定された会議 ID の情報を取得します。
getMeetingParticipant(TurnContext, string, string, string)	指定された会議 ID と参加者 ID の会議参加者を取得します。これは、チームスコープの会議の会話でのみ機能します。
getMember(TurnContext, string)	1 つの会話メンバーのアカウントを取得します。
getMembers(TurnContext)	1 対 1 またはグループ チャットの会話メンバーを取得します。
getPagedMembers(TurnContext, number, string)	1 対 1、グループ、またはチームの会話のメンバーのページ分割されたリストを取得します。
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)

1 つの会話メンバーのアカウントを取得します。

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

パラメーター

context

TurnContext

この ターンの TurnContext 。

userId

string

対象のユーザーの ID。

戻り値

Promise<TeamsChannelAccount>

メンバーの TeamsChannelAccount 。

getMembers(TurnContext)

警告

この API は非推奨になりました。

Use getPagedTeamMembers instead.

1 対 1 またはグループ チャットの会話メンバーを取得します。

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

パラメーター

context

TurnContext

この ターンの TurnContext 。

戻り値

Promise<TeamsChannelAccount[]>

TeamsChannelAccount の一覧。

getPagedMembers(TurnContext, number, string)

1 対 1、グループ、またはチームの会話のメンバーのページ分割されたリストを取得します。

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 (送信された場合)。