Conversations Interfaccia

public abstract CompletableFuture createConversation(ConversationParameters parameters)

CreateConversation. Creare una nuova conversazione. POST a questo metodo con un bot che crea la conversazione IsGroup impostata su true se non si tratta di un messaggio diretto (il valore predefinito è false) Matrice membri che contino i membri che si desidera avere nella conversazione. Il valore restituito è resourceResponse che contiene un ID conversazione adatto per l'uso nei 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 = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); await connect. Conversations.SendToConversation(resource. ID, new Activity() ... ) ; ```

Parametri:

Restituisce:

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity. 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:

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember. Elimina un membro da una conversazione. Questa API REST accetta un Valore 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:

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

GetActivityMembers. 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:

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

Recupera un singolo membro di una conversazione in base all'ID.

Parametri:

Restituisce:

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers. Enumerare i membri di una converstion. Questa API REST accetta un ConversationId e restituisce una matrice di oggetti ChannelAccount che rappresentano i membri della conversazione.

Parametri:

Restituisce:

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

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. 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:

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

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. 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:

public abstract CompletableFuture getConversations()

GetConversations. Elencare le conversazioni in cui ha partecipato il 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 l'ID della conversazione e una matrice di ChannelAccounts che descrivono i membri della conversazione.

Restituisce:

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations. Elencare le conversazioni in cui ha partecipato il 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 l'ID della conversazione e una matrice di ChannelAccounts che descrivono i membri della conversazione.

Parametri:

Restituisce:

public default CompletableFuture replyToActivity(Activity activity)

ReplyToActivity. 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:

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

ReplyToActivity. 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:

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

Questo metodo consente di caricare le attività storiche 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:

public default CompletableFuture sendToConversation(Activity activity)

SendToConversation. Questo metodo consente di inviare un'attività alla fine di una conversazione. Questo è leggermente diverso da ReplyToActivity(). sendToConverstion(activity): aggiungerà l'attività alla fine della conversazione in base al timestamp o alla semantica del canale, utilizzando Activity.getConversation.getId per l'ID conversazione. 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:

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

SendToConversation. Questo metodo consente di inviare un'attività alla fine di una conversazione. Questo è leggermente diverso da ReplyToActivity(). SendToConverstion(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:

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity. Modificare un'attività esistente. 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:

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

UpdateActivity. Modificare un'attività esistente. 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:

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment. Caricare un allegato direttamente nell'archivio BLOB di un canale. Ciò è utile perché consente di 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: