ChannelServiceHandler Класс

  • java.lang.Object
    • com.microsoft.bot.builder.ChannelServiceHandler

public class ChannelServiceHandler

Класс, помогающий реализовать протокол Bot Framework.

Сводка по конструктору

Конструктор Описание
ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)

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

Сводка по методу

Модификатор и тип Метод и описание
protected ChannelProvider getChannelProvider()

Возвращает поставщик каналов, реализующий ChannelProvider.

java.util.concurrent.CompletableFuture<ConversationResourceResponse> handleCreateConversation(String authHeader, ConversationParameters parameters)

Создайте беседу.

java.util.concurrent.CompletableFuture<java.lang.Void> handleDeleteActivity(String authHeader, String conversationId, String activityId)

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

java.util.concurrent.CompletableFuture<java.lang.Void> handleDeleteConversationMember(String authHeader, String conversationId, String memberId)

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

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> handleGetActivityMembers(String authHeader, String conversationId, String activityId)

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

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> handleGetConversationMembers(String authHeader, String conversationId)

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

java.util.concurrent.CompletableFuture<PagedMembersResult> handleGetConversationPagedMembers(String authHeader, String conversationId, Integer pageSize, String continuationToken)

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

java.util.concurrent.CompletableFuture<ConversationsResult> handleGetConversations(String authHeader, String conversationId, String continuationToken)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleReplyToActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleSendConversationHistory(String authHeader, String conversationId, Transcript transcript)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleSendToConversation(String authHeader, String conversationId, Activity activity)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleUpdateActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleUploadAttachment(String authHeader, String conversationId, AttachmentData attachmentUpload)

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

protected java.util.concurrent.CompletableFuture<ConversationResourceResponse> onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

Создание APIConversation().

protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

В API удалениядействий().

protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteConversationMember(ClaimsIdentity claimsIdentity, String conversationId, String memberId)

Удалите APIбеседыучастника() для навыка.

protected java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

ВAPI получениядействийчленов().

protected java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

Получение APIбеседыдля навыка.

protected java.util.concurrent.CompletableFuture<PagedMembersResult> onGetConversationPagedMembers(ClaimsIdentity claimsIdentity, String conversationId, Integer pageSize, String continuationToken)

ПолучениеAPIучастников() для навыка.

protected java.util.concurrent.CompletableFuture<ConversationsResult> onGetConversations(ClaimsIdentity claimsIdentity, String conversationId, String continuationToken)

Наполучить APIConversations() для навыка.

protected java.util.concurrent.CompletableFuture<ResourceResponse> onReplyToActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

ВAPI ответаToActivity().

protected java.util.concurrent.CompletableFuture<ResourceResponse> onSendConversationHistory(ClaimsIdentity claimsIdentity, String conversationId, Transcript transcript)

Отправка APIбеседыжурнала() для навыка.

protected java.util.concurrent.CompletableFuture<ResourceResponse> onSendToConversation(ClaimsIdentity claimsIdentity, String conversationId, Activity activity)

Отправка APIToConversation() для навыка.

protected java.util.concurrent.CompletableFuture<ResourceResponse> onUpdateActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

Вобновите APIActivity().

protected java.util.concurrent.CompletableFuture<ResourceResponse> onUploadAttachment(ClaimsIdentity claimsIdentity, String conversationId, AttachmentData attachmentUpload)

Отправка APIвложения().

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

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

ChannelServiceHandler

public ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)

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

Параметры:

credentialProvider - Поставщик учетных данных.
authConfiguration - Конфигурация проверки подлинности.
channelProvider - Поставщик каналов.

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

getChannelProvider

protected ChannelProvider getChannelProvider()

Возвращает поставщик каналов, реализующий ChannelProvider.

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

Значение ChannelProvider в качестве getChannelProvider().

handleCreateConversation

public CompletableFuture handleCreateConversation(String authHeader, ConversationParameters parameters)

Создайте беседу.

Параметры:

authHeader - Заголовок проверки подлинности.
parameters - Параметры для создания беседы из.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleDeleteActivity

public CompletableFuture handleDeleteActivity(String authHeader, String conversationId, String activityId)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
activityId - Идентификатор действия.

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

CompletableFuture, представляющий результат асинхронной операции.

handleDeleteConversationMember

public CompletableFuture handleDeleteConversationMember(String authHeader, String conversationId, String memberId)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
memberId - Идентификатор члена, который нужно удалить из этой беседы.

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

CompletableFuture, представляющий асинхронную операцию.

handleGetActivityMembers

public CompletableFuture> handleGetActivityMembers(String authHeader, String conversationId, String activityId)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
activityId - Идентификатор действия.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleGetConversationMembers

public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleGetConversationPagedMembers

public CompletableFuture handleGetConversationPagedMembers(String authHeader, String conversationId, Integer pageSize, String continuationToken)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
pageSize - Предлагаемый размер страницы.
continuationToken - Маркер продолжения.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleGetConversations

public CompletableFuture handleGetConversations(String authHeader, String conversationId, String continuationToken)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
continuationToken - Маркер пропуска или продолжения.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleReplyToActivity

public CompletableFuture handleReplyToActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
activityId - Идентификатор действия, на который отвечает ответ.
activity - Действие для отправки.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleSendConversationHistory

public CompletableFuture handleSendConversationHistory(String authHeader, String conversationId, Transcript transcript)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
transcript - Расшифровка действий.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleSendToConversation

public CompletableFuture handleSendToConversation(String authHeader, String conversationId, Activity activity)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
activity - Действие для отправки.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleUpdateActivity

public CompletableFuture handleUpdateActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
activityId - Идентификатор действия для обновления.
activity - Действие замены.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

handleUploadAttachment

public CompletableFuture handleUploadAttachment(String authHeader, String conversationId, AttachmentData attachmentUpload)

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

Параметры:

authHeader - Заголовок проверки подлинности.
conversationId - Идентификатор беседы.
attachmentUpload - Данные вложения.

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

Объект {@link CompletableFuture{TResult}}}, представляющий результат асинхронной операции.

onCreateConversation

protected CompletableFuture onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

