TurnContext class

Crée une instance de la classe TurnContext .

new TurnContext(adapterOrContext: BotAdapter, request: Partial<Activity>)

Paramètres

Crée une instance de la classe TurnContext .

new TurnContext(adapterOrContext: TurnContext)

Paramètres

Obtient l’activité associée à ce tour.

Activity activity

Valeur de propriété

Activité associée à ce tour.

Remarques

Cet exemple montre comment obtenir les utilisateurs supprimés l’énoncé de l’activité :

const utterance = (context.activity.text || '').trim();

Obtient l’adaptateur de bot qui a créé cet objet de contexte.

BotAdapter adapter

Valeur de propriété

Adaptateur de bot qui a créé cet objet de contexte.

Liste des activités à envoyer quand context.activity.deliveryMode == 'expectReplies'.

bufferedReplyActivities: Partial<Activity>[]

Valeur de propriété

Obtient les paramètres régionaux stockés dans le turnState. Définit les paramètres régionaux stockés dans le turnState.

string | undefined locale

Valeur de propriété

Paramètres régionaux stockés dans le turnState.

Indique si le bot a répondu à l’utilisateur ce tour. Définit l’indicateur de réponse sur le contexte de tour actuel.

boolean responded

Valeur de propriété

True si au moins une réponse a été envoyée pour le tour actuel ; sinon, false.

Remarques

true si au moins une réponse a été envoyée pour le tour actuel ; sinon, false. Utilisez cette option pour déterminer si votre bot doit exécuter la logique de secours après un autre traitement normal.

Les activités de suivi ne définissent pas cet indicateur.

Par exemple :

await routeActivity(context);
if (!context.responded) {
   await context.sendActivity(`I'm sorry. I didn't understand.`);
}

Obtient les services inscrits sur cet objet de contexte.

TurnContextStateCollection turnState

Valeur de propriété

Services inscrits sur cet objet de contexte.

Remarques

Le middleware, d’autres composants et services l’utilisent généralement pour mettre en cache des informations qui peuvent être demandées par un bot plusieurs fois au cours d’un tour. Vous pouvez utiliser ce cache pour transmettre des informations entre les composants de votre bot.

Par exemple :

const cartKey = Symbol();
const cart = await loadUsersShoppingCart(context);
context.turnState.set(cartKey, cart);

Mises à jour une activité avec les informations de remise à partir d’une référence de conversation existante.

static function applyConversationReference(activity: Partial<Activity>, reference: Partial<ConversationReference>, isIncoming?: boolean): Partial<Activity>

Paramètres

Retours

Cette activité, mise à jour avec les informations de remise.

Remarques

Appelez la méthode getConversationReference sur une activité entrante pour obtenir une référence de conversation que vous pouvez ensuite utiliser pour mettre à jour une activité sortante avec les informations de remise correctes.

Supprime de façon asynchrone une activité précédemment envoyée.

function deleteActivity(idOrReference: string | Partial<ConversationReference>): Promise<void>

Paramètres

Retours

Promesse représentant l’opération asynchrone.

Remarques

Si un ID est spécifié, la référence de conversation pour la requête actuelle est utilisée pour obtenir le reste des informations nécessaires.

Par exemple :

const matched = /approve (.*)/i.exec(context.activity.text);
if (matched) {
   const savedId = await approveExpenseReport(matched[1]);
   await context.deleteActivity(savedId);
}

Voir aussi

• sendActivity
• updateActivity
• getReplyConversationReference

Copie les informations de référence de conversation à partir d’une activité.

static function getConversationReference(activity: Partial<Activity>): Partial<ConversationReference>

Paramètres

Retours

Référence de conversation pour la conversation qui contient cette activité.

Remarques

Vous pouvez enregistrer la référence de conversation en tant qu’objet JSON et l’utiliser ultérieurement pour envoyer un message proactif à l’utilisateur.

Par exemple :

const reference = TurnContext.getConversationReference(context.request);

Voir aussi

• BotAdapter.continueConversation

Obtient toutes les entités à mention incluses dans une activité.

static function getMentions(activity: Partial<Activity>): Mention[]

Paramètres

Retours

Toutes les entités à mention incluses dans une activité.

Remarques

La propriété entities de l’activité contient une liste plate d’objets de métadonnées relatifs à cette activité et peut contenir des entités de mention . Cette méthode retourne toutes ces entités pour une activité donnée.

Par exemple :

const mentions = TurnContext.getMentions(turnContext.request);

Copie les informations de référence de conversation à partir d’une réponse de ressource pour une activité envoyée.

static function getReplyConversationReference(activity: Partial<Activity>, reply: ResourceResponse): Partial<ConversationReference>

Paramètres

Retours

ConversationReference qui peut être stockée et utilisée ultérieurement pour supprimer ou mettre à jour l’activité.

Remarques

Vous pouvez enregistrer la référence de conversation en tant qu’objet JSON et l’utiliser ultérieurement pour mettre à jour ou supprimer le message.

Par exemple :

var reply = await context.sendActivity('Hi');
var reference = TurnContext.getReplyConversationReference(context.activity, reply);

Voir aussi

• deleteActivity
• updateActivity

Ajoute un gestionnaire de réponses pour les opérations d’activité de suppression.

function onDeleteActivity(handler: DeleteActivityHandler): this

Paramètres

Retours

Objet de contexte mis à jour.

Remarques

Cette méthode retourne une référence à l’objet de contexte de tour.

Lorsque la méthode deleteActivity est appelée, les gestionnaires inscrits sont appelés dans l’ordre dans lequel ils ont été ajoutés à l’objet de contexte avant la suppression de l’activité.

Cet exemple montre comment écouter et consigner les suppressions d’activité.

context.onDeleteActivity(async (ctx, reference, next) => {
   // Delete activity
   await next();

   // Log delete
   logDelete(activity);
});

Ajoute un gestionnaire de réponses pour les opérations d’activité d’envoi.

function onSendActivities(handler: SendActivitiesHandler): this

Paramètres

Retours

Objet de contexte mis à jour.

Remarques

Cette méthode retourne une référence à l’objet de contexte de tour.

Lorsque la méthode sendActivity ou sendActivities est appelée, les gestionnaires inscrits sont appelés dans l’ordre dans lequel ils ont été ajoutés à l’objet de contexte avant l’envoi des activités.

Cet exemple montre comment écouter et journaliser les activités sortantes message .

context.onSendActivities(async (ctx, activities, next) => {
   // Log activities before sending them.
   activities.filter(a => a.type === 'message').forEach(a => logSend(a));

   // Allow the send process to continue.
   next();
});

Ajoute un gestionnaire de réponses pour les opérations d’activité de mise à jour.

function onUpdateActivity(handler: UpdateActivityHandler): this

Paramètres

Retours

Objet de contexte mis à jour.

Remarques

Cette méthode retourne une référence à l’objet de contexte de tour.

Lorsque la méthode updateActivity est appelée, les gestionnaires inscrits sont appelés dans l’ordre dans lequel ils ont été ajoutés à l’objet de contexte avant la mise à jour de l’activité.

Cet exemple montre comment écouter et journaliser les mises à jour de l’activité.

context.onUpdateActivity(async (ctx, activity, next) => {
   // Replace activity
   await next();

   // Log update
   logUpdate(activity);
});

Supprime au niveau des mentions pour un ID donné du texte d’une activité et retourne le texte mis à jour. À utiliser avec précaution; cette fonction modifie la propriété de texte de l’activité.

static function removeMentionText(activity: Partial<Activity>, id: string): string

Paramètres

Retours

Texte de l’activité mise à jour.

Remarques

Certains canaux, par exemple Microsoft Teams, ajoutent des mentions au texte d’une activité de message.

Utilisez cette méthode d’assistance pour modifier la propriété de texte de l’activité. Il supprime toutes les mentions pour le bot ou l’ID utilisateur donné, puis retourne la valeur de la propriété mise à jour.

Par exemple, lorsque vous supprimez les mentions d’echoBot d’une activité contenant le texte « @echoBot Hi Bot », le texte de l’activité est mis à jour et la méthode retourne « Hi Bot ».

