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)

ExcluirAtividade.

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

ExcluirMembro da Conversa.

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

Obtermembros da atividade.

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)

Obtermembros da conversa.

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

Enumerar os membros de uma conversa uma página por vez.

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

Enumerar os membros de uma conversa uma página por vez.

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

ObterConversas.

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

ObterConversas.

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

Respondera Ativação.

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

Respondera Ativação.

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)

EnviarparaConversação.

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

EnviarparaConversação.

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

AtualizarAtividade.

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

AtualizarAtividade.

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 esse método com um Bot sendo o bot criando a conversa IsGroup definida como true se esta não for uma mensagem direta (o padrão é false) Matriz de membros continuando os membros que você deseja ter na conversa. O valor retornado é um ResourceResponse que contém uma ID de conversa que é adequada para uso no conteúdo da mensagem e uris da API REST. A maioria dos canais dá suporte apenas à 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, new Activity() ... ) ; ```

Parameters:

parameters - Parâmetros para criar a conversa com base em

Returns:

o observável para o objeto ConversationResourceResponse

deleteActivity

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

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

Parameters:

conversationId - Identificação da conversa
activityId - activityId a ser excluída

Returns:

o ServiceResponse<T> objeto se tiver êxito.

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 (do tipo cadeia de caracteres) e remove esse membro da conversa. Se esse membro for o último da conversa, a conversa também será excluída.

Parameters:

conversationId - Identificação da conversa
memberId - ID do membro a ser excluído desta conversa

Returns:

o ServiceResponse<T> objeto se tiver êxito.

getActivityMembers

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

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

Parameters:

conversationId - Identificação da conversa
activityId - ID da atividade

Returns:

o observável para o objeto List<ChannelAccount>

getConversationMember

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

Recupera um único membro de uma conversa por ID.

Parameters:

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

Returns:

A ChannelAccount para o usuário.

getConversationMembers

public abstract CompletableFuture<>> getConversationMembers(String conversationId)

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

Parameters:

conversationId - Identificação da conversa

Returns:

o observável para o objeto List<ChannelAccount>

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

Enumerar os membros de uma conversa uma página por 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 de 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.

Parameters:

conversationId - Identificação da conversa

Returns:

o objeto PagedMembersResult se tiver êxito.

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

Enumerar os membros de uma conversa uma página por 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 de 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.

Parameters:

conversationId - Identificação da conversa
continuationToken - O continuationToken de uma chamada anterior.

Returns:

o objeto PagedMembersResult se tiver êxito.

getConversations

public abstract CompletableFuture getConversations()

GetConversations. Liste as Conversas nas quais esse bot participou. GET desse método com um token skip 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.

Returns:

o observável para o objeto ConversationsResult

getConversations

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations. Liste as Conversas nas quais esse bot participou. GET desse método com um token skip 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.

Parameters:

continuationToken - ignorar ou token de continuação

Returns:

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á para SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parameters:

activity - Atividade a ser enviada

Returns:

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á para SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parameters:

conversationId - Identificação da conversa
activityId - activityId a resposta é para (OPCIONAL)
activity - Atividade a ser enviada

Returns:

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 correta.

Parameters:

conversationId - Identificação da conversa
history - Atividades históricas

Returns:

o objeto ResourceResponse se tiver êxito.

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 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á para SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parameters:

activity - Atividade a ser enviada

Returns:

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á para SendToConversation. Use ReplyToActivity ao responder a uma atividade específica na conversa. Use SendToConversation em todos os outros casos.

Parameters:

conversationId - Identificação da conversa
activity - Atividade a ser enviada

Returns:

o observável para o objeto ResourceResponse

updateActivity

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity. Editar 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".

Parameters:

activity - Atividade de substituição

Returns:

o observável para o objeto ResourceResponse

updateActivity

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

UpdateActivity. Editar 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".

Parameters:

conversationId - Identificação da conversa
activityId - activityId a ser atualizada
activity - Atividade de substituição

Returns:

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 armazenar 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.

Parameters:

conversationId - Identificação da conversa
attachmentUpload - Dados do anexo

Returns:

o observável para o objeto ResourceResponse

Aplica-se a