TurnContext Класс
Создает новый экземпляр TurnContext. :p aram adapter_or_context: запрос :p aram:
Конструктор
TurnContext(adapter_or_context, request: Activity = None)
Параметры
Имя | Описание |
---|---|
adapter_or_context
Обязательно
|
|
request
|
Default value: None
|
Методы
apply_conversation_reference |
Обновляет действие с информацией о доставке из ссылки на беседу. Вызов этого после get_conversation_reference входящего действия будет правильно решать ответ на полученное действие. :p aram activity: :p aram reference: :p aram is_incoming: :return: |
copy_to |
Вызывается при передаче этого экземпляра TurnContext в конструктор нового экземпляра TurnContext. Может быть переопределено в производных классах. контекст :p aram: :return: |
delete_activity |
Удаляет существующее действие. :p aram id_or_reference: :return: |
get | |
get_conversation_reference |
Возвращает ссылку на беседу для действия. Это можно сохранить как обычный старый объект JSON, а затем позже использовать для упреждающего сообщения пользователя. Пример использования: ссылка = TurnContext.get_conversation_reference(context.request) действие :p aram: :return: |
get_mentions | |
get_reply_conversation_reference | |
has |
Возвращает значение True : set() вызывается для ключа. Кэшированное значение может иметь тип None. ключ :p aram: :return: |
on_delete_activity |
Регистрирует обработчик для уведомления и потенциально перехватывает удаление действия. обработчик :p aram: :return: |
on_send_activities |
Регистрирует обработчик, который будет получать уведомления и потенциально перехватывать отправку действий. обработчик :p aram: :return: |
on_update_activity |
Регистрирует обработчик для получения уведомления и потенциально перехвата обновляемого действия. обработчик :p aram: :return: |
remove_mention_text | |
remove_recipient_mention | |
send_activities | |
send_activity |
Отправляет пользователю одно действие или сообщение. :p aram activity_or_text: :return: |
send_trace_activity | |
set |
Кэширует значение для времени существования текущего поворота. :p aram key: :p aram value: :return: |
update_activity |
Заменяет существующее действие. действие :p aram: :return: |
apply_conversation_reference
Обновляет действие с информацией о доставке из ссылки на беседу. Вызов этого после get_conversation_reference входящего действия будет правильно решать ответ на полученное действие. :p aram activity: :p aram reference: :p aram is_incoming: :return:
static apply_conversation_reference(activity: Activity, reference: ConversationReference, is_incoming: bool = False) -> Activity
Параметры
Имя | Описание |
---|---|
activity
Обязательно
|
|
reference
Обязательно
|
|
is_incoming
Обязательно
|
Default value: False
|
copy_to
Вызывается при передаче этого экземпляра TurnContext в конструктор нового экземпляра TurnContext. Может быть переопределено в производных классах. контекст :p aram: :return:
copy_to(context: TurnContext) -> None
Параметры
Имя | Описание |
---|---|
context
Обязательно
|
|
delete_activity
Удаляет существующее действие. :p aram id_or_reference: :return:
async delete_activity(id_or_reference: str | ConversationReference)
Параметры
Имя | Описание |
---|---|
id_or_reference
Обязательно
|
|
get
get(key: str) -> object
Параметры
Имя | Описание |
---|---|
key
Обязательно
|
|
get_conversation_reference
Возвращает ссылку на беседу для действия. Это можно сохранить как обычный старый объект JSON, а затем позже использовать для упреждающего сообщения пользователя.
Пример использования: ссылка = TurnContext.get_conversation_reference(context.request) действие :p aram: :return:
static get_conversation_reference(activity: Activity) -> ConversationReference
Параметры
Имя | Описание |
---|---|
activity
Обязательно
|
|
get_mentions
static get_mentions(activity: Activity) -> List[Mention]
Параметры
Имя | Описание |
---|---|
activity
Обязательно
|
|
get_reply_conversation_reference
static get_reply_conversation_reference(activity: Activity, reply: ResourceResponse) -> ConversationReference
Параметры
Имя | Описание |
---|---|
activity
Обязательно
|
|
reply
Обязательно
|
|
has
Возвращает значение True : set() вызывается для ключа. Кэшированное значение может иметь тип None. ключ :p aram: :return:
has(key: str) -> bool
Параметры
Имя | Описание |
---|---|
key
Обязательно
|
|
on_delete_activity
Регистрирует обработчик для уведомления и потенциально перехватывает удаление действия. обработчик :p aram: :return:
on_delete_activity(handler) -> TurnContext
Параметры
Имя | Описание |
---|---|
handler
Обязательно
|
|
on_send_activities
Регистрирует обработчик, который будет получать уведомления и потенциально перехватывать отправку действий. обработчик :p aram: :return:
on_send_activities(handler) -> TurnContext
Параметры
Имя | Описание |
---|---|
handler
Обязательно
|
|
on_update_activity
Регистрирует обработчик для получения уведомления и потенциально перехвата обновляемого действия. обработчик :p aram: :return:
on_update_activity(handler) -> TurnContext
Параметры
Имя | Описание |
---|---|
handler
Обязательно
|
|
remove_mention_text
static remove_mention_text(activity: Activity, identifier: str) -> str
Параметры
Имя | Описание |
---|---|
activity
Обязательно
|
|
identifier
Обязательно
|
|
remove_recipient_mention
static remove_recipient_mention(activity: Activity) -> str
Параметры
Имя | Описание |
---|---|
activity
Обязательно
|
|
send_activities
async send_activities(activities: List[Activity]) -> List[ResourceResponse]
Параметры
Имя | Описание |
---|---|
activities
Обязательно
|
|
send_activity
Отправляет пользователю одно действие или сообщение. :p aram activity_or_text: :return:
async send_activity(activity_or_text: Activity | str, speak: str = None, input_hint: str = None) -> ResourceResponse
Параметры
Имя | Описание |
---|---|
activity_or_text
Обязательно
|
|
speak
Обязательно
|
Default value: None
|
input_hint
Обязательно
|
Default value: None
|
send_trace_activity
async send_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None) -> ResourceResponse
Параметры
Имя | Описание |
---|---|
name
Обязательно
|
|
value
Обязательно
|
Default value: None
|
value_type
Обязательно
|
Default value: None
|
label
Обязательно
|
Default value: None
|
set
Кэширует значение для времени существования текущего поворота. :p aram key: :p aram value: :return:
set(key: str, value: object) -> None
Параметры
Имя | Описание |
---|---|
key
Обязательно
|
|
value
Обязательно
|
|
update_activity
Заменяет существующее действие. действие :p aram: :return:
async update_activity(activity: Activity)
Параметры
Имя | Описание |
---|---|
activity
Обязательно
|
|
Атрибуты
activity
Полученное действие. :возвращать:
responded
Если true по крайней мере один ответ был отправлен для текущей очереди беседы. :возвращать:
services
Карта служб и других значений, кэшированных в течение времени существования поворота. :возвращать: