ChannelServiceHandler Classe

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

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

Modificatore e tipo Metodo e descrizione
protected ChannelProvider getChannelProvider()

Ottiene il provider di canali che implementa ChannelProvider .

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

Creare una nuova conversazione.

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

Elimina un'attività esistente.

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

Elimina un membro da una conversazione.

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

Enumera i membri di un'attività.

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

Enumera i membri di una conversazione.

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

Enumera i membri di una conversazione una pagina alla volta.

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

Elenca le conversazioni in cui il bot ha partecipato.

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

Invia una risposta a un'attività.

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

Carica le attività storiche della conversazione.

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

Invia un'attività alla fine di una conversazione.

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

Modifica un'attività esistente inviata in precedenza.

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

Archivia i dati in un archivio conforme quando si gestiscono le aziende.

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

CreareAPI Conversation().

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

In'API DeleteActivity().

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

EliminareAPI Membro() di Conversationper competenza.

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

In'API GetActivityMembers().

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

OttenereAPI Membriconversazione () per competenza.

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

OttenereAPI PagedMembers() per competenza.

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

InOttenere'API Conversazioni () per competenza.

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

InAPI ReplyToActivity().

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

InviareAPI Cronologiaconversazione () per competenza.

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

InviareAPI ToConversation() per skill.

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

Nell'APIUpdateActivity().

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

Caricare'API Attachment().

Metodi ereditati da 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

Dettagli costruttore

ChannelServiceHandler

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

Inizializza una nuova istanza della classe ChannelServiceHandler utilizzando un provider di credenziali.

Parametri:

credentialProvider - Provider di credenziali.
authConfiguration - Configurazione dell'autenticazione.
channelProvider - Provider di canali.

Dettagli metodo

getChannelProvider

protected ChannelProvider getChannelProvider()

Ottiene il provider di canali che implementa ChannelProvider .

Restituisce:

valore ChannelProvider come getChannelProvider().

handleCreateConversation

public CompletableFuture handleCreateConversation(String authHeader, ConversationParameters parameters)

Creare una nuova conversazione.

Parametri:

authHeader - Intestazione di autenticazione.
parameters - Parametri da cui creare la conversazione.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleDeleteActivity

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

Elimina un'attività esistente.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
activityId - ID attività.

Restituisce:

Oggetto CompletableFuture che rappresenta il risultato dell'operazione asincrona.

handleDeleteConversationMember

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

Elimina un membro da una conversazione.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
memberId - ID del membro da eliminare da questa conversazione.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

handleGetActivityMembers

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

Enumera i membri di un'attività.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
activityId - ID attività.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleGetConversationMembers

public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)

Enumera i membri di una conversazione.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleGetConversationPagedMembers

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

Enumera i membri di una conversazione una pagina alla volta.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
pageSize - Dimensioni della pagina suggerite.
continuationToken - Token di continuazione.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleGetConversations

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

Elenca le conversazioni in cui il bot ha partecipato.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
continuationToken - Token di skip o di continuazione.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleReplyToActivity

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

Invia una risposta a un'attività.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
activityId - ID attività a cui si trova la risposta.
activity - Attività da inviare.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleSendConversationHistory

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

Carica le attività storiche della conversazione.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
transcript - Trascrizione delle attività.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleSendToConversation

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

Invia un'attività alla fine di una conversazione.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
activity - Attività da inviare.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleUpdateActivity

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

Modifica un'attività esistente inviata in precedenza.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
activityId - ID attività da aggiornare.
activity - Attività di sostituzione.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

handleUploadAttachment

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

Archivia i dati in un archivio conforme quando si gestiscono le aziende.

Parametri:

authHeader - Intestazione di autenticazione.
conversationId - ID conversazione.
attachmentUpload - Dati allegati.

Restituisce:

Oggetto {@link CompletableFuture{TResult}} che rappresenta il risultato dell'operazione asincrona.

onCreateConversation

protected CompletableFuture onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
parameters - Parametri da cui creare la conversazione.

Restituisce:

attività per una risposta della risorsa di conversazione.

onDeleteActivity

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
activityId - activityId da eliminare.

Restituisce:

attività per una risposta di risorsa.

onDeleteConversationMember

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
memberId - D del membro da eliminare da questa conversazione.

Restituisce:

compito.

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
activityId - Attività D.

Restituisce:

attività con risultato.

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.

Restituisce:

attività per una risposta.

onGetConversationPagedMembers

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
pageSize - Dimensioni della pagina suggerite.
continuationToken - Token di continuazione.

Restituisce:

attività per una risposta.

onGetConversations

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - conversationId.
continuationToken - ignorare o continuare il token.

Restituisce:

attività per ConversationsResult.

onReplyToActivity

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
activityId - activityId la risposta è a (OPTONAL).
activity - Attività da inviare.

Restituisce:

attività per una risposta di risorsa.

onSendConversationHistory

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
transcript - Trascrizione delle attività.

Restituisce:

attività per una risposta di risorsa.

onSendToConversation

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - conversationId.
activity - Attività da inviare.

Restituisce:

attività per una risposta di risorsa.

onUpdateActivity

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
activityId - activityId da aggiornare.
activity - attività di sostituzione.

Restituisce:

attività per una risposta di risorsa.

onUploadAttachment

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

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:

claimsIdentity - claimsIdentity per il bot deve avere AudienceClaim, AppIdClaim e ServiceUrlClaim.
conversationId - Conversazione D.
attachmentUpload - Dati allegati.

Restituisce:

attività con risultato.

Si applica a