SkillHandler class

Пакет:

botbuilder

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

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

Use CloudSkillHandler instead. A Bot Framework Handler for skills.

Extends

ChannelServiceHandler

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

SkillHandler(BotAdapter, ActivityHandlerBase, SkillConversationIdFactoryBase, ICredentialProvider, AuthenticationConfiguration, string)

Инициализирует новый экземпляр класса SkillHandler.

Свойства

SkillConversationReferenceKey

Используется для доступа к CovnersationReference, отправляемого из навыка в родительский объект.

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

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

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

SkillHandler(BotAdapter, ActivityHandlerBase, SkillConversationIdFactoryBase, ICredentialProvider, AuthenticationConfiguration, string)

Инициализирует новый экземпляр класса SkillHandler.

new SkillHandler(adapter: BotAdapter, bot: ActivityHandlerBase, conversationIdFactory: SkillConversationIdFactoryBase, credentialProvider: ICredentialProvider, authConfig: AuthenticationConfiguration, channelService?: string)

Параметры

adapter

BotAdapter

Экземпляр BotAdapter, который будет обрабатывать запрос.

bot

ActivityHandlerBase

Экземпляр ActivityHandlerBase.

conversationIdFactory

SkillConversationIdFactoryBase

SkillConversationIdFactoryBase для распаковки идентификатора беседы и сопоставления его с вызывающим ботом.

credentialProvider

ICredentialProvider

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

authConfig

AuthenticationConfiguration

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

channelService

string

Строка, указывающая, работает ли бот в общедоступной среде Azure или в Azure для государственных организаций (https://aka.ms/AzureGovDocs).

Сведения о свойстве

SkillConversationReferenceKey

Используется для доступа к CovnersationReference, отправляемого из навыка в родительский объект.

SkillConversationReferenceKey: symbol

Значение свойства

symbol

Комментарии

Значение совпадает со значением SkillConversationReferenceKey, экспортированным из botbuilder-core.

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

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