ChannelServiceHandler Classe

  • java.lang.Object
    • com.microsoft.bot.builder.ChannelServiceHandler

public class ChannelServiceHandler

Uma classe para ajudar na implementação do protocolo do Bot Framework.

Resumo do Construtor

Construtor Description
ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)

Inicializa uma nova instância da ChannelServiceHandler classe usando um provedor de credenciais.

Resumo do método

Modificador e tipo Método e descrição
protected ChannelProvider getChannelProvider()

Obtém o provedor de canal que implementa ChannelProvider .

java.util.concurrent.CompletableFuture<ConversationResourceResponse>

handleCreateConversation(String authHeader, ConversationParameters parameters)

Crie uma nova Conversa.

java.util.concurrent.CompletableFuture<java.lang.Void>

handleDeleteActivity(String authHeader, String conversationId, String activityId)

Exclui uma atividade existente.

java.util.concurrent.CompletableFuture<java.lang.Void>

handleDeleteConversationMember(String authHeader, String conversationId, String memberId)

Exclui um membro de uma conversa.

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>

handleGetActivityMembers(String authHeader, String conversationId, String activityId)

Enumera os membros de uma atividade.

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>

handleGetConversationMembers(String authHeader, String conversationId)

Enumera os membros de uma conversa.

java.util.concurrent.CompletableFuture<PagedMembersResult>

handleGetConversationPagedMembers(String authHeader, String conversationId, Integer pageSize, String continuationToken)

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

java.util.concurrent.CompletableFuture<ConversationsResult>

handleGetConversations(String authHeader, String conversationId, String continuationToken)

Lista as Conversas nas quais o bot participou.

java.util.concurrent.CompletableFuture<ResourceResponse>

handleReplyToActivity(String authHeader, String conversationId, String activityId, Activity activity)

Envia uma resposta para uma atividade.

java.util.concurrent.CompletableFuture<ResourceResponse>

handleSendConversationHistory(String authHeader, String conversationId, Transcript transcript)

Carrega as atividades históricas da conversa.

java.util.concurrent.CompletableFuture<ResourceResponse>

handleSendToConversation(String authHeader, String conversationId, Activity activity)

Envia uma atividade para o final de uma conversa.

java.util.concurrent.CompletableFuture<ResourceResponse>

handleUpdateActivity(String authHeader, String conversationId, String activityId, Activity activity)

Edita uma atividade existente enviada anteriormente.

java.util.concurrent.CompletableFuture<ResourceResponse>

handleUploadAttachment(String authHeader, String conversationId, AttachmentData attachmentUpload)

Armazena dados em um repositório em conformidade ao lidar com empresas.

protected

java.util.concurrent.CompletableFuture<ConversationResourceResponse>

onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

CriarAPI conversation().

protected

java.util.concurrent.CompletableFuture<java.lang.Void>

onDeleteActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

NaAPI DeleteActivity().

protected

java.util.concurrent.CompletableFuture<java.lang.Void>

onDeleteConversationMember(ClaimsIdentity claimsIdentity, String conversationId, String memberId)

Excluira API de Membro da Conversa() para Skill.

protected

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>

onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

NaAPI ObterMembros da Atividade().

protected

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>

onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

Obtera API de Membros da Conversa() para Skill.

protected

java.util.concurrent.CompletableFuture<PagedMembersResult>

onGetConversationPagedMembers(ClaimsIdentity claimsIdentity, String conversationId, Integer pageSize, String continuationToken)

Obtera API de Membros Paginadode Conversa() para Skill.

protected

java.util.concurrent.CompletableFuture<ConversationsResult>

onGetConversations(ClaimsIdentity claimsIdentity, String conversationId, String continuationToken)

NaAPI GetConversations() para Skill.

protected

java.util.concurrent.CompletableFuture<ResourceResponse>

onReplyToActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

NaAPI ReplyToActivity().

protected

java.util.concurrent.CompletableFuture<ResourceResponse>

onSendConversationHistory(ClaimsIdentity claimsIdentity, String conversationId, Transcript transcript)

EnviarAPI de Histórico de Conversas() para Skill.

protected

java.util.concurrent.CompletableFuture<ResourceResponse>

onSendToConversation(ClaimsIdentity claimsIdentity, String conversationId, Activity activity)

Enviara API ToConversation() para Skill.

