ChannelServiceHandler Classe

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

public class ChannelServiceHandler

Classe pour faciliter l’implémentation du protocole Bot Framework.

Récapitulatif du constructeur

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

Initialise une nouvelle instance de la classe ChannelServiceHandler à l’aide d’un fournisseur d’informations d’identification.

Résumé de la méthode

Modificateur et type Méthode et description
protected ChannelProvider getChannelProvider()

Obtient le fournisseur de canaux qui implémente ChannelProvider .

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

Créez une conversation.

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

Supprime une activité existante.

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

Supprime un membre d’une conversation.

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

Énumère les membres d’une activité.

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

Énumère les membres d’une conversation.

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

Énumère les membres d’une conversation d’une page à la fois.

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

Répertorie les conversations dans lesquelles le bot a participé.

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

Envoie une réponse à une activité.

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

Charge les activités historiques de la conversation.

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

Envoie une activité à la fin d’une conversation.

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

Modifie une activité existante précédemment envoyée.

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

Stocke les données dans un magasin conforme lors de la gestion des entreprises.

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

CréezAPI Conversation().

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

Surl’API SupprimerActivity().

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

SupprimezAPI de membre de conversation() pour compétence.

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

SurAPI ObteniractivitéMembers().

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

Obtenez'APIMembres() de conversation pour compétence.

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

Obtenez'API conversationpaginéemembers() pour compétence.

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

SurObtenir l’APIConversations() pour compétence.

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

SurAPI RépondreToActivity().

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

Envoyez'API d’historique de conversation() pour compétence.

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

EnvoyezAPI ToConversation() pour Skill.

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

Sur l’APIUpdateActivity().

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

Chargez l’API Attachment().

Méthodes héritées 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

Détails du constructeur

ChannelServiceHandler

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

Initialise une nouvelle instance de la classe ChannelServiceHandler à l’aide d’un fournisseur d’informations d’identification.

Paramètres:

credentialProvider - Fournisseur d’informations d’identification.
authConfiguration - Configuration de l’authentification.
channelProvider - Fournisseur de canaux.

Détails de la méthode

getChannelProvider

protected ChannelProvider getChannelProvider()

Obtient le fournisseur de canaux qui implémente ChannelProvider .

Retours:

valeur ChannelProvider en tant que getChannelProvider().

handleCreateConversation

public CompletableFuture handleCreateConversation(String authHeader, ConversationParameters parameters)

Créez une conversation.

Paramètres:

authHeader - En-tête d’authentification.
parameters - Paramètres à partir duquel créer la conversation.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleDeleteActivity

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

Supprime une activité existante.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
activityId - ID d’activité.

Retours:

Un CompletableFuture représentant le résultat de l’opération asynchrone.

handleDeleteConversationMember

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

Supprime un membre d’une conversation.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
memberId - ID du membre à supprimer de cette conversation.

Retours:

Un CompletableFuture représentant l’opération asynchrone.

handleGetActivityMembers

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

Énumère les membres d’une activité.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
activityId - ID d’activité.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleGetConversationMembers

public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)

Énumère les membres d’une conversation.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleGetConversationPagedMembers

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

Énumère les membres d’une conversation d’une page à la fois.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
pageSize - Taille de page suggérée.
continuationToken - Jeton de continuation.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleGetConversations

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

Répertorie les conversations dans lesquelles le bot a participé.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
continuationToken - Un jeton d’ignorer ou de continuation.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleReplyToActivity

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

Envoie une réponse à une activité.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
activityId - L’ID d’activité auquel la réponse doit être répondue.
activity - Activité à envoyer.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleSendConversationHistory

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

Charge les activités historiques de la conversation.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
transcript - Transcription des activités.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleSendToConversation

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

Envoie une activité à la fin d’une conversation.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
activity - Activité à envoyer.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleUpdateActivity

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

Modifie une activité existante précédemment envoyée.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
activityId - ID d’activité à mettre à jour.
activity - Activité de remplacement.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

handleUploadAttachment

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

Stocke les données dans un magasin conforme lors de la gestion des entreprises.

Paramètres:

