TurnContext Klasa
Tworzy nowe wystąpienie TurnContext. :p aram adapter_or_context: żądanie :p aram:
Konstruktor
TurnContext(adapter_or_context, request: Activity = None)
Parametry
| Nazwa | Opis |
|---|---|
|
adapter_or_context
Wymagane
|
|
|
request
|
Domyślna wartość: None
|
Metody
| apply_conversation_reference |
Aktualizuje działanie za pomocą informacji o dostarczaniu z odwołania do konwersacji. Wywołanie tej metody po get_conversation_reference w działaniu przychodzącym będzie prawidłowo odpowiadać na odebrane działanie. działanie :p aram: :p aram reference: :p aram is_incoming: :return: |
| copy_to |
Wywoływana, gdy to wystąpienie TurnContext jest przekazywane do konstruktora nowego wystąpienia TurnContext. Można zastąpić w klasach pochodnych. :p aram context: :return: |
| delete_activity |
Usuwa istniejące działanie. :p aram id_or_reference: :return: |
| get | |
| get_conversation_reference |
Zwraca odwołanie do konwersacji dla działania. Można to zapisać jako zwykły stary obiekt JSON, a następnie później używany do proaktywnego komunikatu użytkownika. Przykład użycia: reference = TurnContext.get_conversation_reference(context.request) :p aram activity: :return: |
| get_mentions | |
| get_reply_conversation_reference | |
| has |
Zwraca wartość True to set() została wywołana dla klucza. Wartość buforowana może być typu "Brak". :p aram klucz: :return: |
| on_delete_activity |
Rejestruje procedurę obsługi, która ma być powiadamiana o usuwaniu i potencjalnie przechwytuje działanie. :p aram obsługi: :return: |
| on_send_activities |
Rejestruje procedurę obsługi, która ma zostać powiadomiona i potencjalnie przechwytuje wysyłanie działań. :p aram obsługi: :return: |
| on_update_activity |
Rejestruje procedurę obsługi, która ma być powiadamiana i potencjalnie przechwytuje aktualizowane działanie. :p aram obsługi: :return: |
| remove_mention_text | |
| remove_recipient_mention | |
| send_activities | |
| send_activity |
Wysyła jedno działanie lub komunikat do użytkownika. :p aram activity_or_text: :return: |
| send_trace_activity | |
| set |
Buforuje wartość dla okresu istnienia bieżącego turnu. :p aram key: :p aram value: :return: |
| update_activity |
Zastępuje istniejące działanie. działanie :p aram: :return: |
apply_conversation_reference
Aktualizuje działanie za pomocą informacji o dostarczaniu z odwołania do konwersacji. Wywołanie tej metody po get_conversation_reference w działaniu przychodzącym będzie prawidłowo odpowiadać na odebrane działanie. działanie :p aram: :p aram reference: :p aram is_incoming: :return:
static apply_conversation_reference(activity: Activity, reference: ConversationReference, is_incoming: bool = False) -> Activity
Parametry
| Nazwa | Opis |
|---|---|
|
activity
Wymagane
|
|
|
reference
Wymagane
|
|
|
is_incoming
|
Domyślna wartość: False
|
copy_to
Wywoływana, gdy to wystąpienie TurnContext jest przekazywane do konstruktora nowego wystąpienia TurnContext. Można zastąpić w klasach pochodnych. :p aram context: :return:
copy_to(context: TurnContext) -> None
Parametry
| Nazwa | Opis |
|---|---|
|
context
Wymagane
|
|
delete_activity
Usuwa istniejące działanie. :p aram id_or_reference: :return:
async delete_activity(id_or_reference: str | ConversationReference)
Parametry
| Nazwa | Opis |
|---|---|
|
id_or_reference
Wymagane
|
|
get
get(key: str) -> object
Parametry
| Nazwa | Opis |
|---|---|
|
key
Wymagane
|
|
get_conversation_reference
Zwraca odwołanie do konwersacji dla działania. Można to zapisać jako zwykły stary obiekt JSON, a następnie później używany do proaktywnego komunikatu użytkownika.
Przykład użycia: reference = TurnContext.get_conversation_reference(context.request) :p aram activity: :return:
static get_conversation_reference(activity: Activity) -> ConversationReference
Parametry
| Nazwa | Opis |
|---|---|
|
activity
Wymagane
|
|
get_mentions
static get_mentions(activity: Activity) -> List[Mention]
Parametry
| Nazwa | Opis |
|---|---|
|
activity
Wymagane
|
|
get_reply_conversation_reference
static get_reply_conversation_reference(activity: Activity, reply: ResourceResponse) -> ConversationReference
Parametry
| Nazwa | Opis |
|---|---|
|
activity
Wymagane
|
|
|
reply
Wymagane
|
|
has
Zwraca wartość True to set() została wywołana dla klucza. Wartość buforowana może być typu "Brak". :p aram klucz: :return:
has(key: str) -> bool
Parametry
| Nazwa | Opis |
|---|---|
|
key
Wymagane
|
|
on_delete_activity
Rejestruje procedurę obsługi, która ma być powiadamiana o usuwaniu i potencjalnie przechwytuje działanie. :p aram obsługi: :return:
on_delete_activity(handler) -> TurnContext
Parametry
| Nazwa | Opis |
|---|---|
|
handler
Wymagane
|
|
on_send_activities
Rejestruje procedurę obsługi, która ma zostać powiadomiona i potencjalnie przechwytuje wysyłanie działań. :p aram obsługi: :return:
on_send_activities(handler) -> TurnContext
Parametry
| Nazwa | Opis |
|---|---|
|
handler
Wymagane
|
|
on_update_activity
Rejestruje procedurę obsługi, która ma być powiadamiana i potencjalnie przechwytuje aktualizowane działanie. :p aram obsługi: :return:
on_update_activity(handler) -> TurnContext
Parametry
| Nazwa | Opis |
|---|---|
|
handler
Wymagane
|
|
remove_mention_text
static remove_mention_text(activity: Activity, identifier: str) -> str
Parametry
| Nazwa | Opis |
|---|---|
|
activity
Wymagane
|
|
|
identifier
Wymagane
|
|
remove_recipient_mention
static remove_recipient_mention(activity: Activity) -> str
Parametry
| Nazwa | Opis |
|---|---|
|
activity
Wymagane
|
|
send_activities
async send_activities(activities: List[Activity]) -> List[ResourceResponse]
Parametry
| Nazwa | Opis |
|---|---|
|
activities
Wymagane
|
|
send_activity
Wysyła jedno działanie lub komunikat do użytkownika. :p aram activity_or_text: :return:
async send_activity(activity_or_text: Activity | str, speak: str = None, input_hint: str = None) -> ResourceResponse | None
Parametry
| Nazwa | Opis |
|---|---|
|
activity_or_text
Wymagane
|
|
|
speak
|
Domyślna wartość: None
|
|
input_hint
|
Domyślna wartość: None
|
send_trace_activity
async send_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None) -> ResourceResponse
Parametry
| Nazwa | Opis |
|---|---|
|
name
Wymagane
|
|
|
value
|
Domyślna wartość: None
|
|
value_type
|
Domyślna wartość: None
|
|
label
|
Domyślna wartość: None
|
set
Buforuje wartość dla okresu istnienia bieżącego turnu. :p aram key: :p aram value: :return:
set(key: str, value: object) -> None
Parametry
| Nazwa | Opis |
|---|---|
|
key
Wymagane
|
|
|
value
Wymagane
|
|
update_activity
Zastępuje istniejące działanie. działanie :p aram: :return:
async update_activity(activity: Activity)
Parametry
| Nazwa | Opis |
|---|---|
|
activity
Wymagane
|
|
Atrybuty
activity
Odebrane działanie. :wrócić:
responded
Jeśli true co najmniej jedną odpowiedź została wysłana dla bieżącego zwrotu konwersacji. :wrócić:
services
Mapa usług i innych wartości buforowanych na okres istnienia kolei. :wrócić: