TeamsInfo class

Paquet:

botbuilder

Fournit des méthodes utilitaires pour les événements et les interactions qui se produisent dans Microsoft Teams.

Méthodes

getMeetingInfo(TurnContext, string)	Obtient les informations pour l’ID de réunion donné.
getMeetingParticipant(TurnContext, string, string, string)	Obtient le participant à la réunion pour l’ID de réunion et l’ID de participant donnés. Cela fonctionne uniquement dans les conversations de réunion délimitées par les équipes.
getMember(TurnContext, string)	Obtient le compte d’un seul membre de conversation.
getMembers(TurnContext)	Obtient les membres de conversation d’une conversation en un-à-un ou d’une conversation de groupe.
getPagedMembers(TurnContext, number, string)	Obtient une liste paginée des membres d’une conversation en un-à-un, de groupe ou d’équipe.
getPagedTeamMembers(TurnContext, string, number, string)	Obtient une liste paginé des membres d’une équipe.
getTeamChannels(TurnContext, string)	Retourne une liste de canaux dans une équipe. Cela fonctionne uniquement dans les conversations délimitées par les équipes.
getTeamDetails(TurnContext, string)	Obtient les détails de l’ID d’équipe donné. Cela fonctionne uniquement dans les conversations délimitées par les équipes.
getTeamMember(TurnContext, string, string)	Obtient le compte d’un membre dans une conversation délimitée par les équipes.
getTeamMembers(TurnContext, string)	Obtient la liste de TeamsChannelAccount au sein d’une équipe.
sendMessageToTeamsChannel(TurnContext, Activity, string, string)	Crée un thread dans une conversation Teams et envoie une activité à ce nouveau thread.

Détails de la méthode

getMeetingInfo(TurnContext, string)

Obtient les informations pour l’ID de réunion donné.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

meetingId

string

ID encodé en BASE64 de la réunion Teams.

Retours

Promise<TeamsMeetingInfo>

TeamsMeetingInfo extrait

getMeetingParticipant(TurnContext, string, string, string)

Obtient le participant à la réunion pour l’ID de réunion et l’ID de participant donnés. Cela fonctionne uniquement dans les conversations de réunion délimitées par les équipes.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

meetingId

string

ID de réunion à récupérer

participantId

string

ID de participant à récupérer

tenantId

string

ID de locataire à utiliser lors de l’étendue de la demande

Retours

Promise<TeamsMeetingParticipant>

TeamsMeetingParticipant extrait

getMember(TurnContext, string)

Obtient le compte d’un seul membre de conversation.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

userId

string

ID de l’utilisateur en question.

Retours

Promise<TeamsChannelAccount>

TeamsChannelAccount du membre.

getMembers(TurnContext)

Avertissement

Cette API est à présent déconseillée.

Use getPagedTeamMembers instead.

Obtient les membres de conversation d’une conversation en un-à-un ou d’une conversation de groupe.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

Retours

Promise<TeamsChannelAccount[]>

Liste de TeamsChannelAccount.

getPagedMembers(TurnContext, number, string)

Obtient une liste paginée des membres d’une conversation en un-à-un, de groupe ou d’équipe.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

pageSize

number

Nombre suggéré d’entrées sur une page.

continuationToken

string

Jeton de continuation.

Retours

Promise<TeamsPagedMembersResult>

TeamsPagedMembersResult avec la liste des membres.

getPagedTeamMembers(TurnContext, string, number, string)

Obtient une liste paginé des membres d’une équipe.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

teamId

string

ID de l’équipe Teams.

pageSize

number

Nombre d’entrées sur la page.

continuationToken

string

Jeton continuationToken.

Retours

Promise<TeamsPagedMembersResult>

TeamsPagedMembersResult avec la liste des membres.

getTeamChannels(TurnContext, string)

Retourne une liste de canaux dans une équipe. Cela fonctionne uniquement dans les conversations délimitées par les équipes.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

teamId

string

ID de l’équipe Teams.

Retours

Promise<ChannelInfo[]>

Liste des objets ChannelInfo avec les conversations.

getTeamDetails(TurnContext, string)

Obtient les détails de l’ID d’équipe donné. Cela fonctionne uniquement dans les conversations délimitées par les équipes.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

teamId

string

ID de l’équipe Teams.

Retours

Promise<TeamDetails>

TeamDetails récupéré

getTeamMember(TurnContext, string, string)

Obtient le compte d’un membre dans une conversation délimitée par les équipes.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

teamId

string

ID de l’équipe Teams.

userId

string

ID de l’utilisateur Teams.

Retours

Promise<TeamsChannelAccount>

TeamsChannelAccount du membre.

getTeamMembers(TurnContext, string)

Avertissement

Cette API est à présent déconseillée.

Use getPagedTeamMembers instead.

Obtient la liste de TeamsChannelAccount au sein d’une équipe.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

teamId

string

ID de l’équipe Teams.

Retours

Promise<TeamsChannelAccount[]>

Liste de TeamsChannelAccount des membres.

sendMessageToTeamsChannel(TurnContext, Activity, string, string)

Crée un thread dans une conversation Teams et envoie une activité à ce nouveau thread.

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

Paramètres

context

TurnContext

TurnContext pour ce tour.

activity

Activity

Activité à envoyer.

teamsChannelId

string

L’ID de canal de l’équipe, notez qu’il est distinct de la propriété d’activité Bot Framework portant le même nom.

botAppId

string

AppId du bot. Il est utilisé uniquement lorsque context.adapter est une instance de CloudAdapter.

Retours

Promise<[ConversationReference, string]>

ConversationReference et l’ID de l’activité (s’ils sont envoyés).