ChannelServiceHandler Clase

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

public class ChannelServiceHandler

Clase que ayuda con la implementación del protocolo Bot Framework.

Resumen del constructor

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

Inicializa una nueva instancia de la clase ChannelServiceHandler mediante un proveedor de credenciales.

Resumen del método

Modificador y tipo Método y descripción
protected ChannelProvider getChannelProvider()

Obtiene el proveedor de canales que implementa ChannelProvider .

java.util.concurrent.CompletableFuture<ConversationResourceResponse> handleCreateConversation(String authHeader, ConversationParameters parameters)

Cree una nueva conversación.

java.util.concurrent.CompletableFuture<java.lang.Void> handleDeleteActivity(String authHeader, String conversationId, String activityId)

Elimina una actividad existente.

java.util.concurrent.CompletableFuture<java.lang.Void> handleDeleteConversationMember(String authHeader, String conversationId, String memberId)

Elimina un miembro de una conversación.

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> handleGetActivityMembers(String authHeader, String conversationId, String activityId)

Enumera los miembros de una actividad.

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> handleGetConversationMembers(String authHeader, String conversationId)

Enumera los miembros de una conversación.

java.util.concurrent.CompletableFuture<PagedMembersResult> handleGetConversationPagedMembers(String authHeader, String conversationId, Integer pageSize, String continuationToken)

Enumera los miembros de una conversación una página a la vez.

java.util.concurrent.CompletableFuture<ConversationsResult> handleGetConversations(String authHeader, String conversationId, String continuationToken)

Enumera las conversaciones en las que ha participado el bot.

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

Envía una respuesta a una actividad.

java.util.concurrent.CompletableFuture<ResourceResponse> handleSendConversationHistory(String authHeader, String conversationId, Transcript transcript)

Carga las actividades históricas de la conversación.

java.util.concurrent.CompletableFuture<ResourceResponse> handleSendToConversation(String authHeader, String conversationId, Activity activity)

Envía una actividad al final de una conversación.

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

Edita una actividad existente enviada previamente.

java.util.concurrent.CompletableFuture<ResourceResponse> handleUploadAttachment(String authHeader, String conversationId, AttachmentData attachmentUpload)

Almacena datos en un almacén compatible cuando se trabaja con empresas.

protected java.util.concurrent.CompletableFuture<ConversationResourceResponse> onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

CreeAPI Conversation().

protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

EnDeleteActivity() API().

protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteConversationMember(ClaimsIdentity claimsIdentity, String conversationId, String memberId)

ElimineAPIMember() de Conversation para Skill.

protected java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

EnApi ObteneractividadMembers().

protected java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

ObtengaAPI DeMiembros de conversación () para Skill.

protected java.util.concurrent.CompletableFuture<PagedMembersResult> onGetConversationPagedMembers(ClaimsIdentity claimsIdentity, String conversationId, Integer pageSize, String continuationToken)

ObtengaAPIMiembros paginados depara aptitud.

protected java.util.concurrent.CompletableFuture<ConversationsResult> onGetConversations(ClaimsIdentity claimsIdentity, String conversationId, String continuationToken)

EnAPI GetConversations() para Skill.

protected java.util.concurrent.CompletableFuture<ResourceResponse> onReplyToActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

EnAPI ToActivity().

protected java.util.concurrent.CompletableFuture<ResourceResponse> onSendConversationHistory(ClaimsIdentity claimsIdentity, String conversationId, Transcript transcript)

EnvíeAPI Historial de conversaciones() para aptitud.

protected java.util.concurrent.CompletableFuture<ResourceResponse> onSendToConversation(ClaimsIdentity claimsIdentity, String conversationId, Activity activity)

EnvíeAPI ToConversation() para Skill.

protected java.util.concurrent.CompletableFuture<ResourceResponse> onUpdateActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

EnUpdateActivity() API().

protected java.util.concurrent.CompletableFuture<ResourceResponse> onUploadAttachment(ClaimsIdentity claimsIdentity, String conversationId, AttachmentData attachmentUpload)

CargueAPI Attachment().

Métodos heredados 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

Detalles del constructor

ChannelServiceHandler

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

Inicializa una nueva instancia de la clase ChannelServiceHandler mediante un proveedor de credenciales.

Parámetros:

credentialProvider - Proveedor de credenciales.
authConfiguration - Configuración de autenticación.
channelProvider - Proveedor del canal.

Detalles del método

getChannelProvider

protected ChannelProvider getChannelProvider()

Obtiene el proveedor de canales que implementa ChannelProvider .

Devoluciones:

el valor ChannelProvider como getChannelProvider().

handleCreateConversation

public CompletableFuture handleCreateConversation(String authHeader, ConversationParameters parameters)

Cree una nueva conversación.

Parámetros:

authHeader - Encabezado de autenticación.
parameters - Parámetros a partir de los que se va a crear la conversación.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleDeleteActivity

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

Elimina una actividad existente.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
activityId - Identificador de actividad.

Devoluciones:

Un CompletableFuture que representa el resultado de la operación asincrónica.

handleDeleteConversationMember

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

Elimina un miembro de una conversación.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
memberId - Identificador del miembro que se va a eliminar de esta conversación.

Devoluciones:

Un CompletableFuture que representa la operación asincrónica.

handleGetActivityMembers

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

Enumera los miembros de una actividad.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
activityId - Identificador de actividad.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleGetConversationMembers

public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)

Enumera los miembros de una conversación.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleGetConversationPagedMembers

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

Enumera los miembros de una conversación una página a la vez.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
pageSize - Tamaño de página sugerido.
continuationToken - Token de continuación.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleGetConversations

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

Enumera las conversaciones en las que ha participado el bot.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
continuationToken - Un token de omisión o continuación.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleReplyToActivity

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

Envía una respuesta a una actividad.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
activityId - Identificador de actividad al que se va a responder.
activity - Actividad que se va a enviar.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleSendConversationHistory

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

Carga las actividades históricas de la conversación.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
transcript - Transcripción de actividades.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleSendToConversation

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

Envía una actividad al final de una conversación.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
activity - Actividad que se va a enviar.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleUpdateActivity

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

Edita una actividad existente enviada previamente.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
activityId - Identificador de actividad que se va a actualizar.
activity - Actividad de reemplazo.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

handleUploadAttachment

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

Almacena datos en un almacén compatible cuando se trabaja con empresas.

Parámetros:

authHeader - Encabezado de autenticación.
conversationId - Identificador de conversación.
attachmentUpload - Datos adjuntos.

Devoluciones:

{@link CompletableFuture{TResult}} que representa el resultado de la operación asincrónica.

onCreateConversation

protected CompletableFuture onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

CreateConversation() API. Invalide este método para crear una nueva conversación. POST para este método con un * Bot que es el bot que crea la conversación * IsGroup se establece en true si no es un mensaje directo (instancia predeterminada de false) * Matriz que contiene los miembros que se van a incluir en la conversación El valor devuelto es un ResourceResponse que contiene una conversación D que es adecuada para su uso en la carga del mensaje y los URI de la API REST. La mayoría de los canales solo admiten la semántica de los bots que inician una conversación de mensaje directo. Un ejemplo de cómo hacerlo sería: var resource = connector.getconversations(). CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); connect.getConversations(). OnSendToConversation(resource.getId(), new Activity() ... ) ; fin.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
parameters - Parámetros a partir de los que se va a crear la conversación.

Devoluciones:

tarea para una respuesta de recursos de conversación.

onDeleteActivity

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

API OnDeleteActivity(). Invalide este método para eliminar una actividad existente. Algunos canales permiten eliminar una actividad existente y, si se ejecuta correctamente, este método quitará la actividad especificada.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
activityId - activityId que se va a eliminar.

Devoluciones:

tarea para una respuesta de recursos.

onDeleteConversationMember

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

API DeleteConversationMember() para Skill. Invalide este método para eliminar un miembro de una conversación. Esta API REST toma conversationId y un memberId (de tipo String) y quita ese miembro de la conversación. Si ese miembro era el último miembro de la conversación, la conversación también se eliminará.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
memberId - D del miembro que se va a eliminar de esta conversación.

Devoluciones:

tarea.

onGetActivityMembers

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

API OnGetActivityMembers(). Invalide este método para enumerar los miembros de una actividad. Esta API REST toma conversationId y activityId, y devuelve una matriz de objetos ChannelAccount que representan los miembros de la actividad concreta de la conversación.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
activityId - Actividad D.

Devoluciones:

tarea con el resultado.

onGetConversationMembers

protected CompletableFuture> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

API GetConversationMembers() para Skill. Invalide este método para enumerar los miembros de una conversación. Esta API REST toma conversationId y devuelve una matriz de objetos ChannelAccount que representan los miembros de la conversación.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.

Devoluciones:

tarea para una respuesta.

onGetConversationPagedMembers

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