protected

java.util.concurrent.CompletableFuture<ResourceResponse>

onUpdateActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

NaAPI de Atividades de Atualização().

protected

java.util.concurrent.CompletableFuture<ResourceResponse>

onUploadAttachment(ClaimsIdentity claimsIdentity, String conversationId, AttachmentData attachmentUpload)

Carregara API Attachment().

Métodos herdados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalhes do construtor

ChannelServiceHandler

public ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)

Inicializa uma nova instância da ChannelServiceHandler classe usando um provedor de credenciais.

Parameters:

credentialProvider - O provedor de credenciais.
authConfiguration - A configuração de autenticação.
channelProvider - O provedor de canais.

Detalhes do método

getChannelProvider

protected ChannelProvider getChannelProvider()

Obtém o provedor de canal que implementa ChannelProvider .

Returns:

o valor ChannelProvider como um getChannelProvider().

handleCreateConversation

public CompletableFuture handleCreateConversation(String authHeader, ConversationParameters parameters)

Crie uma nova Conversa.

Parameters:

authHeader - O cabeçalho de autenticação.
parameters - Parâmetros para criar a conversa.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleDeleteActivity

public CompletableFuture handleDeleteActivity(String authHeader, String conversationId, String activityId)

Exclui uma atividade existente.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
activityId - A ID da atividade.

Returns:

Um CompletableFuture que representa o resultado da operação assíncrona.

handleDeleteConversationMember

public CompletableFuture handleDeleteConversationMember(String authHeader, String conversationId, String memberId)

Exclui um membro de uma conversa.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
memberId - ID do membro a ser excluído desta conversa.

Returns:

Um CompletableFuture representando a operação assíncrona.

handleGetActivityMembers

public CompletableFuture<>> handleGetActivityMembers(String authHeader, String conversationId, String activityId)

Enumera os membros de uma atividade.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
activityId - A ID da atividade.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleGetConversationMembers

public CompletableFuture<>> handleGetConversationMembers(String authHeader, String conversationId)

Enumera os membros de uma conversa.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleGetConversationPagedMembers

public CompletableFuture handleGetConversationPagedMembers(String authHeader, String conversationId, Integer pageSize, String continuationToken)

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

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
pageSize - Tamanho de página sugerido.
continuationToken - Um token de continuação.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleGetConversations

public CompletableFuture handleGetConversations(String authHeader, String conversationId, String continuationToken)

Lista as Conversas nas quais o bot participou.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
continuationToken - Um token de ignorar ou de continuação.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleReplyToActivity

public CompletableFuture handleReplyToActivity(String authHeader, String conversationId, String activityId, Activity activity)

Envia uma resposta para uma atividade.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
activityId - A ID da atividade à qual a resposta é.
activity - A atividade a ser enviada.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleSendConversationHistory

public CompletableFuture handleSendConversationHistory(String authHeader, String conversationId, Transcript transcript)

Carrega as atividades históricas da conversa.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
transcript - Transcrição de atividades.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleSendToConversation

public CompletableFuture handleSendToConversation(String authHeader, String conversationId, Activity activity)

Envia uma atividade para o final de uma conversa.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
activity - A atividade a ser enviada.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleUpdateActivity

public CompletableFuture handleUpdateActivity(String authHeader, String conversationId, String activityId, Activity activity)

Edita uma atividade existente enviada anteriormente.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
activityId - A ID da atividade a ser atualizada.
activity - A atividade de substituição.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

handleUploadAttachment

public CompletableFuture handleUploadAttachment(String authHeader, String conversationId, AttachmentData attachmentUpload)

Armazena dados em um repositório em conformidade ao lidar com empresas.

Parameters:

authHeader - O cabeçalho de autenticação.
conversationId - A ID da conversa.
attachmentUpload - Dados de anexo.

Returns:

Um {@link CompleteableFuture{TResult}} que representa o resultado da operação assíncrona.

onCreateConversation

protected CompletableFuture onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

API CreateConversation(). Substitua esse método para criar uma conversa. POST para este método com um * Bot sendo o bot criando a conversa * IsGroup definido como true se esta não for uma mensagem direta (instância padrão de false) * Matriz que contém os membros a serem incluídos na conversa O valor retornado é um ResourceResponse que contém uma conversa D que é 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 de mensagem direta. Um exemplo de como fazer isso seria: var resource = connector.getconversations(). CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); connect.getConversations(). OnSendToConversation(resource.getId(), new Activity() ... ) ; Final.

Parameters:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
parameters - Parâmetros para criar a conversa.

Returns:

tarefa para uma resposta de recurso de conversa.

onDeleteActivity

protected CompletableFuture onDeleteActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

API OnDeleteActivity(). Substitua esse método para Excluir uma atividade existente. Alguns canais permitem que você exclua uma atividade existente e, se tiver êxito, esse método removerá a atividade especificada.

Parameters:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
activityId - activityId a ser excluído.

Returns:

tarefa para uma resposta de recurso.

onDeleteConversationMember

protected CompletableFuture onDeleteConversationMember(ClaimsIdentity claimsIdentity, String conversationId, String memberId)

API DeleteConversationMember() para Skill. Substitua esse método para excluir um membro de uma conversa. Essa API REST usa um ConversationId e um memberId (do tipo String) e remove esse membro da conversa. Se esse membro for o último da conversa, a conversa também será excluída.

Parameters:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
memberId - D do membro a ser excluído dessa conversa.

Returns:

Tarefa.

onGetActivityMembers

protected CompletableFuture<>> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

API OnGetActivityMembers(). Substitua esse método para enumerar 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.

Parameters:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
activityId - Atividade D.

Returns:

tarefa com resultado.

onGetConversationMembers

protected CompletableFuture<>> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

API GetConversationMembers() para Skill. Substitua esse método para enumerar os membros de uma conversa. Essa API REST usa uma ConversationId e retorna uma matriz de Objetos ChannelAccount que representam os membros da conversa.

Parameters:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.

Returns:

tarefa para uma resposta.

onGetConversationPagedMembers

protected CompletableFuture onGetConversationPagedMembers(ClaimsIdentity claimsIdentity, String conversationId, Integer pageSize, String continuationToken)

API GetConversationPagedMembers() para Skill. Substitua esse método para enumerar 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 representando 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. O parâmetro pageSize pode ser usado como uma sugestão. 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:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
pageSize - Tamanho da página sugerido.
continuationToken - Token de continuação.

Returns:

tarefa para uma resposta.

onGetConversations

protected CompletableFuture onGetConversations(ClaimsIdentity claimsIdentity, String conversationId, String continuationToken)

API OnGetConversations() para Skill. Substitua esse método para listar 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 o D da conversa e uma matriz de ChannelAccounts que descrevem os membros da conversa.

Parameters:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - conversationId.
continuationToken - ignorar ou token de continuação.

Returns:

tarefa para ConversationsResult.

onReplyToActivity

protected CompletableFuture onReplyToActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

API OnReplyToActivity(). Substituir esse método permite responder 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:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
activityId - activityId a resposta é para (OPTONAL).
activity - Atividade a ser enviada.

Returns:

tarefa para uma resposta de recurso.

onSendConversationHistory

protected CompletableFuture onSendConversationHistory(ClaimsIdentity claimsIdentity, String conversationId, Transcript transcript)

API SendConversationHistory() para Skill. Substituir esse método para 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:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
transcript - Transcrição de atividades.

Returns:

tarefa para uma resposta de recurso.

onSendToConversation

protected CompletableFuture onSendToConversation(ClaimsIdentity claimsIdentity, String conversationId, Activity activity)

API SendToConversation() para Skill. Esse método permite que você envie uma atividade para o final de uma conversa. Isso é um pouco diferente de ReplyToActivity(). * 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:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - conversationId.
activity - Atividade a ser enviada.

Returns:

tarefa para uma resposta de recurso.

onUpdateActivity

protected CompletableFuture onUpdateActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

API OnUpdateActivity(). Substitua esse método para editar uma atividade existente enviada anteriormente. 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:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
activityId - activityId a ser atualizado.
activity - Atividade de substituição.

Returns:

tarefa para uma resposta de recurso.

onUploadAttachment

protected CompletableFuture onUploadAttachment(ClaimsIdentity claimsIdentity, String conversationId, AttachmentData attachmentUpload)

API UploadAttachment(). Substitua esse método para 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:

claimsIdentity - claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversa D.
attachmentUpload - Dados de anexo.

Returns:

tarefa com resultado.

Aplica-se a