TurnContext Classe

Crée une instance TurnContext. :p aram adapter_or_context : requête :p aram :

Constructeur

TurnContext(adapter_or_context, request: Activity = None)

Paramètres

Nom	Description
adapter_or_context Obligatoire
request	Valeur par défaut: None

Méthodes

apply_conversation_reference	Met à jour une activité avec les informations de remise d’une référence de conversation. L’appel après get_conversation_reference sur une activité entrante traite correctement la réponse à une activité reçue. activité :p aram : référence :p aram : :p aram is_incoming : :return :
copy_to	Appelée lorsque cette instance TurnContext est passée au constructeur d’une nouvelle instance TurnContext. Peut être substitué dans les classes dérivées. contexte :p aram : :return :
delete_activity	Supprime une activité existante. :p aram id_or_reference : :return :
get
get_conversation_reference	Retourne la référence de conversation pour une activité. Cela peut être enregistré sous la forme d’un ancien objet JSON brut, puis utilisé ultérieurement pour envoyer un message proactif à l’utilisateur. Exemple d’utilisation : reference = TurnContext.get_conversation_reference(context.request) :p aram activity : :return :
get_mentions
get_reply_conversation_reference
has	Cette propriété renvoie La valeur True est définie() a été appelée pour une clé. La valeur mise en cache peut être de type « None ». clé :p aram : :return :
on_delete_activity	Inscrit un gestionnaire pour être averti et potentiellement intercepter une activité en cours de suppression. gestionnaire :p aram : :return :
on_send_activities	Inscrit un gestionnaire pour être averti et potentiellement intercepter l’envoi d’activités. gestionnaire :p aram : :return :
on_update_activity	Inscrit un gestionnaire pour être averti et potentiellement intercepter une activité mise à jour. gestionnaire :p aram : :return :
remove_mention_text
remove_recipient_mention
send_activities
send_activity	Envoie une seule activité ou un message à l’utilisateur. :p aram activity_or_text : :return :
send_trace_activity
set	Met en cache une valeur pour la durée de vie du tour actuel. clé :p aram : valeur :p aram : :return :
update_activity	Remplace une activité existante. activité :p aram : :return :

apply_conversation_reference

Met à jour une activité avec les informations de remise d’une référence de conversation. L’appel après get_conversation_reference sur une activité entrante traite correctement la réponse à une activité reçue. activité :p aram : référence :p aram : :p aram is_incoming : :return :

static apply_conversation_reference(activity: Activity, reference: ConversationReference, is_incoming: bool = False) -> Activity

Paramètres

Nom	Description
activity Obligatoire
reference Obligatoire
is_incoming	Valeur par défaut: False

copy_to

Appelée lorsque cette instance TurnContext est passée au constructeur d’une nouvelle instance TurnContext. Peut être substitué dans les classes dérivées. contexte :p aram : :return :

copy_to(context: TurnContext) -> None

Paramètres

Nom	Description
context Obligatoire

delete_activity

Supprime une activité existante. :p aram id_or_reference : :return :

async delete_activity(id_or_reference: str | ConversationReference)

Paramètres

Nom	Description
id_or_reference Obligatoire

get

get(key: str) -> object

Paramètres

Nom	Description
key Obligatoire

get_conversation_reference

Retourne la référence de conversation pour une activité. Cela peut être enregistré sous la forme d’un ancien objet JSON brut, puis utilisé ultérieurement pour envoyer un message proactif à l’utilisateur.

Exemple d’utilisation : reference = TurnContext.get_conversation_reference(context.request) :p aram activity : :return :

static get_conversation_reference(activity: Activity) -> ConversationReference

Paramètres

Nom	Description
activity Obligatoire

get_mentions

static get_mentions(activity: Activity) -> List[Mention]

Paramètres

Nom	Description
activity Obligatoire

get_reply_conversation_reference

static get_reply_conversation_reference(activity: Activity, reply: ResourceResponse) -> ConversationReference

Paramètres

Nom	Description
activity Obligatoire
reply Obligatoire

has

Cette propriété renvoie La valeur True est définie() a été appelée pour une clé. La valeur mise en cache peut être de type « None ». clé :p aram : :return :

has(key: str) -> bool

Paramètres

Nom	Description
key Obligatoire

on_delete_activity

Inscrit un gestionnaire pour être averti et potentiellement intercepter une activité en cours de suppression. gestionnaire :p aram : :return :

on_delete_activity(handler) -> TurnContext

Paramètres

Nom	Description
handler Obligatoire

on_send_activities

Inscrit un gestionnaire pour être averti et potentiellement intercepter l’envoi d’activités. gestionnaire :p aram : :return :

on_send_activities(handler) -> TurnContext

Paramètres

Nom	Description
handler Obligatoire

on_update_activity

Inscrit un gestionnaire pour être averti et potentiellement intercepter une activité mise à jour. gestionnaire :p aram : :return :

on_update_activity(handler) -> TurnContext

Paramètres

Nom	Description
handler Obligatoire

remove_mention_text

static remove_mention_text(activity: Activity, identifier: str) -> str

Paramètres

Nom	Description
activity Obligatoire
identifier Obligatoire

remove_recipient_mention

static remove_recipient_mention(activity: Activity) -> str

Paramètres

Nom	Description
activity Obligatoire

send_activities

async send_activities(activities: List[Activity]) -> List[ResourceResponse]

Paramètres

Nom	Description
activities Obligatoire

send_activity

Envoie une seule activité ou un message à l’utilisateur. :p aram activity_or_text : :return :

async send_activity(activity_or_text: Activity | str, speak: str = None, input_hint: str = None) -> ResourceResponse | None

Paramètres

Nom	Description
activity_or_text Obligatoire
speak	Valeur par défaut: None
input_hint	Valeur par défaut: None

send_trace_activity

async send_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None) -> ResourceResponse

Paramètres

Nom	Description
name Obligatoire
value	Valeur par défaut: None
value_type	Valeur par défaut: None
label	Valeur par défaut: None

set

Met en cache une valeur pour la durée de vie du tour actuel. clé :p aram : valeur :p aram : :return :

set(key: str, value: object) -> None

Paramètres

Nom	Description
key Obligatoire
value Obligatoire

update_activity

Remplace une activité existante. activité :p aram : :return :

async update_activity(activity: Activity)

Paramètres

Nom	Description
activity Obligatoire

Attributs

activity

Activité reçue. :rendre:

responded

Si true au moins une réponse a été envoyée pour le tour de conversation actuel. :rendre:

services

Mappage des services et d’autres valeurs mises en cache pendant la durée de vie du tour. :rendre:

turn_state