TeamsInfo class

Pacote:

botbuilder

Fornece métodos utilitários para os eventos e interações que ocorrem no Microsoft Teams.

Métodos

getMeetingInfo(TurnContext, string)	Obtém as informações da ID de reunião fornecida.
getMeetingParticipant(TurnContext, string, string, string)	Obtém o participante da reunião para a ID da reunião especificada e a ID do participante. Isso só funciona em conversas de reunião com escopo de equipes.
getMember(TurnContext, string)	Obtém a conta de um único membro de conversa.
getMembers(TurnContext)	Obtém os membros da conversa de um chat individual ou em grupo.
getPagedMembers(TurnContext, number, string)	Obtém uma lista paginada de membros de conversa individual, de grupo ou de equipe.
getPagedTeamMembers(TurnContext, string, number, string)	Obtém uma lista paginada de membros de uma equipe.
getTeamChannels(TurnContext, string)	Retorna uma lista de canais em uma Equipe. Isso só funciona em conversas com escopo de equipes.
getTeamDetails(TurnContext, string)	Obtém os detalhes da ID de equipe fornecida. Isso só funciona em conversas com escopo de equipes.
getTeamMember(TurnContext, string, string)	Obtém a conta de um membro em uma conversa com escopo de equipes.
getTeamMembers(TurnContext, string)	Obtém a lista de TeamsChannelAccount dentro de uma equipe.
sendMessageToTeamsChannel(TurnContext, Activity, string, string)	Cria um novo thread em um chat do Teams e envia uma Atividade para esse novo thread.

Detalhes do método

getMeetingInfo(TurnContext, string)

Obtém as informações da ID de reunião fornecida.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

meetingId

string

A ID codificada em BASE64 da reunião do Teams.

Retornos

Promise<TeamsMeetingInfo>

O TeamsMeetingInfo buscado

getMeetingParticipant(TurnContext, string, string, string)

Obtém o participante da reunião para a ID da reunião especificada e a ID do participante. Isso só funciona em conversas de reunião com escopo de equipes.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

meetingId

string

A ID da reunião a ser buscada

participantId

string

A ID do participante a ser buscada

tenantId

string

A ID do locatário a ser usada ao definir o escopo da solicitação

Retornos

Promise<TeamsMeetingParticipant>

O TeamsMeetingParticipant buscado

getMember(TurnContext, string)

Obtém a conta de um único membro de conversa.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

userId

string

ID do usuário em questão.

Retornos

Promise<TeamsChannelAccount>

O TeamsChannelAccount do membro.

getMembers(TurnContext)

Aviso

Essa API foi preterida.

Use getPagedTeamMembers instead.

Obtém os membros da conversa de um chat individual ou em grupo.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

Retornos

Promise<TeamsChannelAccount[]>

A lista de TeamsChannelAccount.

getPagedMembers(TurnContext, number, string)

Obtém uma lista paginada de membros de conversa individual, de grupo ou de equipe.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

pageSize

number

Número sugerido de entradas em uma página.

continuationToken

string

Um token de continuação.

Retornos

Promise<TeamsPagedMembersResult>

O TeamsPagedMembersResult com a lista de membros.

getPagedTeamMembers(TurnContext, string, number, string)

Obtém uma lista paginada de membros de uma equipe.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

teamId

string

ID da equipe do Teams.

pageSize

number

O número de entradas na página.

continuationToken

string

O token continuationToken.

Retornos

Promise<TeamsPagedMembersResult>

Um TeamsPagedMembersResult com a lista de membros.

getTeamChannels(TurnContext, string)

Retorna uma lista de canais em uma Equipe. Isso só funciona em conversas com escopo de equipes.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

teamId

string

ID da equipe do Teams.

Retornos

Promise<ChannelInfo[]>

A lista de objetos ChannelInfo com as conversas.

getTeamDetails(TurnContext, string)

Obtém os detalhes da ID de equipe fornecida. Isso só funciona em conversas com escopo de equipes.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

teamId

string

A ID da equipe do Teams.

Retornos

Promise<TeamDetails>

O TeamDetails buscado

getTeamMember(TurnContext, string, string)

Obtém a conta de um membro em uma conversa com escopo de equipes.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

teamId

string

ID da equipe do Teams.

userId

string

ID do usuário do Teams.

Retornos

Promise<TeamsChannelAccount>

O TeamsChannelAccount do membro.

getTeamMembers(TurnContext, string)

Aviso

Essa API foi preterida.

Use getPagedTeamMembers instead.

Obtém a lista de TeamsChannelAccount dentro de uma equipe.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

teamId

string

ID da equipe do Teams.

Retornos

Promise<TeamsChannelAccount[]>

A lista de TeamsChannelAccount dos membros.

sendMessageToTeamsChannel(TurnContext, Activity, string, string)

Cria um novo thread em um chat do Teams e envia uma Atividade para esse novo thread.

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

Parâmetros

context

TurnContext

O TurnContext para este turno.

activity

Activity

A Atividade a ser enviada.

teamsChannelId

string

A ID do Canal da Equipe, observe que isso é distinto da propriedade de atividade do Bot Framework com o mesmo nome.

botAppId

string

A appId do bot. Isso só é usado quando context.adapter é uma instância do CloudAdapter.

Retornos

Promise<[ConversationReference, string]>

A ConversationReference e a ID da Atividade (se enviada).