Conversations class

Creare conversazioni.

new Conversations(client: ConnectorClientContext)

Parametri

Creare una nuova conversazione. POST a questo metodo con un

• Bot che crea la conversazione
• IsGroup impostato su true se non è un messaggio diretto (il valore predefinito è false)
• Matrice contenente i membri da includere 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 è:

const resource = await connector.conversations.createConversation({
    bot,
    members: [{ id: 'user1' }]
});
await connector.conversations.sendToConversation(resource.Id, ... );

function createConversation(parameters: ConversationParameters, options?: RequestOptionsBase): Promise<Models.ConversationsCreateConversationResponse>

Parametri

Restituisce

Promise<Models.ConversationsCreateConversationResponse>

function createConversation(parameters: ConversationParameters, options: RequestOptionsBase, callback: ServiceCallback<ConversationResourceResponse>)

Parametri

function createConversation(parameters: ConversationParameters, callback: ServiceCallback<ConversationResourceResponse>)

Parametri

Eliminare un'attività esistente. Alcuni canali consentono di eliminare un'attività esistente e, in caso di esito positivo, questo metodo rimuoverà l'attività specificata.

function deleteActivity(conversationId: string, activityId: string, options?: RequestOptionsBase): Promise<RestResponse>

Parametri

Restituisce

Promise<msRest.RestResponse>

function deleteActivity(conversationId: string, activityId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametri

function deleteActivity(conversationId: string, activityId: string, callback: ServiceCallback<void>)

Parametri

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.

function deleteConversationMember(conversationId: string, memberId: string, options?: RequestOptionsBase): Promise<RestResponse>

Parametri

Restituisce

Promise<msRest.RestResponse>

function deleteConversationMember(conversationId: string, memberId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametri

function deleteConversationMember(conversationId: string, memberId: string, callback: ServiceCallback<void>)

Parametri

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.

function getActivityMembers(conversationId: string, activityId: string, options?: RequestOptionsBase): Promise<Models.ConversationsGetActivityMembersResponse>

Parametri

Restituisce

Promise<Models.ConversationsGetActivityMembersResponse>

function getActivityMembers(conversationId: string, activityId: string, options: RequestOptionsBase, callback: ServiceCallback<ChannelAccount[]>)

Parametri

function getActivityMembers(conversationId: string, activityId: string, callback: ServiceCallback<ChannelAccount[]>)

Parametri

function getConversationMember(conversationId: string, memberId: string, options?: RequestOptionsBase | ServiceCallback<ChannelAccount[]>, callback?: ServiceCallback<ChannelAccount[]>): Promise<Models.ConversationsGetConversationMemberResponse>

Parametri

Restituisce

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.

function getConversationMembers(conversationId: string, options?: RequestOptionsBase): Promise<Models.ConversationsGetConversationMembersResponse>

Parametri

Restituisce

Promise<Models.ConversationsGetConversationMembersResponse>

function getConversationMembers(conversationId: string, options: RequestOptionsBase, callback: ServiceCallback<ChannelAccount[]>)

Parametri

function getConversationMembers(conversationId: string, callback: ServiceCallback<ChannelAccount[]>)

Parametri

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.

function getConversationPagedMembers(conversationId: string, options?: ConversationsGetConversationPagedMembersOptionalParams): Promise<Models.ConversationsGetConversationPagedMembersResponse>

Parametri

Restituisce

Promise<Models.ConversationsGetConversationPagedMembersResponse>

function getConversationPagedMembers(conversationId: string, options: ConversationsGetConversationPagedMembersOptionalParams, callback: ServiceCallback<PagedMembersResult>)

Parametri

function getConversationPagedMembers(conversationId: string, callback: ServiceCallback<PagedMembersResult>)

Parametri

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.

function getConversations(options?: ConversationsGetConversationsOptionalParams): Promise<Models.ConversationsGetConversationsResponse>

Parametri

Restituisce

Promise<Models.ConversationsGetConversationsResponse>

function getConversations(options: ConversationsGetConversationsOptionalParams, callback: ServiceCallback<ConversationsResult>)

Parametri

function getConversations(callback: ServiceCallback<ConversationsResult>)

Parametri

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.

function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsReplyToActivityResponse>

Parametri

Restituisce

Promise<Models.ConversationsReplyToActivityResponse>

function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

Parametri

function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)

Parametri

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.

function sendConversationHistory(conversationId: string, history: Transcript, options?: RequestOptionsBase): Promise<Models.ConversationsSendConversationHistoryResponse>

Parametri

Restituisce

Promise<Models.ConversationsSendConversationHistoryResponse>

function sendConversationHistory(conversationId: string, history: Transcript, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

Parametri

function sendConversationHistory(conversationId: string, history: Transcript, callback: ServiceCallback<ResourceResponse>)

Parametri

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.

function sendToConversation(conversationId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsSendToConversationResponse>

Parametri

Restituisce

<Models.ConversationsSendToConversationResponse>

function sendToConversation(conversationId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

Parametri

function sendToConversation(conversationId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)

Parametri

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

function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsUpdateActivityResponse>

Parametri

Restituisce

Promise<Models.ConversationsUpdateActivityResponse>

function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

Parametri

function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)

Parametri

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.

function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, options?: RequestOptionsBase): Promise<Models.ConversationsUploadAttachmentResponse>

Parametri

Restituisce

Promise<Models.ConversationsUploadAttachmentResponse>

function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

Parametri

function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, callback: ServiceCallback<ResourceResponse>)

Parametri