API CreateConversation() Переопределите этот метод, чтобы создать новую беседу. POST в этом методе с * Ботом, создающим беседу * IsGroup, имеет значение true, если это не прямое сообщение (экземпляр по умолчанию false) * Массив, содержащий члены, включаемые в беседу, возвращаемое значение — resourceResponse, который содержит беседу D, которая подходит для использования в полезных данных сообщения и URI REST API. Большинство каналов поддерживают только семантику ботов, инициирующих прямую беседу сообщений. Примером этого будет: var resource = connector.getconversations(). CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); connect.getConversations(). OnSendToConversation(resource.getId(), new Activity() ... ; конец.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
parameters - Параметры для создания беседы из.

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

задача для ответа ресурса беседы.

onDeleteActivity

protected CompletableFuture onDeleteActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

API OnDeleteActivity(). Переопределите этот метод, чтобы удалить существующее действие. Некоторые каналы позволяют удалить существующее действие, и при успешном выполнении этого метода будет удалено указанное действие.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
activityId - activityId для удаления.

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

задача ответа на ресурс.

onDeleteConversationMember

protected CompletableFuture onDeleteConversationMember(ClaimsIdentity claimsIdentity, String conversationId, String memberId)

API DeleteConversationMember() для навыка. Переопределите этот метод, чтобы удалить члена из беседы. Этот REST API принимает ConversationId и memberId (типа String) и удаляет его из беседы. Если этот член был последним членом беседы, беседа также будет удалена.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
memberId - D члена, который нужно удалить из этой беседы.

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

задача.

onGetActivityMembers

protected CompletableFuture> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

API OnGetActivityMembers(). Переопределите этот метод, чтобы перечислить элементы действия. Этот REST API принимает ConversationId и ActivityId, возвращая массив объектов ChannelAccount, представляющих члены конкретного действия в беседе.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
activityId - Действие D.

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

задача с результатом.

onGetConversationMembers

protected CompletableFuture> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

API GetConversationMembers() для навыка. Переопределите этот метод, чтобы перечислить элементы беседы. Этот REST API принимает ConversationId и возвращает массив объектов ChannelAccount, представляющих члены беседы.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.

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

задача для ответа.

onGetConversationPagedMembers

protected CompletableFuture onGetConversationPagedMembers(ClaimsIdentity claimsIdentity, String conversationId, Integer pageSize, String continuationToken)

API GetConversationPagedMembers() для навыка. Переопределите этот метод, чтобы перечислить члены беседы по одной странице за раз. Этот REST API принимает ConversationId. При необходимости можно указать страницу И/или продолжениеToken. Он возвращает PagedMembersResult, содержащий массив ChannelAccounts, представляющий члены беседы и маркер продолжения, который можно использовать для получения дополнительных значений. Возвращается одна страница записей ChannelAccounts с каждым вызовом. Количество записей на странице может отличаться от каналов и вызовов. Параметр pageSize можно использовать в качестве предложения. Если нет дополнительных результатов, ответ не будет содержать маркер продолжения. Если в беседе нет участников, члены будут пустыми или отсутствуют в ответе. Ответ на запрос с маркером продолжения из предыдущего запроса может редко возвращать участников из предыдущего запроса.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
pageSize - Предлагаемый размер страницы.
continuationToken - Токен продолжения.

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

задача для ответа.

onGetConversations

protected CompletableFuture onGetConversations(ClaimsIdentity claimsIdentity, String conversationId, String continuationToken)

API OnGetConversations() для навыка. Переопределите этот метод, чтобы получить список бесед, в которых участвовал этот бот. GET из этого метода с маркером пропуска Возвращаемое значение — ConversationsResult, который содержит массив ConversationMembers и маркер пропуска. Если маркер пропуска не пуст, то возвращаются дополнительные значения. Вызовите этот метод еще раз с возвращенным маркером, чтобы получить дополнительные значения. Каждый объект ConversationMembers содержит D беседы и массив ChannelAccounts, описывающий члены беседы.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - conversationId.
continuationToken - пропустить или продолжить маркер.

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

задача для ConversationsResult.

onReplyToActivity

protected CompletableFuture onReplyToActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

API OnReplyToActivity(). Переопределите этот метод позволяет ответить на действие. Это немного отличается от SendToConversation(). * SendToConversation(conversationId) — добавит действие в конец беседы в соответствии с меткой времени или семантикой канала. * ReplyToActivity(conversationId,ActivityId) — добавляет действие в качестве ответа на другое действие, если канал поддерживает его. Если канал не поддерживает вложенные ответы, ReplyToActivity возвращается в SendToConversation. Используйте ReplyToActivity при ответе на определенное действие в беседе. Используйте SendToConversation во всех остальных случаях.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
activityId - activityId, на который отвечает ответ (OPTONAL).
activity - Действие для отправки.

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

задача ответа на ресурс.

onSendConversationHistory

protected CompletableFuture onSendConversationHistory(ClaimsIdentity claimsIdentity, String conversationId, Transcript transcript)

API SendConversationHistory() для навыка. Переопределите этот метод на этот метод, чтобы передать исторические действия в беседу. Отправитель должен убедиться, что исторические действия имеют уникальные идентификаторы и соответствующие метки времени. Идентификаторы используются клиентом для обработки повторяющихся действий, а метки времени используются клиентом для отрисовки действий в правильном порядке.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
transcript - Расшифровка действий.

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

задача ответа на ресурс.

onSendToConversation

protected CompletableFuture onSendToConversation(ClaimsIdentity claimsIdentity, String conversationId, Activity activity)

API SendToConversation() для навыка. Этот метод позволяет отправлять действие в конец беседы. Это немного отличается от ReplyToActivity(). * SendToConversation(conversationId) — добавит действие в конец беседы в соответствии с меткой времени или семантикой канала. * ReplyToActivity(conversationId,ActivityId) — добавляет действие в качестве ответа на другое действие, если канал поддерживает его. Если канал не поддерживает вложенные ответы, ReplyToActivity возвращается в SendToConversation. Используйте ReplyToActivity при ответе на определенное действие в беседе. Используйте SendToConversation во всех остальных случаях.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - conversationId.
activity - Действие для отправки.

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

задача ответа на ресурс.

onUpdateActivity

protected CompletableFuture onUpdateActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

API OnUpdateActivity(). Переопределите этот метод, чтобы изменить ранее отправленное существующее действие. Некоторые каналы позволяют изменять существующее действие, чтобы отразить новое состояние беседы бота. Например, можно удалить кнопки после нажатия кнопки "Утвердить".

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
activityId - activityId для обновления.
activity - Действие замены.

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

задача ответа на ресурс.

onUploadAttachment

protected CompletableFuture onUploadAttachment(ClaimsIdentity claimsIdentity, String conversationId, AttachmentData attachmentUpload)

API UploadAttachment(). Переопределите этот метод для хранения данных в совместимом хранилище при работе с предприятиями. Ответ — это ResourceResponse, который содержит Идентификатор вложения, который подходит для использования с API вложений.

Параметры:

claimsIdentity - claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.
conversationId - Беседа D.
attachmentUpload - Данные вложения.

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

задача с результатом.

Применяется к