Conversations Interface

public interface Conversations

Une instance de cette classe fournit l’accès à toutes les opérations définies dans Conversations.

Résumé de la méthode

Modificateur et type Méthode et description
abstract java.util.concurrent.CompletableFuture<ConversationResourceResponse> createConversation(ConversationParameters parameters)

Créezconversation.

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String conversationId, String activityId)

Supprimezactivité.

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

Supprimezmembre de conversation.

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

Obtenezmembres de l’activité.

abstract java.util.concurrent.CompletableFuture<ChannelAccount> getConversationMember(String userId, String conversationId)

Récupère un seul membre d’une conversation par ID.

abstract java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getConversationMembers(String conversationId)

Obtenezmembres de conversation.

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

Énumérez les membres d’une conversation d’une page à la fois.

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

Énumérez les membres d’une conversation d’une page à la fois.

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

Obtenezconversations.

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

Obtenezconversations.

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

RépondreToActivity.

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

RépondreToActivity.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendConversationHistory(String conversationId, Transcript history)

Cette méthode vous permet de charger les activités historiques dans la conversation.

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

EnvoyezToConversation.

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

EnvoyezToConversation.

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

Mettez à jouractivité.

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

Mettez à jouractivité.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> uploadAttachment(String conversationId, AttachmentData attachmentUpload)

Chargezpièce jointe.

Détails de la méthode

createConversation

public abstract CompletableFuture createConversation(ConversationParameters parameters)

CreateConversation. Créez une conversation. POST vers cette méthode avec un bot en cours de création de la conversation IsGroup définie sur true si ce n’est pas un message direct (valeur par défaut est false) Le tableau membres continuant les membres que vous souhaitez avoir dans la conversation. La valeur de retour est ResourceResponse qui contient un ID de conversation qui convient pour une utilisation dans la charge utile du message et les URI de l’API REST. La plupart des canaux prennent uniquement en charge la sémantique des bots qui lancent une conversation de message direct. Exemple de procédure à suivre : ''' var resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount(« user1 ») } ) ; await connect. Conversations.SendToConversation(ressource). ID, new Activity() ... ) ; ```

Paramètres:

parameters - Paramètres à partir duquel créer la conversation

Retours:

observable à l’objet ConversationResourceResponse

deleteActivity

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity. Supprimez une activité existante. Certains canaux vous permettent de supprimer une activité existante, et si cette méthode réussit, elle supprime l’activité spécifiée.

Paramètres:

conversationId - Conversation ID
activityId - activityId à supprimer

Retours:

l’objet ServiceResponse<T> en cas de réussite.

deleteConversationMember

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember. Supprime un membre d’une conversation. Cette API REST prend un ConversationId et un memberId (de type chaîne) et supprime ce membre de la conversation. Si ce membre était le dernier membre de la conversation, la conversation sera également supprimée.

Paramètres:

conversationId - Conversation ID
memberId - ID du membre à supprimer de cette conversation

Retours:

l’objet ServiceResponse<T> en cas de réussite.

getActivityMembers

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

GetActivityMembers. Énumérez les membres d’une activité. Cette API REST prend un Id de conversation et un ActivityId, retournant un tableau d’objets ChannelAccount représentant les membres de l’activité particulière dans la conversation.

Paramètres:

conversationId - Conversation ID
activityId - ID d’activité

Retours:

observable à l’objet List<ChannelAccount>

getConversationMember

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

Récupère un seul membre d’une conversation par ID.

Paramètres:

userId - ID d’utilisateur.
conversationId - ID de conversation.

Retours:

ChannelAccount pour l’utilisateur.

getConversationMembers

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers. Énumérez les membres d’une converstion. Cette API REST prend un ConversationId et retourne un tableau d’objets ChannelAccount représentant les membres de la conversation.

Paramètres:

conversationId - Conversation ID

Retours:

observable à l’objet List<ChannelAccount>

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

Énumérez les membres d’une conversation d’une page à la fois. Cette API REST prend un ConversationId. Vous pouvez éventuellement fournir une pageSize et/ou continuationToken. Elle retourne un PagedMembersResult, qui contient un tableau de ChannelAccounts représentant les membres de la conversation et un jeton de continuation qui peut être utilisé pour obtenir plus de valeurs. Une page d’enregistrements ChannelAccounts est retournée avec chaque appel. Le nombre d’enregistrements d’une page peut varier entre les canaux et les appels. S’il n’existe aucun résultat supplémentaire, la réponse ne contient pas de jeton de continuation. S’il n’y a aucun membre dans la conversation, les membres sont vides ou ne sont pas présents dans la réponse. Une réponse à une demande qui a un jeton de continuation d’une demande antérieure peut rarement renvoyer des membres d’une demande précédente.

Paramètres:

conversationId - Conversation ID

Retours:

l’objet PagedMembersResult en cas de réussite.

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

Énumérez les membres d’une conversation d’une page à la fois. Cette API REST prend un ConversationId. Vous pouvez éventuellement fournir une pageSize et/ou continuationToken. Elle retourne un PagedMembersResult, qui contient un tableau de ChannelAccounts représentant les membres de la conversation et un jeton de continuation qui peut être utilisé pour obtenir plus de valeurs. Une page d’enregistrements ChannelAccounts est retournée avec chaque appel. Le nombre d’enregistrements d’une page peut varier entre les canaux et les appels. S’il n’existe aucun résultat supplémentaire, la réponse ne contient pas de jeton de continuation. S’il n’y a aucun membre dans la conversation, les membres sont vides ou ne sont pas présents dans la réponse. Une réponse à une demande qui a un jeton de continuation d’une demande antérieure peut rarement renvoyer des membres d’une demande précédente.

Paramètres:

conversationId - Conversation ID
continuationToken - ContinuationToken à partir d’un appel précédent.

Retours:

l’objet PagedMembersResult en cas de réussite.

getConversations

public abstract CompletableFuture getConversations()

GetConversations. Répertoriez les conversations dans lesquelles ce bot a participé. GET à partir de cette méthode avec un jeton d’ignorer La valeur de retour est conversationsResult, qui contient un tableau de ConversationMembers et un jeton d’ignorer. Si le jeton skip n’est pas vide, il existe d’autres valeurs à retourner. Appelez à nouveau cette méthode avec le jeton retourné pour obtenir plus de valeurs. Chaque objet ConversationMembers contient l’ID de la conversation et un tableau de ChannelAccounts qui décrivent les membres de la conversation.

Retours:

observable à l’objet ConversationsResult

getConversations

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations. Répertoriez les conversations dans lesquelles ce bot a participé. GET à partir de cette méthode avec un jeton d’ignorer La valeur de retour est conversationsResult, qui contient un tableau de ConversationMembers et un jeton d’ignorer. Si le jeton skip n’est pas vide, il existe d’autres valeurs à retourner. Appelez à nouveau cette méthode avec le jeton retourné pour obtenir plus de valeurs. Chaque objet ConversationMembers contient l’ID de la conversation et un tableau de ChannelAccounts qui décrivent les membres de la conversation.

Paramètres:

continuationToken - ignorer ou poursuivre le jeton

Retours:

observable à l’objet ConversationsResult

replyToActivity

public default CompletableFuture replyToActivity(Activity activity)

ReplyToActivity. Cette méthode vous permet de répondre à une activité. Ceci est légèrement différent de SendToConversation(). SendToConversation(conversationId) : ajoute l’activité à la fin de la conversation en fonction de l’horodatage ou de la sémantique du canal. ReplyToActivity(conversationId,ActivityId) : ajoute l’activité en tant que réponse à une autre activité, si le canal le prend en charge. Si le canal ne prend pas en charge les réponses imbriquées, ReplyToActivity revient à SendToConversation. Utilisez ReplyToActivity lors de la réponse à une activité spécifique dans la conversation. Utilisez SendToConversation dans tous les autres cas.

Paramètres:

activity - Activité à envoyer

Retours:

observable à l’objet ResourceResponse

replyToActivity

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

ReplyToActivity. Cette méthode vous permet de répondre à une activité. Ceci est légèrement différent de SendToConversation(). SendToConversation(conversationId) : ajoute l’activité à la fin de la conversation en fonction de l’horodatage ou de la sémantique du canal. ReplyToActivity(conversationId,ActivityId) : ajoute l’activité en tant que réponse à une autre activité, si le canal le prend en charge. Si le canal ne prend pas en charge les réponses imbriquées, ReplyToActivity revient à SendToConversation. Utilisez ReplyToActivity lors de la réponse à une activité spécifique dans la conversation. Utilisez SendToConversation dans tous les autres cas.

Paramètres:

conversationId - Conversation ID
activityId - activityId la réponse est à (FACULTATIF)
activity - Activité à envoyer

Retours:

observable à l’objet ResourceResponse

sendConversationHistory

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

Cette méthode vous permet de charger les activités historiques dans la conversation. L’expéditeur doit s’assurer que les activités historiques ont des ID uniques et des horodatages appropriés. Les ID sont utilisés par le client pour traiter les activités en double et les horodatages sont utilisés par le client pour afficher les activités dans l’ordre approprié.

Paramètres:

conversationId - Conversation ID
history - Activités historiques

Retours:

l’objet ResourceResponse en cas de réussite.

sendToConversation

public default CompletableFuture sendToConversation(Activity activity)

SendToConversation. Cette méthode vous permet d’envoyer une activité à la fin d’une conversation. Ceci est légèrement différent de ReplyToActivity(). sendToConverstion(activity) : ajoute l’activité à la fin de la conversation en fonction de l’horodatage ou de la sémantique du canal, à l’aide de Activity.getConversation.getId pour l’ID de conversation. replyToActivity(conversationId,ActivityId) - ajoute l’activité en tant que réponse à une autre activité, si le canal le prend en charge. Si le canal ne prend pas en charge les réponses imbriquées, ReplyToActivity revient à SendToConversation. Utilisez ReplyToActivity lors de la réponse à une activité spécifique dans la conversation. Utilisez SendToConversation dans tous les autres cas.

Paramètres:

activity - Activité à envoyer

Retours:

observable à l’objet ResourceResponse

sendToConversation

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

SendToConversation. Cette méthode vous permet d’envoyer une activité à la fin d’une conversation. Ceci est légèrement différent de ReplyToActivity(). SendToConverstion(conversationId) : ajoute l’activité à la fin de la conversation en fonction de l’horodatage ou de la sémantique du canal. ReplyToActivity(conversationId,ActivityId) : ajoute l’activité en tant que réponse à une autre activité, si le canal le prend en charge. Si le canal ne prend pas en charge les réponses imbriquées, ReplyToActivity revient à SendToConversation. Utilisez ReplyToActivity lors de la réponse à une activité spécifique dans la conversation. Utilisez SendToConversation dans tous les autres cas.

Paramètres:

conversationId - Conversation ID
activity - Activité à envoyer

Retours:

observable à l’objet ResourceResponse

updateActivity

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity. Modifiez une activité existante. Certains canaux vous permettent de modifier une activité existante pour refléter le nouvel état d’une conversation de bot. Par exemple, vous pouvez supprimer des boutons une fois que quelqu’un a cliqué sur le bouton Approuver.

Paramètres:

activity - activité de remplacement

Retours:

observable à l’objet ResourceResponse

updateActivity

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

UpdateActivity. Modifiez une activité existante. Certains canaux vous permettent de modifier une activité existante pour refléter le nouvel état d’une conversation de bot. Par exemple, vous pouvez supprimer des boutons une fois que quelqu’un a cliqué sur le bouton Approuver.

Paramètres:

conversationId - Conversation ID
activityId - activityId à mettre à jour
activity - activité de remplacement

Retours:

observable à l’objet ResourceResponse

uploadAttachment

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment. Chargez une pièce jointe directement dans le stockage d’objets blob d’un canal. Cela est utile, car il vous permet de stocker des données dans un magasin conforme lors de la gestion des entreprises. La réponse est un ResourceResponse qui contient un AttachmentId qui convient à l’utilisation avec l’API pièces jointes.

Paramètres:

conversationId - Conversation ID
attachmentUpload - Données de pièce jointe

Retours:

observable à l’objet ResourceResponse

S’applique à