authHeader - En-tête d’authentification.
conversationId - ID de conversation.
attachmentUpload - Données de pièce jointe.

Retours:

{@link CompletableFuture{TResult}} représentant le résultat de l’opération asynchrone.

onCreateConversation

protected CompletableFuture onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

API CreateConversation(). Remplacez cette méthode pour créer une conversation. POST vers cette méthode avec un bot en cours de création de la conversation * IsGroup défini sur true si ce n’est pas un message direct (instance par défaut false) * Tableau contenant les membres à inclure dans la conversation La valeur de retour est une RessourceResponse qui contient une conversation D qui convient pour une utilisation dans la charge utile du message et les URI d’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 = connector.getconversations(). CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount(« user1 ») } ) ; connect.getConversations(). OnSendToConversation(resource.getId(), new Activity() ... ) ; fin.

Paramètres:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
parameters - Paramètres à partir duquel créer la conversation.

Retours:

tâche d’une réponse de ressource de conversation.

onDeleteActivity

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

API OnDeleteActivity(). Remplacez cette méthode pour supprimer 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
activityId - activityId à supprimer.

Retours:

tâche pour une réponse de ressource.

onDeleteConversationMember

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

API DeleteConversationMember() pour Skill. Remplacez cette méthode pour supprimer un membre d’une conversation. Cette API REST prend un ConversationId et un memberId (de type String) 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
memberId - D du membre à supprimer de cette conversation.

Retours:

tâche.

onGetActivityMembers

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

API OnGetActivityMembers(). Remplacez cette méthode pour énumérer les membres d’une activité. Cette API REST prend un ConversationId et un ActivityId, retournant un tableau d’objets ChannelAccount représentant les membres de l’activité particulière dans la conversation.

Paramètres:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
activityId - Activité D.

Retours:

tâche avec résultat.

onGetConversationMembers

protected CompletableFuture> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

API GetConversationMembers() pour Skill. Remplacez cette méthode pour énumérer les membres d’une conversation. Cette API REST prend un ConversationId et retourne un tableau d’objets ChannelAccount représentant les membres de la conversation.

Paramètres:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.

Retours:

tâche pour une réponse.

onGetConversationPagedMembers

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

API GetConversationPagedMembers() pour Skill. Remplacez cette méthode pour énumérer les membres d’une conversation 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. Le paramètre pageSize peut être utilisé comme suggestion. 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
pageSize - Taille de page suggérée.
continuationToken - Jeton de continuation.

Retours:

tâche pour une réponse.

onGetConversations

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

API OnGetConversations() pour Skill. Remplacez cette méthode pour répertorier 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 la D de la conversation et un tableau de ChannelAccounts qui décrivent les membres de la conversation.

Paramètres:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - conversationId.
continuationToken - ignorer ou poursuivre le jeton.

Retours:

tâche pour ConversationsResult.

onReplyToActivity

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

API OnReplyToActivity(). Remplacer cette méthode 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
activityId - activityId la réponse est à (OPTONAL).
activity - Activité à envoyer.

Retours:

tâche pour une réponse de ressource.

onSendConversationHistory

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

API SendConversationHistory() pour Skill. Remplacez cette méthode par cette méthode pour 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
transcript - Transcription des activités.

Retours:

tâche pour une réponse de ressource.

onSendToConversation

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

API SendToConversation() pour Skill. Cette méthode vous permet d’envoyer une activité à la fin d’une conversation. Ceci est légèrement différent de ReplyToActivity(). * 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - conversationId.
activity - Activité à envoyer.

Retours:

tâche pour une réponse de ressource.

onUpdateActivity

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

API OnUpdateActivity(). Remplacez cette méthode pour modifier une activité existante précédemment envoyée. 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
activityId - activityId à mettre à jour.
activity - activité de remplacement.

Retours:

tâche pour une réponse de ressource.

onUploadAttachment

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

API UploadAttachment(). Remplacez cette méthode pour 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:

claimsIdentity - claimsIdentity pour le bot doit avoir AudienceClaim, AppIdClaim et ServiceUrlClaim.
conversationId - Conversation D.
attachmentUpload - Données de pièce jointe.

Retours:

tâche avec résultat.

S’applique à