ChannelServiceHandler Класс
- java.
lang. Object - com.
microsoft. bot. builder. ChannelServiceHandler
- com.
public class ChannelServiceHandler
Класс, помогающий реализовать протокол Bot Framework.
Сводка по конструктору
| Конструктор | Описание |
|---|---|
| ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider) |
Инициализирует новый экземпляр класса ChannelServiceHandler с помощью поставщика учетных данных. |
Сводка по методу
Методы, унаследованные от java.lang.Object
Сведения о конструкторе
ChannelServiceHandler
public ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)
Инициализирует новый экземпляр класса ChannelServiceHandler с помощью поставщика учетных данных.
Параметры:
Сведения о методе
getChannelProvider
protected ChannelProvider getChannelProvider()
Возвращает поставщик каналов, реализующий ChannelProvider.
Возвращаемое значение:
handleCreateConversation
public CompletableFuture
Создайте беседу.
Параметры:
Возвращаемое значение:
handleDeleteActivity
public CompletableFuture
Удаляет существующее действие.
Параметры:
Возвращаемое значение:
handleDeleteConversationMember
public CompletableFuture
Удаляет члена из беседы.
Параметры:
Возвращаемое значение:
handleGetActivityMembers
public CompletableFuture> handleGetActivityMembers(String authHeader, String conversationId, String activityId)
Перечисляет элементы действия.
Параметры:
Возвращаемое значение:
handleGetConversationMembers
public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)
Перечисляет элементы беседы.
Параметры:
Возвращаемое значение:
handleGetConversationPagedMembers
public CompletableFuture
Перечисляет элементы беседы по одной странице за раз.
Параметры:
Возвращаемое значение:
handleGetConversations
public CompletableFuture
Выводит список бесед, в которых участвовал бот.
Параметры:
Возвращаемое значение:
handleReplyToActivity
public CompletableFuture
Отправляет ответ на действие.
Параметры:
Возвращаемое значение:
handleSendConversationHistory
public CompletableFuture
Отправляет исторические действия беседы.
Параметры:
Возвращаемое значение:
handleSendToConversation
public CompletableFuture
Отправляет действие в конец беседы.
Параметры:
Возвращаемое значение:
handleUpdateActivity
public CompletableFuture
Изменяет ранее отправленное существующее действие.
Параметры:
Возвращаемое значение:
handleUploadAttachment
public CompletableFuture
Хранит данные в совместимом хранилище при работе с предприятиями.
Параметры:
Возвращаемое значение:
onCreateConversation
protected CompletableFuture
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() ... ; конец.
Параметры:
Возвращаемое значение:
onDeleteActivity
protected CompletableFuture
API OnDeleteActivity(). Переопределите этот метод, чтобы удалить существующее действие. Некоторые каналы позволяют удалить существующее действие, и при успешном выполнении этого метода будет удалено указанное действие.
Параметры:
Возвращаемое значение:
onDeleteConversationMember
protected CompletableFuture
API DeleteConversationMember() для навыка. Переопределите этот метод, чтобы удалить члена из беседы. Этот REST API принимает ConversationId и memberId (типа String) и удаляет его из беседы. Если этот член был последним членом беседы, беседа также будет удалена.
Параметры:
Возвращаемое значение:
onGetActivityMembers
protected CompletableFuture> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)
API OnGetActivityMembers(). Переопределите этот метод, чтобы перечислить элементы действия. Этот REST API принимает ConversationId и ActivityId, возвращая массив объектов ChannelAccount, представляющих члены конкретного действия в беседе.
Параметры:
Возвращаемое значение:
onGetConversationMembers
protected CompletableFuture> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)
API GetConversationMembers() для навыка. Переопределите этот метод, чтобы перечислить элементы беседы. Этот REST API принимает ConversationId и возвращает массив объектов ChannelAccount, представляющих члены беседы.
Параметры:
Возвращаемое значение:
onGetConversationPagedMembers
protected CompletableFuture
API GetConversationPagedMembers() для навыка. Переопределите этот метод, чтобы перечислить члены беседы по одной странице за раз. Этот REST API принимает ConversationId. При необходимости можно указать страницу И/или продолжениеToken. Он возвращает PagedMembersResult, содержащий массив ChannelAccounts, представляющий члены беседы и маркер продолжения, который можно использовать для получения дополнительных значений. Возвращается одна страница записей ChannelAccounts с каждым вызовом. Количество записей на странице может отличаться от каналов и вызовов. Параметр pageSize можно использовать в качестве предложения. Если нет дополнительных результатов, ответ не будет содержать маркер продолжения. Если в беседе нет участников, члены будут пустыми или отсутствуют в ответе. Ответ на запрос с маркером продолжения из предыдущего запроса может редко возвращать участников из предыдущего запроса.
Параметры:
Возвращаемое значение:
onGetConversations
protected CompletableFuture
API OnGetConversations() для навыка. Переопределите этот метод, чтобы получить список бесед, в которых участвовал этот бот. GET из этого метода с маркером пропуска Возвращаемое значение — ConversationsResult, который содержит массив ConversationMembers и маркер пропуска. Если маркер пропуска не пуст, то возвращаются дополнительные значения. Вызовите этот метод еще раз с возвращенным маркером, чтобы получить дополнительные значения. Каждый объект ConversationMembers содержит D беседы и массив ChannelAccounts, описывающий члены беседы.
Параметры:
Возвращаемое значение:
onReplyToActivity
protected CompletableFuture
API OnReplyToActivity(). Переопределите этот метод позволяет ответить на действие. Это немного отличается от SendToConversation(). * SendToConversation(conversationId) — добавит действие в конец беседы в соответствии с меткой времени или семантикой канала. * ReplyToActivity(conversationId,ActivityId) — добавляет действие в качестве ответа на другое действие, если канал поддерживает его. Если канал не поддерживает вложенные ответы, ReplyToActivity возвращается в SendToConversation. Используйте ReplyToActivity при ответе на определенное действие в беседе. Используйте SendToConversation во всех остальных случаях.
Параметры:
Возвращаемое значение:
onSendConversationHistory
protected CompletableFuture
API SendConversationHistory() для навыка. Переопределите этот метод на этот метод, чтобы передать исторические действия в беседу. Отправитель должен убедиться, что исторические действия имеют уникальные идентификаторы и соответствующие метки времени. Идентификаторы используются клиентом для обработки повторяющихся действий, а метки времени используются клиентом для отрисовки действий в правильном порядке.
Параметры:
Возвращаемое значение:
onSendToConversation
protected CompletableFuture
API SendToConversation() для навыка. Этот метод позволяет отправлять действие в конец беседы. Это немного отличается от ReplyToActivity(). * SendToConversation(conversationId) — добавит действие в конец беседы в соответствии с меткой времени или семантикой канала. * ReplyToActivity(conversationId,ActivityId) — добавляет действие в качестве ответа на другое действие, если канал поддерживает его. Если канал не поддерживает вложенные ответы, ReplyToActivity возвращается в SendToConversation. Используйте ReplyToActivity при ответе на определенное действие в беседе. Используйте SendToConversation во всех остальных случаях.
Параметры:
Возвращаемое значение:
onUpdateActivity
protected CompletableFuture
API OnUpdateActivity(). Переопределите этот метод, чтобы изменить ранее отправленное существующее действие. Некоторые каналы позволяют изменять существующее действие, чтобы отразить новое состояние беседы бота. Например, можно удалить кнопки после нажатия кнопки "Утвердить".
Параметры:
Возвращаемое значение:
onUploadAttachment
protected CompletableFuture
API UploadAttachment(). Переопределите этот метод для хранения данных в совместимом хранилище при работе с предприятиями. Ответ — это ResourceResponse, который содержит Идентификатор вложения, который подходит для использования с API вложений.
Параметры:
Возвращаемое значение: