Conversations Interface

public interface Conversations

Uma instância dessa classe fornece acesso a todas as operações definidas em Conversas.

Resumo do método

Modificador e tipo Método e descrição
abstract java.util.concurrent.CompletableFuture<ConversationResourceResponse> createConversation(ConversationParameters parameters)

CriarConversa.

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String conversationId, String activityId)

Excluir atividade de.

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteConversationMember(String conversationId, String memberId)

ExcluirMembro dode Conversa.

abstract java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getActivityMembers(String conversationId, String activityId)

Obter membros dode atividade de.

abstract java.util.concurrent.CompletableFuture<ChannelAccount> getConversationMember(String userId, String conversationId)

Recupera um único membro de uma conversa por ID.

abstract java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getConversationMembers(String conversationId)

ObtenhaMembros dode Conversa.

abstract java.util.concurrent.CompletableFuture<PagedMembersResult> getConversationPagedMembers(String conversationId)

Enumera os membros de uma conversa uma página de cada vez.

abstract java.util.concurrent.CompletableFuture<PagedMembersResult> getConversationPagedMembers(String conversationId, String continuationToken)

Enumera os membros de uma conversa uma página de cada vez.

abstract java.util.concurrent.CompletableFuture<ConversationsResult> getConversations()

Obter conversas.

abstract java.util.concurrent.CompletableFuture<ConversationsResult> getConversations(String continuationToken)

Obter conversas.

default java.util.concurrent.CompletableFuture<ResourceResponse> replyToActivity(Activity activity)

ResponderToActivity.

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

ResponderToActivity.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendConversationHistory(String conversationId, Transcript history)

Esse método permite que você carregue as atividades históricas na conversa.

default java.util.concurrent.CompletableFuture<ResourceResponse> sendToConversation(Activity activity)

EnviarToConversation.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendToConversation(String conversationId, Activity activity)

EnviarToConversation.

default java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity activity)

Atualizar atividade de.

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

Atualizar atividade de.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> uploadAttachment(String conversationId, AttachmentData attachmentUpload)

CarregarAnexo.

Detalhes do método

createConversation

public abstract CompletableFuture createConversation(ConversationParameters parameters)

CreateConversation. Crie uma nova Conversa. POST para este método com um Bot sendo o bot criando a conversa IsGroup definida como true se essa não for uma mensagem direta (o padrão é falso) Matriz de membros continuando os membros que você deseja que estejam na conversa. O valor retornado é um ResourceResponse que contém uma ID de conversa adequada para uso no conteúdo da mensagem e uris da API REST. A maioria dos canais só dá suporte à semântica de bots que iniciam uma conversa direta com mensagens. Um exemplo de como fazer isso seria: ''' var resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); await connect. Conversations.SendToConversation(resource. ID, nova atividade() ... ) ; ```

Parâmetros:

parameters - Parâmetros para criar a conversa a partir de

Retornos:

o observável para o objeto ConversationResourceResponse

deleteActivity

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity. Excluir uma atividade existente. Alguns canais permitem que você exclua uma atividade existente e, se bem-sucedido, esse método removerá a atividade especificada.

Parâmetros:

conversationId - ID da conversa
activityId - activityId a ser excluído

Retornos:

o objeto ServiceResponse<T> se bem-sucedido.

deleteConversationMember

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember. Exclui um membro de uma conversa. Essa API REST usa um ConversationId e um memberId (de cadeia de caracteres de tipo) e remove esse membro da conversa. Se esse membro for o último membro da conversa, a conversa também será excluída.

Parâmetros:

conversationId - ID da conversa
memberId - ID do membro a ser excluído desta conversa

Retornos:

o objeto ServiceResponse<T> se bem-sucedido.

getActivityMembers

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

GetActivityMembers. Enumera os membros de uma atividade. Essa API REST usa uma ConversationId e uma ActivityId, retornando uma matriz de objetos ChannelAccount que representam os membros da atividade específica na conversa.

Parâmetros:

conversationId - ID da conversa
activityId - ID da atividade

Retornos:

o observável para o objeto><de Lista

getConversationMember

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

Recupera um único membro de uma conversa por ID.

Parâmetros:

userId - A ID do usuário.
conversationId - A ID da conversa.

Retornos:

O ChannelAccount para o usuário.

getConversationMembers

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers. Enumerar os membros de uma conversão. Essa API REST usa uma ConversationId e retorna uma matriz de objetos ChannelAccount que representam os membros da conversa.

Parâmetros:

conversationId - ID da conversa

Retornos:

o observável para o objeto><de Lista

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

Enumera os membros de uma conversa uma página de cada vez. Essa API REST usa uma ConversationId. Opcionalmente, um pageSize e/ou continuationToken pode ser fornecido. Ele retorna um PagedMembersResult, que contém uma matriz de ChannelAccounts que representa os membros da conversa e um token de continuação que pode ser usado para obter mais valores. Uma página dos registros ChannelAccounts é retornada com cada chamada. O número de registros em uma página pode variar entre canais e chamadas. Se não houver resultados adicionais, a resposta não conterá um token de continuação. Se não houver membros na conversa, os Membros estarão vazios ou não estarão presentes na resposta. Uma resposta a uma solicitação que tem um token de continuação de uma solicitação anterior raramente pode retornar membros de uma solicitação anterior.

Parâmetros:

conversationId - ID da conversa

Retornos:

o objeto PagedMembersResult se bem-sucedido.

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

Enumera os membros de uma conversa uma página de cada vez. Essa API REST usa uma ConversationId. Opcionalmente, um pageSize e/ou continuationToken pode ser fornecido. Ele retorna um PagedMembersResult, que contém uma matriz de ChannelAccounts que representa os membros da conversa e um token de continuação que pode ser usado para obter mais valores. Uma página dos registros ChannelAccounts é retornada com cada chamada. O número de registros em uma página pode variar entre canais e chamadas. Se não houver resultados adicionais, a resposta não conterá um token de continuação. Se não houver membros na conversa, os Membros estarão vazios ou não estarão presentes na resposta. Uma resposta a uma solicitação que tem um token de continuação de uma solicitação anterior raramente pode retornar membros de uma solicitação anterior.

Parâmetros:

conversationId - ID da conversa
continuationToken - A continuaçãoToken de uma chamada anterior.

Retornos:

o objeto PagedMembersResult se bem-sucedido.

getConversations

public abstract CompletableFuture getConversations()

GetConversations. Liste as Conversas nas quais esse bot participou. OBTER desse método com um token de ignorar O valor retornado é um ConversationsResult, que contém uma matriz de ConversationMembers e um token skip. Se o token de ignorar não estiver vazio, haverá outros valores a serem retornados. Chame esse método novamente com o token retornado para obter mais valores. Cada objeto ConversationMembers contém a ID da conversa e uma matriz de ChannelAccounts que descrevem os membros da conversa.

Retornos:

o observável para o objeto ConversationsResult

getConversations

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations. Liste as Conversas nas quais esse bot participou. OBTER desse método com um token de ignorar O valor retornado é um ConversationsResult, que contém uma matriz de ConversationMembers e um token skip. Se o token de ignorar não estiver vazio, haverá outros valores a serem retornados. Chame esse método novamente com o token retornado para obter mais valores. Cada objeto ConversationMembers contém a ID da conversa e uma matriz de ChannelAccounts que descrevem os membros da conversa.

Parâmetros:

continuationToken - ignorar ou continuar token

Retornos:

o observável para o objeto ConversationsResult

replyToActivity

public default CompletableFuture replyToActivity(Activity activity)

ReplyToActivity. Esse método permite que você responda a uma atividade. Isso é um pouco diferente de SendToConversation(). SendToConversation(conversationId) – acrescentará a atividade ao final da conversa de acordo com o carimbo de data/hora ou semântica do canal. ReplyToActivity(conversationId,ActivityId) – adiciona a atividade como uma resposta a outra atividade, se o canal der suporte a ela. Se o canal não der suporte a respostas aninhadas, ReplyToActivity retornará ao SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parâmetros:

activity - Atividade a ser enviada

Retornos:

o observável para o objeto ResourceResponse

replyToActivity

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

ReplyToActivity. Esse método permite que você responda a uma atividade. Isso é um pouco diferente de SendToConversation(). SendToConversation(conversationId) – acrescentará a atividade ao final da conversa de acordo com o carimbo de data/hora ou semântica do canal. ReplyToActivity(conversationId,ActivityId) – adiciona a atividade como uma resposta a outra atividade, se o canal der suporte a ela. Se o canal não der suporte a respostas aninhadas, ReplyToActivity retornará ao SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parâmetros:

conversationId - ID da conversa
activityId - activityId à qual a resposta é (OPCIONAL)
activity - Atividade a ser enviada

Retornos:

o observável para o objeto ResourceResponse

sendConversationHistory

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

Esse método permite que você carregue as atividades históricas na conversa. O remetente deve garantir que as atividades históricas tenham IDs exclusivas e carimbos de data/hora apropriados. As IDs são usadas pelo cliente para lidar com atividades duplicadas e os carimbos de data/hora são usados pelo cliente para renderizar as atividades na ordem certa.

Parâmetros:

conversationId - ID da conversa
history - Atividades históricas

Retornos:

o objeto ResourceResponse se bem-sucedido.

sendToConversation

public default CompletableFuture sendToConversation(Activity activity)

SendToConversation. Esse método permite que você envie uma atividade para o final de uma conversa. Isso é um pouco diferente de ReplyToActivity(). sendToConverstion(activity) – acrescentará a atividade ao final da conversa de acordo com o carimbo de data/hora ou semântica do canal, usando o Activity.getConversation.getId para a ID da conversa. replyToActivity(conversationId,ActivityId) – adiciona a atividade como uma resposta a outra atividade, se o canal der suporte a ela. Se o canal não der suporte a respostas aninhadas, ReplyToActivity retornará ao SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parâmetros:

activity - Atividade a ser enviada

Retornos:

o observável para o objeto ResourceResponse

sendToConversation

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

SendToConversation. Esse método permite que você envie uma atividade para o final de uma conversa. Isso é um pouco diferente de ReplyToActivity(). SendToConverstion(conversationId) – acrescentará a atividade ao final da conversa de acordo com o carimbo de data/hora ou semântica do canal. ReplyToActivity(conversationId,ActivityId) – adiciona a atividade como uma resposta a outra atividade, se o canal der suporte a ela. Se o canal não der suporte a respostas aninhadas, ReplyToActivity retornará ao SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parâmetros:

conversationId - ID da conversa
activity - Atividade a ser enviada

Retornos:

o observável para o objeto ResourceResponse

updateActivity

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity. Edite uma atividade existente. Alguns canais permitem editar uma atividade existente para refletir o novo estado de uma conversa de bot. Por exemplo, você pode remover botões depois que alguém clicar no botão "Aprovar".

Parâmetros:

activity - Atividade de substituição

Retornos:

o observável para o objeto ResourceResponse

updateActivity

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

UpdateActivity. Edite uma atividade existente. Alguns canais permitem editar uma atividade existente para refletir o novo estado de uma conversa de bot. Por exemplo, você pode remover botões depois que alguém clicar no botão "Aprovar".

Parâmetros:

conversationId - ID da conversa
activityId - activityId para atualizar
activity - Atividade de substituição

Retornos:

o observável para o objeto ResourceResponse

uploadAttachment

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment. Carregue um anexo diretamente no armazenamento de blobs de um canal. Isso é útil porque permite que você armazene dados em um repositório em conformidade ao lidar com empresas. A resposta é um ResourceResponse que contém um AttachmentId que é adequado para uso com a API de anexos.

Parâmetros:

conversationId - ID da conversa
attachmentUpload - Dados de anexo

Retornos:

o observável para o objeto ResourceResponse

Aplica-se a