ChannelServiceHandler class

Пакет:

botbuilder

Предупреждение

Теперь этот API является нерекомендуемым.

Use CloudChannelServiceHandler instead. The ChannelServiceHandler implements API to forward activity to a skill and implements routing ChannelAPI calls from the Skill up through the bot/adapter.

Extends

ChannelServiceHandlerBase

Конструкторы

ChannelServiceHandler(ICredentialProvider, AuthenticationConfiguration, string)

Инициализирует новый экземпляр класса ChannelServiceHandler, используя поставщик учетных данных.

Наследуемые методы

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)	Хранит данные в хранилище, соответствующее требованиям, при работе с предприятиями.

Сведения о конструкторе

ChannelServiceHandler(ICredentialProvider, AuthenticationConfiguration, string)

Инициализирует новый экземпляр класса ChannelServiceHandler, используя поставщик учетных данных.

new ChannelServiceHandler(credentialProvider: ICredentialProvider, authConfig: AuthenticationConfiguration, channelService?: string)

Параметры

credentialProvider

ICredentialProvider

Поставщик учетных данных.

authConfig

AuthenticationConfiguration

Конфигурация проверки подлинности.

channelService

string

Строка, представляющая поставщика канала.

Сведения о наследуемом методе

handleCreateConversation(string, ConversationParameters)

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

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

Параметры

authHeader

string

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

parameters

ConversationParameters

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

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

Promise<ConversationResourceResponse>

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

Наследуется отChannelServiceHandlerBase.handleCreateConversation

handleDeleteActivity(string, string, string)

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

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

Параметры

authHeader

string

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

conversationId

string

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

activityId

string

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

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

Promise<void>

Наследуется отChannelServiceHandlerBase.handleDeleteActivity

handleDeleteConversationMember(string, string, string)

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

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

Параметры

authHeader

string

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

conversationId

string

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

memberId

string

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

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

Promise<void>

Наследуется отChannelServiceHandlerBase.handleDeleteConversationMember

handleGetActivityMembers(string, string, string)

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

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

Параметры

authHeader

string

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

conversationId

string

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

activityId

string

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

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

Promise<ChannelAccount[]>

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

Наследуется отChannelServiceHandlerBase.handleGetActivityMembers

handleGetConversationMember(string, string, string)

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

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

Параметры

authHeader

string

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

userId

string

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

conversationId

string

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

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

Promise<ChannelAccount>

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

Наследуется отChannelServiceHandlerBase.handleGetConversationMember

handleGetConversationMembers(string, string)

Перечисляет члены диалога.

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

Параметры

authHeader

string

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

conversationId

string

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

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

Promise<ChannelAccount[]>

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

Наследуется отChannelServiceHandlerBase.handleGetConversationMembers

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 для операции.

Наследуется отChannelServiceHandlerBase.handleGetConversationPagedMembers

handleGetConversations(string, string, string)

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

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

Параметры

authHeader

string

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

conversationId

string

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

continuationToken

string

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

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

Promise<ConversationsResult>

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

Наследуется отChannelServiceHandlerBase.handleGetConversations

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 для операции.

Наследуется отChannelServiceHandlerBase.handleReplyToActivity

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 для операции.

Наследуется отChannelServiceHandlerBase.handleSendConversationHistory

handleSendToConversation(string, string, Activity)

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

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

Параметры

authHeader

string

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

conversationId

string

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

activity

Activity

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

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

Promise<ResourceResponse>

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

Наследуется отChannelServiceHandlerBase.handleSendToConversation

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 для операции.

Наследуется отchannelServiceHandlerBase.handleUpdateActivity

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 для операции.

Наследуется отChannelServiceHandlerBase.handleUploadAttachment