Le format d’une entité de mention dépend du canal. Toutefois, la propriété de texte de la mention doit contenir le texte exact de l’utilisateur tel qu’il apparaît dans le texte d’activité.

Par exemple, si le canal utilise « username » ou « @username », cette chaîne se trouve dans le texte de l’activité, et cette méthode supprime toutes les occurrences de cette chaîne du texte.

Par exemple :

const updatedText = TurnContext.removeMentionText(activity, activity.recipient.id);

Voir aussi

• removeRecipientMention

Supprime aux mentions du destinataire de l’activité du texte d’une activité et retourne le texte mis à jour. À utiliser avec précaution; cette fonction modifie la propriété de texte de l’activité.

static function removeRecipientMention(activity: Partial<Activity>): string

Paramètres

Retours

Texte de l’activité mise à jour.

Remarques

Certains canaux, par exemple Microsoft Teams, ajoutent des détails à la mention au texte d’une activité de message.

Utilisez cette méthode d’assistance pour modifier la propriété de texte de l’activité. Il supprime tout aux mentions du destinataire de l’activité, puis retourne la valeur de la propriété mise à jour.

Par exemple :

const updatedText = TurnContext.removeRecipientMention(turnContext.request);

Voir aussi

• removeMentionText

Envoie de manière asynchrone un ensemble d’activités à l’expéditeur de l’activité entrante.

function sendActivities(activities: Partial<Activity>[]): Promise<ResourceResponse[]>

Paramètres

Retours

Promesse avec un ResourceResponse.

Remarques

Si les activités sont correctement envoyées, il en résulte un tableau d’objets ResourceResponse contenant les ID que le canal de réception a attribués aux activités.

Avant d’être envoyées, les informations de remise de chaque activité sortante sont mises à jour en fonction des informations de remise de l’activité entrante.

Par exemple :

await context.sendActivities([
   { type: 'typing' },
   { type: 'delay', value: 2000 },
   { type: 'message', text: 'Hello... How are you?' }
]);

Voir aussi

• sendActivity
• updateActivity
• deleteActivity

Envoie de manière asynchrone une activité à l’expéditeur de l’activité entrante.

function sendActivity(activityOrText: string | Partial<Activity>, speak?: string, inputHint?: string): Promise<ResourceResponse | undefined>

Paramètres

Retours

Promesse avec un ResourceResponse.

Remarques

Si l’activité est correctement envoyée, il en résulte un objet ResourceResponse contenant l’ID que le canal de réception a attribué à l’activité.

Consultez la documentation du canal pour connaître les limites imposées au contenu du paramètre activityOrText .

Pour contrôler différentes caractéristiques du discours de votre bot, telles que la voix, la fréquence, le volume, la prononciation et la hauteur, spécifiez la parole au format SSML (Speech Synthesis Markup Language).

Par exemple :

await context.sendActivity(`Hello World`);

Voir aussi

• sendActivities
• updateActivity
• deleteActivity

Envoie de manière asynchrone une activité à l’expéditeur de l’activité entrante.

function sendTraceActivity(name: string, value?: any, valueType?: string, label?: string): Promise<ResourceResponse | undefined>

Paramètres

Retours

Promesse avec un ResourceResponse.

Remarques

Crée et envoie une activité Trace. Les activités de trace sont envoyées uniquement lorsque le canal est l’émulateur.

Par exemple :

await context.sendTraceActivity(`The following exception was thrown ${msg}`);

Voir aussi

• sendActivities

Met à jour de manière asynchrone une activité précédemment envoyée.

function updateActivity(activity: Partial<Activity>): Promise<ResourceResponse | void>

Paramètres

Retours

Promesse avec un ResourceResponse.

Remarques

L’ID de l’activité de remplacement indique l’activité dans la conversation à remplacer.

Par exemple :

const matched = /approve (.*)/i.exec(context.activity.text);
if (matched) {
   const update = await approveExpenseReport(matched[1]);
   await context.updateActivity(update);
}

Voir aussi

• sendActivity
• deleteActivity
• getReplyConversationReference