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<Conversation |
createConversation(ConversationParameters parameters)
Criar |
abstract java.util.concurrent.CompletableFuture<java.lang.Void> |
deleteActivity(String conversationId, String activityId)
Excluir |
abstract java.util.concurrent.CompletableFuture<java.lang.Void> |
deleteConversationMember(String conversationId, String memberId)
Excluir |
abstract
java.util.concurrent.CompletableFuture<java.util.List<Channel |
getActivityMembers(String conversationId, String activityId)
Obter |
abstract
java.util.concurrent.CompletableFuture<Channel |
getConversationMember(String userId, String conversationId)
Recupera um único membro de uma conversa por ID. |
abstract
java.util.concurrent.CompletableFuture<java.util.List<Channel |
getConversationMembers(String conversationId)
Obter |
abstract
java.util.concurrent.CompletableFuture<Paged |
getConversationPagedMembers(String conversationId)
Enumerar os membros de uma conversa uma página por vez. |
abstract
java.util.concurrent.CompletableFuture<Paged |
getConversationPagedMembers(String conversationId, String continuationToken)
Enumerar os membros de uma conversa uma página por vez. |
abstract
java.util.concurrent.CompletableFuture<Conversations |
getConversations()
Obter |
abstract
java.util.concurrent.CompletableFuture<Conversations |
getConversations(String continuationToken)
Obter |
default
java.util.concurrent.CompletableFuture<Resource |
replyToActivity(Activity activity)
Responder |
abstract
java.util.concurrent.CompletableFuture<Resource |
replyToActivity(String conversationId, String activityId, Activity activity)
Responder |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendConversationHistory(String conversationId, Transcript history)
Esse método permite que você carregue as atividades históricas na conversa. |
default
java.util.concurrent.CompletableFuture<Resource |
sendToConversation(Activity activity)
Enviar |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendToConversation(String conversationId, Activity activity)
Enviar |
default
java.util.concurrent.CompletableFuture<Resource |
updateActivity(Activity activity)
Atualizar |
abstract
java.util.concurrent.CompletableFuture<Resource |
updateActivity(String conversationId, String activityId, Activity activity)
Atualizar |
abstract
java.util.concurrent.CompletableFuture<Resource |
uploadAttachment(String conversationId, AttachmentData attachmentUpload)
Carregar |
Detalhes do método
createConversation
public abstract CompletableFuture
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:
Returns:
deleteActivity
public abstract CompletableFuture
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:
Returns:
deleteConversationMember
public abstract CompletableFuture
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:
Returns:
getActivityMembers
public abstract CompletableFuture<>
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:
Returns:
getConversationMember
public abstract CompletableFuture
Recupera um único membro de uma conversa por ID.
Parameters:
Returns:
getConversationMembers
public abstract CompletableFuture<>
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:
Returns:
getConversationPagedMembers
public abstract CompletableFuture
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:
Returns:
getConversationPagedMembers
public abstract CompletableFuture
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:
Returns:
getConversations
public abstract CompletableFuture
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:
getConversations
public abstract CompletableFuture
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:
Returns:
replyToActivity
public default CompletableFuture
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:
Returns:
replyToActivity
public abstract CompletableFuture
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:
Returns:
sendConversationHistory
public abstract CompletableFuture
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:
Returns:
sendToConversation
public default CompletableFuture
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:
Returns:
sendToConversation
public abstract CompletableFuture
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:
Returns:
updateActivity
public default CompletableFuture
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:
Returns:
updateActivity
public abstract CompletableFuture
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:
Returns:
uploadAttachment
public abstract CompletableFuture
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:
Returns: