ChannelServiceHandler Classe
- java.
lang. Object - com.
microsoft. bot. builder. ChannelServiceHandler
- com.
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
Méthodes héritées de java.lang.Object
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:
Détails de la méthode
getChannelProvider
protected ChannelProvider getChannelProvider()
Obtient le fournisseur de canaux qui implémente ChannelProvider .
Retours:
handleCreateConversation
public CompletableFuture
Créez une conversation.
Paramètres:
Retours:
handleDeleteActivity
public CompletableFuture
Supprime une activité existante.
Paramètres:
Retours:
handleDeleteConversationMember
public CompletableFuture
Supprime un membre d’une conversation.
Paramètres:
Retours:
handleGetActivityMembers
public CompletableFuture> handleGetActivityMembers(String authHeader, String conversationId, String activityId)
Énumère les membres d’une activité.
Paramètres:
Retours:
handleGetConversationMembers
public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)
Énumère les membres d’une conversation.
Paramètres:
Retours:
handleGetConversationPagedMembers
public CompletableFuture
Énumère les membres d’une conversation d’une page à la fois.
Paramètres:
Retours:
handleGetConversations
public CompletableFuture
Répertorie les conversations dans lesquelles le bot a participé.
Paramètres:
Retours:
handleReplyToActivity
public CompletableFuture
Envoie une réponse à une activité.
Paramètres:
Retours:
handleSendConversationHistory
public CompletableFuture
Charge les activités historiques de la conversation.
Paramètres:
Retours:
handleSendToConversation
public CompletableFuture
Envoie une activité à la fin d’une conversation.
Paramètres:
Retours:
handleUpdateActivity
public CompletableFuture
Modifie une activité existante précédemment envoyée.
Paramètres:
Retours:
handleUploadAttachment
public CompletableFuture
Stocke les données dans un magasin conforme lors de la gestion des entreprises.
Paramètres:
Retours:
onCreateConversation
protected CompletableFuture
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:
Retours:
onDeleteActivity
protected CompletableFuture
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:
Retours:
onDeleteConversationMember
protected CompletableFuture
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:
Retours:
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:
Retours:
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:
Retours:
onGetConversationPagedMembers
protected CompletableFuture
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:
Retours:
onGetConversations
protected CompletableFuture
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:
Retours:
onReplyToActivity
protected CompletableFuture
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:
Retours:
onSendConversationHistory
protected CompletableFuture
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:
Retours:
onSendToConversation
protected CompletableFuture
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:
Retours:
onUpdateActivity
protected CompletableFuture
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:
Retours:
onUploadAttachment
protected CompletableFuture
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:
Retours: