ChannelServiceHandler Classe
- java.
lang. Object - com.
microsoft. bot. builder. ChannelServiceHandler
- com.
public class ChannelServiceHandler
Classe per facilitare l'implementazione del protocollo Bot Framework.
Riepilogo dei costruttori
| Costruttore | Descrizione |
|---|---|
| ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider) |
Inizializza una nuova istanza della classe ChannelServiceHandler utilizzando un provider di credenziali. |
Riepilogo dei metodi
Metodi ereditati da java.lang.Object
Dettagli costruttore
ChannelServiceHandler
public ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)
Inizializza una nuova istanza della classe ChannelServiceHandler utilizzando un provider di credenziali.
Parametri:
Dettagli metodo
getChannelProvider
protected ChannelProvider getChannelProvider()
Ottiene il provider di canali che implementa ChannelProvider .
Restituisce:
handleCreateConversation
public CompletableFuture
Creare una nuova conversazione.
Parametri:
Restituisce:
handleDeleteActivity
public CompletableFuture
Elimina un'attività esistente.
Parametri:
Restituisce:
handleDeleteConversationMember
public CompletableFuture
Elimina un membro da una conversazione.
Parametri:
Restituisce:
handleGetActivityMembers
public CompletableFuture> handleGetActivityMembers(String authHeader, String conversationId, String activityId)
Enumera i membri di un'attività.
Parametri:
Restituisce:
handleGetConversationMembers
public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)
Enumera i membri di una conversazione.
Parametri:
Restituisce:
handleGetConversationPagedMembers
public CompletableFuture
Enumera i membri di una conversazione una pagina alla volta.
Parametri:
Restituisce:
handleGetConversations
public CompletableFuture
Elenca le conversazioni in cui il bot ha partecipato.
Parametri:
Restituisce:
handleReplyToActivity
public CompletableFuture
Invia una risposta a un'attività.
Parametri:
Restituisce:
handleSendConversationHistory
public CompletableFuture
Carica le attività storiche della conversazione.
Parametri:
Restituisce:
handleSendToConversation
public CompletableFuture
Invia un'attività alla fine di una conversazione.
Parametri:
Restituisce:
handleUpdateActivity
public CompletableFuture
Modifica un'attività esistente inviata in precedenza.
Parametri:
Restituisce:
handleUploadAttachment
public CompletableFuture
Archivia i dati in un archivio conforme quando si gestiscono le aziende.
Parametri:
Restituisce:
onCreateConversation
protected CompletableFuture
API CreateConversation(). Eseguire l'override di questo metodo per creare una nuova conversazione. POST per questo metodo con un bot * Bot che crea la conversazione * IsGroup impostato su true se questo non è un messaggio diretto (istanza predefinita di false) * Matrice contenente i membri da includere nella conversazione Il valore restituito è un ResourceResponse che contiene una conversazione D che è adatta per l'uso nel payload del messaggio e negli URI dell'API REST. La maggior parte dei canali supporta solo la semantica dei bot che avviano una conversazione diretta dei messaggi. Un esempio di come eseguire questa operazione è: var resource = connector.getconversations(). CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); connect.getConversations(). OnSendToConversation(resource.getId(), new Activity() ... ) ; fine.
Parametri:
Restituisce:
onDeleteActivity
protected CompletableFuture
API OnDeleteActivity(). Eseguire l'override di questo metodo per eliminare un'attività esistente. Alcuni canali consentono di eliminare un'attività esistente e, in caso di esito positivo, questo metodo rimuoverà l'attività specificata.
Parametri:
Restituisce:
onDeleteConversationMember
protected CompletableFuture
API DeleteConversationMember() per Skill. Eseguire l'override di questo metodo per eliminare un membro da una conversazione. Questa API REST accetta conversationId e un memberId (di tipo String) e rimuove tale membro dalla conversazione. Se tale membro è l'ultimo membro della conversazione, verrà eliminata anche la conversazione.
Parametri:
Restituisce:
onGetActivityMembers
protected CompletableFuture> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)
API OnGetActivityMembers(). Eseguire l'override di questo metodo per enumerare i membri di un'attività. Questa API REST accetta un ConversationId e un ActivityId, restituendo una matrice di oggetti ChannelAccount che rappresentano i membri della particolare attività nella conversazione.
Parametri:
Restituisce:
onGetConversationMembers
protected CompletableFuture> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)
API GetConversationMembers() per Skill. Eseguire l'override di questo metodo per enumerare i membri di una conversazione. Questa API REST accetta un ConversationId e restituisce una matrice di oggetti ChannelAccount che rappresentano i membri della conversazione.
Parametri:
Restituisce:
onGetConversationPagedMembers
protected CompletableFuture
API GetConversationPagedMembers() per Skill. Eseguire l'override di questo metodo per enumerare i membri di una conversazione una pagina alla volta. Questa API REST accetta un ConversationId. Facoltativamente, è possibile specificare pageSize e/o continuationToken. Restituisce un valore PagedMembersResult, che contiene una matrice di ChannelAccounts che rappresenta i membri della conversazione e un token di continuazione che può essere usato per ottenere più valori. Ogni chiamata restituisce una pagina di record ChannelAccounts. Il numero di record in una pagina può variare tra canali e chiamate. Il parametro pageSize può essere usato come suggerimento. Se non sono presenti risultati aggiuntivi, la risposta non conterrà un token di continuazione. Se nella conversazione non sono presenti membri, i membri saranno vuoti o non presenti nella risposta. Una risposta a una richiesta con un token di continuazione da una richiesta precedente può restituire raramente membri da una richiesta precedente.
Parametri:
Restituisce:
onGetConversations
protected CompletableFuture
API OnGetConversations() per skill. Eseguire l'override di questo metodo per elencare le conversazioni in cui ha partecipato questo bot. GET da questo metodo con un token skip Il valore restituito è ConversationResult, che contiene una matrice di ConversationMembers e un token skip. Se il token skip non è vuoto, sono disponibili altri valori da restituire. Chiamare di nuovo questo metodo con il token restituito per ottenere altri valori. Ogni oggetto ConversationMembers contiene la D della conversazione e una matrice di ChannelAccounts che descrivono i membri della conversazione.
Parametri:
Restituisce:
onReplyToActivity
protected CompletableFuture
API OnReplyToActivity(). Eseguire l'override di questo metodo consente di rispondere a un'attività. Questo è leggermente diverso da SendToConversation(). * SendToConversation(conversationId): aggiungerà l'attività alla fine della conversazione in base al timestamp o alla semantica del canale. * ReplyToActivity(conversationId,ActivityId): aggiunge l'attività come risposta a un'altra attività, se il canale lo supporta. Se il canale non supporta le risposte annidate, ReplyToActivity esegue il fallback a SendToConversation. Usare ReplyToActivity quando si risponde a un'attività specifica nella conversazione. Usare SendToConversation in tutti gli altri casi.
Parametri:
Restituisce:
onSendConversationHistory
protected CompletableFuture
API SendConversationHistory() per skill. Eseguire l'override di questo metodo a questo metodo consente di caricare le attività cronologie nella conversazione. Il mittente deve assicurarsi che le attività cronologiche abbiano ID univoci e timestamp appropriati. Gli ID vengono usati dal client per gestire le attività duplicate e i timestamp vengono usati dal client per eseguire il rendering delle attività nell'ordine corretto.
Parametri:
Restituisce:
onSendToConversation
protected CompletableFuture
API SendToConversation() per competenza. Questo metodo consente di inviare un'attività alla fine di una conversazione. Questo è leggermente diverso da ReplyToActivity(). * SendToConversation(conversationId): aggiungerà l'attività alla fine della conversazione in base al timestamp o alla semantica del canale. * ReplyToActivity(conversationId,ActivityId): aggiunge l'attività come risposta a un'altra attività, se il canale lo supporta. Se il canale non supporta le risposte annidate, ReplyToActivity esegue il fallback a SendToConversation. Usare ReplyToActivity quando si risponde a un'attività specifica nella conversazione. Usare SendToConversation in tutti gli altri casi.
Parametri:
Restituisce:
onUpdateActivity
protected CompletableFuture
API OnUpdateActivity(). Eseguire l'override di questo metodo per modificare un'attività esistente inviata in precedenza. Alcuni canali consentono di modificare un'attività esistente per riflettere il nuovo stato di una conversazione bot. Ad esempio, è possibile rimuovere i pulsanti dopo che un utente ha fatto clic sul pulsante "Approva".
Parametri:
Restituisce:
onUploadAttachment
protected CompletableFuture
API UploadAttachment(). Eseguire l'override di questo metodo per archiviare i dati in un archivio conforme quando si gestiscono le aziende. La risposta è un oggetto ResourceResponse che contiene un AttachmentId adatto per l'uso con l'API allegati.
Parametri:
Restituisce: