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)	Возвращает список каналов в команде. Это работает только в беседах с областью действия команд.
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

Токен продолженияToken.

Возвращаемое значение

Promise<TeamsPagedMembersResult>

TeamsPagedMembersResult со списком участников.

getTeamChannels(TurnContext, string)

Возвращает список каналов в команде. Это работает только в беседах с областью действия команд.

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

Идентификатор канала team, обратите внимание, что это отличается от свойства действия Bot Framework с тем же именем.

botAppId

string

Идентификатор приложения бота. Это используется только в том случае, если context.adapter является экземпляром CloudAdapter.

Возвращаемое значение

Promise<[ConversationReference, string]>

ConversationReference и идентификатор действия (при отправке).