Conversations Интерфейс

public abstract CompletableFuture createConversation(ConversationParameters parameters)

CreateConversation. Создайте беседу. POST в этом методе с ботом, создающим беседу IsGroup, имеет значение true, если это не прямое сообщение (по умолчанию — false) Массив элементов, который будет связан с элементами, которые должны быть в беседе. Возвращаемое значение — это ResourceResponse, содержащий идентификатор беседы, который подходит для использования в полезных данных сообщения и uri REST API. Большинство каналов поддерживают только семантику ботов, инициирующих прямую беседу сообщений. Пример этого: ''' var resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount[] { new ChannelAccount("user1") } ); await connect. Conversations.SendToConversation(resource). Id, new Activity() ... ; ```

Параметры:

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

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity. Удаление существующего действия. Некоторые каналы позволяют удалить существующее действие, и при успешном выполнении этого метода будет удалено указанное действие.

Параметры:

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

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

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

Параметры:

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

public abstract CompletableFuture> getActivityMembers(String conversationId, String activityId)

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

Параметры:

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

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

Извлекает один член беседы по идентификатору.

Параметры:

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

public abstract CompletableFuture> getConversationMembers(String conversationId)

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

Параметры:

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

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

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

Параметры:

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

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

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

Параметры:

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

public abstract CompletableFuture getConversations()

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

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

public abstract CompletableFuture getConversations(String continuationToken)

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

Параметры:

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

public default CompletableFuture replyToActivity(Activity activity)

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

Параметры:

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

public abstract CompletableFuture replyToActivity(String conversationId, String activityId, Activity activity)

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

Параметры:

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

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

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

Параметры:

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

public default CompletableFuture sendToConversation(Activity activity)

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

Параметры:

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

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

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

Параметры:

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

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity. Изменение существующего действия. Некоторые каналы позволяют изменять существующее действие, чтобы отразить новое состояние беседы бота. Например, можно удалить кнопки после нажатия кнопки "Утвердить".

Параметры:

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

public abstract CompletableFuture updateActivity(String conversationId, String activityId, Activity activity)

UpdateActivity. Изменение существующего действия. Некоторые каналы позволяют изменять существующее действие, чтобы отразить новое состояние беседы бота. Например, можно удалить кнопки после нажатия кнопки "Утвердить".

Параметры:

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

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

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

Параметры:

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