ChannelServiceHandlerBase class

Пакет:

botbuilder

ChannelServiceHandlerBase реализует API для пересылки действий в навык и реализует вызовы ChannelAPI из навыка вверх по боту или адаптеру.

Методы

handleCreateConversation(string, ConversationParameters)	Создает новую беседу.
handleDeleteActivity(string, string, string)	Удаляет существующий действия.
handleDeleteConversationMember(string, string, string)	Удаляет члена из беседы.
handleGetActivityMembers(string, string, string)	Перечисляет элементы действия .
handleGetConversationMember(string, string, string)	Возвращает учетную запись одного члена беседы.
handleGetConversationMembers(string, string)	Перечисляет элементы беседы.
handleGetConversationPagedMembers(string, string, number, string)	Перечисляет элементы беседы по одной странице за раз.
handleGetConversations(string, string, string)	Выводит список бесед, в которых участвовал бот.
handleReplyToActivity(string, string, string, Activity)	Отправляет ответдействия .
handleSendConversationHistory(string, string, Transcript)	Отправляет исторические действия беседы.
handleSendToConversation(string, string, Activity)	Отправляет действия в конец беседы.
handleUpdateActivity(string, string, string, Activity)	Изменяет ранее отправленный действия.
handleUploadAttachment(string, string, AttachmentData)	Хранит данные в совместимом хранилище при работе с предприятиями.

Сведения о методе

handleCreateConversation(string, ConversationParameters)

Создает новую беседу.

function handleCreateConversation(authHeader: string, parameters: ConversationParameters): Promise<ConversationResourceResponse>

Параметры

authHeader

string

Заголовок проверки подлинности.

parameters

ConversationParameters

(xref:botbuilder-core. ConversationParameters) для создания беседы из.

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

Promise<ConversationResourceResponse>

Представление Promise для операции.

handleDeleteActivity(string, string, string)

Удаляет существующий действия.

function handleDeleteActivity(authHeader: string, conversationId: string, activityId: string): Promise<void>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

activityId

string

Идентификатор действия для удаления.

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

Promise<void>

handleDeleteConversationMember(string, string, string)

Удаляет члена из беседы.

function handleDeleteConversationMember(authHeader: string, conversationId: string, memberId: string): Promise<void>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

memberId

string

Идентификатор члена, который нужно удалить из этой беседы.

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

Promise<void>

handleGetActivityMembers(string, string, string)

Перечисляет элементы действия .

function handleGetActivityMembers(authHeader: string, conversationId: string, activityId: string): Promise<ChannelAccount[]>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

activityId

string

Идентификатор действия.

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

Promise<ChannelAccount[]>

Перечисленный список ChannelAccount.

handleGetConversationMember(string, string, string)

Возвращает учетную запись одного члена беседы.

function handleGetConversationMember(authHeader: string, userId: string, conversationId: string): Promise<ChannelAccount>

Параметры

authHeader

string

Заголовок проверки подлинности.

userId

string

Идентификатор пользователя.

conversationId

string

Идентификатор беседы.

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

Promise<ChannelAccount>

ChannelAccount для предоставленного идентификатора пользователя.

handleGetConversationMembers(string, string)

Перечисляет элементы беседы.

function handleGetConversationMembers(authHeader: string, conversationId: string): Promise<ChannelAccount[]>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

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

Promise<ChannelAccount[]>

Перечисленный список ChannelAccount.

handleGetConversationPagedMembers(string, string, number, string)

Перечисляет элементы беседы по одной странице за раз.

function handleGetConversationPagedMembers(authHeader: string, conversationId: string, pageSize?: number, continuationToken?: string): Promise<PagedMembersResult>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

pageSize

number

Предлагаемый размер страницы.

continuationToken

string

Маркер продолжения.

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

Promise<PagedMembersResult>

Promise, представляющий PagedMembersResult для операции.

handleGetConversations(string, string, string)

Выводит список бесед, в которых участвовал бот.

function handleGetConversations(authHeader: string, conversationId: string, continuationToken?: string): Promise<ConversationsResult>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

continuationToken

string

Маркер пропуска или продолжения.

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

Promise<ConversationsResult>

Представление Promise для операции.

handleReplyToActivity(string, string, string, Activity)

Отправляет ответдействия .

function handleReplyToActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

activityId

string

Идентификатор действия, на который отвечает ответ.

activity

Activity

Действие для отправки.

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

Promise<ResourceResponse>

Promise, представляющий ResourceResponse для операции.

handleSendConversationHistory(string, string, Transcript)

Отправляет исторические действия беседы.

function handleSendConversationHistory(authHeader: string, conversationId: string, transcript: Transcript): Promise<ResourceResponse>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

transcript

Transcript

(xref:botframework-schema. Расшифровка действий.

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

Promise<ResourceResponse>

Promise, представляющий ResourceResponse для операции.

handleSendToConversation(string, string, Activity)

Отправляет действия в конец беседы.

function handleSendToConversation(authHeader: string, conversationId: string, activity: Activity): Promise<ResourceResponse>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

activity

Activity

Действие для отправки.

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

Promise<ResourceResponse>

Promise, представляющий ResourceResponse для операции.

handleUpdateActivity(string, string, string, Activity)

Изменяет ранее отправленный действия.

function handleUpdateActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

activityId

string

Идентификатор действия для обновления.

activity

Activity

действия замены .

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

Promise<ResourceResponse>

Promise, представляющий ResourceResponse для операции.

handleUploadAttachment(string, string, AttachmentData)

Хранит данные в совместимом хранилище при работе с предприятиями.

function handleUploadAttachment(authHeader: string, conversationId: string, attachmentUpload: AttachmentData): Promise<ResourceResponse>

Параметры

authHeader

string

Заголовок проверки подлинности.

conversationId

string

Идентификатор беседы.

attachmentUpload

AttachmentData

(xref:botframework-schema. AttachmentData).

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

Promise<ResourceResponse>

Promise, представляющий ResourceResponse для операции.