API GetConversationPagedMembers() para Skill. Invalide este método para enumerar los miembros de una conversación una página a la vez. Esta API REST toma un ConversationId. Opcionalmente, se puede proporcionar pageSize o continuationToken. Devuelve un PagedMembersResult, que contiene una matriz de ChannelAccounts que representa los miembros de la conversación y un token de continuación que se puede usar para obtener más valores. Se devuelve una página de los registros ChannelAccounts con cada llamada. El número de registros de una página puede variar entre canales y llamadas. El parámetro pageSize se puede usar como sugerencia. Si no hay ningún resultado adicional, la respuesta no contendrá un token de continuación. Si no hay miembros en la conversación, los miembros estarán vacíos o no estarán presentes en la respuesta. Una respuesta a una solicitud que tiene un token de continuación de una solicitud anterior rara vez puede devolver miembros de una solicitud anterior.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
pageSize - Tamaño de página sugerido.
continuationToken - Token de continuación.

Devoluciones:

tarea para una respuesta.

onGetConversations

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

API OnGetConversations() para Skill. Invalide este método para enumerar las conversaciones en las que ha participado este bot. GET de este método con un token de omisión El valor devuelto es conversationsResult, que contiene una matriz de ConversationMembers y un token de omisión. Si el token de omisión no está vacío, se devolverán otros valores. Vuelva a llamar a este método con el token devuelto para obtener más valores. Cada objeto ConversationMembers contiene la D de la conversación y una matriz de ChannelAccounts que describen los miembros de la conversación.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - conversationId.
continuationToken - skip o el token de continuación.

Devoluciones:

task para ConversationsResult.

onReplyToActivity

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

API OnReplyToActivity(). Invalidar este método permite responder a una actividad. Esto es ligeramente diferente de SendToConversation(). * SendToConversation(conversationId): anexará la actividad al final de la conversación según la marca de tiempo o la semántica del canal. * ReplyToActivity(conversationId,ActivityId): agrega la actividad como respuesta a otra actividad, si el canal lo admite. Si el canal no admite respuestas anidadas, ReplyToActivity vuelve a SendToConversation. Use ReplyToActivity al responder a una actividad específica de la conversación. Use SendToConversation en todos los demás casos.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
activityId - activityId a la respuesta es a (OPTONAL).
activity - Actividad que se va a enviar.

Devoluciones:

tarea para una respuesta de recursos.

onSendConversationHistory

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

API SendConversationHistory() para Skill. Invalidar este método en este método permite cargar las actividades históricas en la conversación. El remitente debe asegurarse de que las actividades históricas tengan identificadores únicos y marcas de tiempo adecuadas. El cliente usa los identificadores para tratar las actividades duplicadas y el cliente usa las marcas de tiempo para representar las actividades en el orden correcto.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
transcript - Transcripción de actividades.

Devoluciones:

tarea para una respuesta de recursos.

onSendToConversation

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

API SendToConversation() para Skill. Este método permite enviar una actividad al final de una conversación. Esto es ligeramente diferente de ReplyToActivity(). * SendToConversation(conversationId): anexará la actividad al final de la conversación según la marca de tiempo o la semántica del canal. * ReplyToActivity(conversationId,ActivityId): agrega la actividad como respuesta a otra actividad, si el canal lo admite. Si el canal no admite respuestas anidadas, ReplyToActivity vuelve a SendToConversation. Use ReplyToActivity al responder a una actividad específica de la conversación. Use SendToConversation en todos los demás casos.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - conversationId.
activity - Actividad que se va a enviar.

Devoluciones:

tarea para una respuesta de recursos.

onUpdateActivity

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

API OnUpdateActivity(). Invalide este método para editar una actividad existente enviada previamente. Algunos canales permiten editar una actividad existente para reflejar el nuevo estado de una conversación de bot. Por ejemplo, puede quitar botones después de que alguien haya clic en el botón "Aprobar".

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
activityId - activityId que se va a actualizar.
activity - actividad de reemplazo.

Devoluciones:

tarea para una respuesta de recursos.

onUploadAttachment

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

UploadAttachment() API. Invalide este método para almacenar datos en un almacén compatible al trabajar con empresas. La respuesta es un ResourceResponse que contiene un AttachmentId que es adecuado para su uso con la API de datos adjuntos.

Parámetros:

claimsIdentity - claimsIdentity para el bot, debe tener AudienceClaim, AppIdClaim y ServiceUrlClaim.
conversationId - Conversación D.
attachmentUpload - Datos adjuntos.

Devoluciones:

tarea con el resultado.

Se aplica a