Conversations Interfaz
public interface Conversations
Una instancia de esta clase proporciona acceso a todas las operaciones definidas en Conversaciones.
Resumen del método
| Modificador y tipo | Método y descripción |
|---|---|
|
abstract
java.util.concurrent.CompletableFuture<Conversation |
createConversation(ConversationParameters parameters)
Crear |
| abstract java.util.concurrent.CompletableFuture<java.lang.Void> |
deleteActivity(String conversationId, String activityId)
Eliminar |
| abstract java.util.concurrent.CompletableFuture<java.lang.Void> |
deleteConversationMember(String conversationId, String memberId)
Elimine |
|
abstract
java.util.concurrent.CompletableFuture<java.util.List<Channel |
getActivityMembers(String conversationId, String activityId)
Obtenga |
|
abstract
java.util.concurrent.CompletableFuture<Channel |
getConversationMember(String userId, String conversationId)
Recupera un único miembro de una conversación por identificador. |
|
abstract
java.util.concurrent.CompletableFuture<java.util.List<Channel |
getConversationMembers(String conversationId)
Obtenga |
|
abstract
java.util.concurrent.CompletableFuture<Paged |
getConversationPagedMembers(String conversationId)
Enumerar los miembros de una conversación una página a la vez. |
|
abstract
java.util.concurrent.CompletableFuture<Paged |
getConversationPagedMembers(String conversationId, String continuationToken)
Enumerar los miembros de una conversación una página a la vez. |
|
abstract
java.util.concurrent.CompletableFuture<Conversations |
getConversations()
Obtenga |
|
abstract
java.util.concurrent.CompletableFuture<Conversations |
getConversations(String continuationToken)
Obtenga |
|
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)
Este método permite cargar las actividades históricas en la conversación. |
|
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)
Actualizar |
|
abstract
java.util.concurrent.CompletableFuture<Resource |
updateActivity(String conversationId, String activityId, Activity activity)
Actualizar |
|
abstract
java.util.concurrent.CompletableFuture<Resource |
uploadAttachment(String conversationId, AttachmentData attachmentUpload)
Cargue |
Detalles del método
createConversation
public abstract CompletableFuture
CreateConversation. Cree una nueva conversación. POST para este método con un bot que es el bot que crea la conversación IsGroup establecida en true si no es un mensaje directo (el valor predeterminado es false) Matriz de miembros que continúe a los miembros que desea tener en la conversación. El valor devuelto es un ResourceResponse que contiene un identificador de conversación que es adecuado 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 = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); await connect. Conversations.SendToConversation(resource. Id, new Activity() ... ) ; ```
Parámetros:
Devoluciones:
deleteActivity
public abstract CompletableFuture
DeleteActivity. Elimine una actividad existente. Algunos canales permiten eliminar una actividad existente y, si se ejecuta correctamente, este método quitará la actividad especificada.
Parámetros:
Devoluciones:
deleteConversationMember
public abstract CompletableFuture
DeleteConversationMember. Elimina un miembro de una conversación. Esta API rest toma conversationId y memberId (de tipo cadena) 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:
Devoluciones:
getActivityMembers
public abstract CompletableFuture> getActivityMembers(String conversationId, String activityId)
GetActivityMembers. 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:
Devoluciones:
getConversationMember
public abstract CompletableFuture
Recupera un único miembro de una conversación por identificador.
Parámetros:
Devoluciones:
getConversationMembers
public abstract CompletableFuture> getConversationMembers(String conversationId)
GetConversationMembers. Enumerar los miembros de una converstion. Esta API REST toma un ConversationId y devuelve una matriz de objetos ChannelAccount que representan los miembros de la conversación.
Parámetros:
Devoluciones:
getConversationPagedMembers
public abstract CompletableFuture
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. 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:
Devoluciones:
getConversationPagedMembers
public abstract CompletableFuture
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. 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:
Devoluciones:
getConversations
public abstract CompletableFuture
GetConversations. Enumere 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 el identificador de la conversación y una matriz de ChannelAccounts que describen los miembros de la conversación.
Devoluciones:
getConversations
public abstract CompletableFuture
GetConversations. Enumere 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 el identificador de la conversación y una matriz de ChannelAccounts que describen los miembros de la conversación.
Parámetros:
Devoluciones:
replyToActivity
public default CompletableFuture
ReplyToActivity. 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:
Devoluciones:
replyToActivity
public abstract CompletableFuture
ReplyToActivity. 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:
Devoluciones:
sendConversationHistory
public abstract CompletableFuture
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:
Devoluciones:
sendToConversation
public default CompletableFuture
SendToConversation. Este método permite enviar una actividad al final de una conversación. Esto es ligeramente diferente de ReplyToActivity(). sendToConverstion(activity): anexará la actividad al final de la conversación según la marca de tiempo o la semántica del canal, mediante Activity.getConversation.getId para el identificador de conversación. 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:
Devoluciones:
sendToConversation
public abstract CompletableFuture
SendToConversation. Este método permite enviar una actividad al final de una conversación. Esto es ligeramente diferente de ReplyToActivity(). SendToConverstion(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:
Devoluciones:
updateActivity
public default CompletableFuture
UpdateActivity. Edite una actividad existente. 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:
Devoluciones:
updateActivity
public abstract CompletableFuture
UpdateActivity. Edite una actividad existente. 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:
Devoluciones:
uploadAttachment
public abstract CompletableFuture
UploadAttachment. Cargue datos adjuntos directamente en el almacenamiento de blobs de un canal. Esto es útil porque permite almacenar datos en un almacén compatible cuando se trabaja 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:
Devoluciones: