Conversations class

Créez une conversation.

new Conversations(client: ConnectorClientContext)

Paramètres

Créez une conversation. POST vers cette méthode avec un

• Bot en cours de création de la conversation
• IsGroup a la valeur true si ce n’est pas un message direct (la valeur par défaut est false)
• Tableau contenant les membres à inclure dans la conversation

La valeur de retour est ResourceResponse qui contient un ID de conversation qui convient pour une utilisation dans la charge utile du message et les URI de l’API REST.

La plupart des canaux prennent uniquement en charge la sémantique des bots qui lancent une conversation de message direct. Voici un exemple de procédure à suivre :

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>

Paramètres

Retours

Promise<Models.ConversationsCreateConversationResponse>

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

Paramètres

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

Paramètres

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

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

Paramètres

Retours

Promesse<msRest.RestResponse>

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

Paramètres

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

Paramètres

Supprime un membre d’une conversation. Cette API REST prend un ConversationId et un memberId (de type chaîne) et supprime ce membre de la conversation. Si ce membre était le dernier membre de la conversation, la conversation sera également supprimée.

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

Paramètres

Retours

Promesse<msRest.RestResponse>

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

Paramètres

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

Paramètres

Énumérez les membres d’une activité. Cette API REST prend un Id de conversation et un ActivityId, retournant un tableau d’objets ChannelAccount représentant les membres de l’activité particulière dans la conversation.

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

Paramètres

Retours

Promise<Models.ConversationsGetActivityMembersResponse>

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

Paramètres

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

Paramètres

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

Paramètres

Retours

Énumérez 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.

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

Paramètres

Retours

Promise<Models.ConversationsGetConversationMembersResponse>

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

Paramètres

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

Paramètres

Énumérez les membres d’une conversation d’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.

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

Paramètres

Retours

Promise<Models.ConversationsGetConversationPagedMembersResponse>

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

Paramètres

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

Paramètres

Répertoriez les conversations dans lesquelles ce bot a participé. GET à partir de cette méthode avec un jeton d’ignorer

La valeur de retour est Une ConversationResult, qui contient un tableau de ConversationMembers et un jeton d’skip. 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 l’ID de la conversation et un tableau de ChannelAccounts qui décrivent les membres de la conversation.

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

Paramètres

Retours

Promise<Models.ConversationsGetConversationsResponse>

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

Paramètres

function getConversations(callback: ServiceCallback<ConversationsResult>)

Paramètres

Cette méthode vous 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.

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

Paramètres

Retours

Promise<Models.ConversationsReplyToActivityResponse>

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

Paramètres

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

Paramètres

Cette méthode vous permet de 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é.

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

Paramètres

Retours

Promise<Models.ConversationsSendConversationHistoryResponse>

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

Paramètres

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

Paramètres

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.

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

Paramètres

Retours

Promise<Models.ConversationsSendToConversationResponse>

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

Paramètres

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

Paramètres

Modifiez une activité existante. 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.

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

Paramètres

Retours

Promise<Models.ConversationsUpdateActivityResponse>

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

Paramètres

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

Paramètres

Chargez une pièce jointe directement dans le stockage d’objets blob d’un canal. Cela est utile, car il vous permet de 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.

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

Paramètres

Retours

Promise<Models.ConversationsUploadAttachmentResponse>

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

Paramètres

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

Paramètres