Activity Класс
Действие — это базовый тип связи для протокола Bot Framework 3.0.
- Наследование
-
msrest.serialization.ModelActivity
Конструктор
Activity(*, type=None, id: str = None, timestamp=None, local_timestamp=None, local_timezone: str = None, service_url: str = None, channel_id: str = None, from_property=None, conversation=None, recipient=None, text_format=None, attachment_layout=None, members_added=None, members_removed=None, reactions_added=None, reactions_removed=None, topic_name: str = None, history_disclosed: bool = None, locale: str = None, text: str = None, speak: str = None, input_hint=None, summary: str = None, suggested_actions=None, attachments=None, entities=None, channel_data=None, action: str = None, reply_to_id: str = None, label: str = None, value_type: str = None, value=None, name: str = None, relates_to=None, code=None, expiration=None, importance=None, delivery_mode=None, listen_for=None, text_highlights=None, semantic_action=None, caller_id: str = None, **kwargs)Параметры
| Имя | Описание |
|---|---|
|
type
Обязательно
|
str или
<xref:botframework.connector.models.ActivityTypes>
Содержит тип действия. Возможные значения: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff" |
|
id
Обязательно
|
Содержит идентификатор, который однозначно идентифицирует действие в канале. |
|
timestamp
Обязательно
|
Содержит дату и время отправки сообщения в формате UTC, выраженные в формате ISO-8601. |
|
local_timestamp
Обязательно
|
Содержит локальную дату и время сообщения, выраженные в формате ISO-8601. Например, 2016-09-23T13:07:49.4714686-07:00. |
|
local_timezone
Обязательно
|
Содержит имя локального часового пояса сообщения, представленного в формате базы данных часового пояса IANA. Например, America/Los_Angeles. |
|
service_url
Обязательно
|
Содержит URL-адрес, указывающий конечную точку службы канала. Задается каналом. |
|
channel_id
Обязательно
|
Содержит идентификатор, который однозначно идентифицирует канал. Задается каналом. |
|
from_property
Обязательно
|
<xref:botframework.connector.models.ChannelAccount>
Идентифицирует отправителя сообщения. |
|
conversation
Обязательно
|
<xref:botframework.connector.models.ConversationAccount>
Идентифицирует беседу, к которой принадлежит действие. |
|
recipient
Обязательно
|
<xref:botframework.connector.models.ChannelAccount>
Определяет получателя сообщения. |
|
text_format
Обязательно
|
str или
<xref:botframework.connector.models.TextFormatTypes>
Формат текстовых полей Default:markdown. Возможные значения: "markdown", "plain", "xml" |
|
attachment_layout
Обязательно
|
str или
<xref:botframework.connector.models.AttachmentLayoutTypes>
Указание макета для нескольких вложений. По умолчанию: list. Возможные значения: "list", "карусель" |
|
members_added
Обязательно
|
list[<xref:botframework.connector.models.ChannelAccount>]
Коллекция участников, добавленных в беседу. |
|
members_removed
Обязательно
|
list[<xref:botframework.connector.models.ChannelAccount>]
Коллекция участников, удаленных из беседы. |
|
reactions_added
Обязательно
|
list[<xref:botframework.connector.models.MessageReaction>]
Коллекция реакций, добавленных в диалог. |
|
reactions_removed
Обязательно
|
list[<xref:botframework.connector.models.MessageReaction>]
Коллекция реакций, удаленных из диалога. |
|
topic_name
Обязательно
|
Обновленное название темы беседы. |
|
history_disclosed
Обязательно
|
Указывает, раскрывается ли предыдущий журнал канала. |
|
locale
Обязательно
|
Имя языкового стандарта для содержимого текстового поля. Название языкового стандарта представляет собой сочетание двух- или трехбуквенный код языка ISO 639, связанный с языком, и двухбуквенный код субкультуры ISO 3166, связанный со страной или регионом. Имя языкового стандарта также может соответствовать допустимому тегу языка BCP-47. |
|
text
Обязательно
|
Текстовое содержимое сообщения. |
|
speak
Обязательно
|
Текст для озвучки. |
|
input_hint
Обязательно
|
str или
<xref:botframework.connector.models.InputHints>
Указывает, принимает ли бот, ожидает или игнорирует введенные пользователем данные после доставки сообщения клиенту. Возможные значения: acceptingInput, ignoringInput, expectingInput. |
|
summary
Обязательно
|
Текст, отображаемый, если каналу не удается отобразить карточки. |
|
suggested_actions
Обязательно
|
<xref:botframework.connector.models.SuggestedActions>
Предлагаемые действия для действия. |
|
attachments
Обязательно
|
list[<xref:botframework.connector.models.Attachment>]
Вложения |
|
entities
Обязательно
|
list[<xref:botframework.connector.models.Entity>]
Представляет сущности, упомянутые в сообщении. |
|
channel_data
Обязательно
|
Содержит содержимое для конкретного канала. |
|
action
Обязательно
|
Указывает, был ли добавлен или удален получатель contactRelationUpdate из списка контактов отправителя. |
|
reply_to_id
Обязательно
|
Содержит идентификатор сообщения, на которое это сообщение является ответом. |
|
label
Обязательно
|
Описательная метка для действия. |
|
value_type
Обязательно
|
Тип объекта значения действия. |
|
value
Обязательно
|
Значение , связанное с действием. |
|
name
Обязательно
|
Имя операции, связанной с действием вызова или события. |
|
relates_to
Обязательно
|
<xref:botframework.connector.models.ConversationReference>
Ссылка на другую беседу или действие. |
|
code
Обязательно
|
str или
<xref:botframework.connector.models.EndOfConversationCodes>
Код для действий endOfConversation, указывающий, почему беседа закончилась. Возможные значения: unknown, completedSuccessfully, userCancelled, botTimedOut, botIssuedInvalidMessage, channelFailed. |
|
expiration
Обязательно
|
Время, в течение которого действие должно считаться истекшим и не должно быть представлено получателю. |
|
importance
Обязательно
|
str или
<xref:botframework.connector.models.ActivityImportance>
Важность действия. Возможные значения: low, normal, high |
|
delivery_mode
Обязательно
|
str или
<xref:botframework.connector.models.DeliveryModes>
Указание, определяющее альтернативные пути доставки действия получателю. Режим доставки по умолчанию — "default". Возможные значения: "normal", "notification", "expectReplies", "ephemeral" |
|
listen_for
Обязательно
|
Список фраз и ссылок, которые должны прослушивать системы подготовки речи и языка |
|
text_highlights
Обязательно
|
list[<xref:botframework.connector.models.TextHighlight>]
Коллекция фрагментов текста для выделения, если действие содержит значение ReplyToId. |
|
semantic_action
Обязательно
|
<xref:botframework.connector.models.SemanticAction>
Дополнительное программное действие, сопровождающее этот запрос |
|
caller_id
Обязательно
|
Строка, содержащая IRI для идентификации объекта, который вызывает бота. Это поле не предназначено для передачи по сети. Оно заполняется ботами и клиентами на основе доступных для криптографической проверки данных, которые подтверждают подлинность вызывающих объектов (например, маркеров). |
Параметры Keyword-Only
| Имя | Описание |
|---|---|
|
type
Обязательно
|
|
|
id
Обязательно
|
|
|
timestamp
Обязательно
|
|
|
local_timestamp
Обязательно
|
|
|
local_timezone
Обязательно
|
|
|
service_url
Обязательно
|
|
|
channel_id
Обязательно
|
|
|
from_property
Обязательно
|
|
|
conversation
Обязательно
|
|
|
recipient
Обязательно
|
|
|
text_format
Обязательно
|
|
|
attachment_layout
Обязательно
|
|
|
members_added
Обязательно
|
|
|
members_removed
Обязательно
|
|
|
reactions_added
Обязательно
|
|
|
reactions_removed
Обязательно
|
|
|
topic_name
Обязательно
|
|
|
history_disclosed
Обязательно
|
|
|
locale
Обязательно
|
|
|
text
Обязательно
|
|
|
speak
Обязательно
|
|
|
input_hint
Обязательно
|
|
|
summary
Обязательно
|
|
|
suggested_actions
Обязательно
|
|
|
attachments
Обязательно
|
|
|
entities
Обязательно
|
|
|
channel_data
Обязательно
|
|
|
action
Обязательно
|
|
|
reply_to_id
Обязательно
|
|
|
label
Обязательно
|
|
|
value_type
Обязательно
|
|
|
value
Обязательно
|
|
|
name
Обязательно
|
|
|
relates_to
Обязательно
|
|
|
code
Обязательно
|
|
|
expiration
Обязательно
|
|
|
importance
Обязательно
|
|
|
delivery_mode
Обязательно
|
|
|
listen_for
Обязательно
|
|
|
text_highlights
Обязательно
|
|
|
semantic_action
Обязательно
|
|
|
caller_id
Обязательно
|
|
Методы
| apply_conversation_reference |
Обновления это действие с помощью сведений о доставке из существующего Объекта ConversationReference. входящее действие, где бот является получателем; в противном случае — False. Значение по умолчанию — False, и в действии будет отображаться бот в качестве отправителя. |
| as_contact_relation_update_activity |
Возвращает это действие в виде объекта ContactRelationUpdateActivity; или Нет, если это не тот тип действия. |
| as_conversation_update_activity |
Возвращает это действие в виде объекта ConversationUpdateActivity; или Нет, если это не тот тип действия. |
| as_end_of_conversation_activity |
Возвращает это действие в виде объекта EndOfConversationActivity; или Нет, если это не тот тип действия. |
| as_event_activity |
Возвращает это действие как объект EventActivity; или Нет, если это не тот тип действия. |
| as_handoff_activity |
Возвращает это действие в виде объекта HandoffActivity; или Нет, если это не тот тип действия. |
| as_installation_update_activity |
Возвращает это действие в виде объекта InstallationUpdateActivity; или Нет, если это не тот тип действия. |
| as_invoke_activity |
Возвращает это действие в виде объекта InvokeActivity; или Нет, если это не тот тип действия. |
| as_message_activity |
Возвращает это действие в виде объекта MessageActivity; или Нет, если это не тот тип действия. |
| as_message_delete_activity |
Возвращает это действие в виде объекта MessageDeleteActivity; или Нет, если это не тот тип действия. |
| as_message_reaction_activity |
Возвращает это действие в виде объекта MessageReactionActivity; или Нет, если это не тот тип действия. |
| as_message_update_activity |
Возвращает это действие в виде объекта MessageUpdateActivity; или Нет, если это не тот тип действия. |
| as_suggestion_activity |
Возвращает это действие в виде объекта SuggestionActivity; или Нет, если это не тот тип действия. |
| as_trace_activity |
Возвращает это действие в виде объекта TraceActivity; или Нет, если это не тот тип действия. |
| as_typing_activity |
Возвращает это действие в виде объекта TypingActivity; или null, если это не тот тип действия. |
| create_contact_relation_update_activity |
Создает экземпляр класса в Activity виде объектаContactRelationUpdateActivity. |
| create_conversation_update_activity |
Создает экземпляр класса в Activity виде объекта ConversationUpdateActivity. |
| create_end_of_conversation_activity |
Создает экземпляр класса в Activity виде объекта EndOfConversationActivity. |
| create_event_activity |
Создает экземпляр класса в Activity виде объекта EventActivity. |
| create_handoff_activity |
Создает экземпляр класса в Activity виде объекта HandoffActivity. |
| create_invoke_activity |
Создает экземпляр класса в Activity виде объекта InvokeActivity. |
| create_message_activity |
Создает экземпляр класса в Activity виде объекта MessageActivity. |
| create_reply |
Создает новое действие сообщения в качестве ответа на это действие. |
| create_trace |
Создает новое действие трассировки на основе этого действия. Значение по умолчанию — это имя типа значения. :p меткаaram: необязательно, описательная метка для этой операции трассировки. |
| create_trace_activity |
Создает экземпляр класса в Activity виде объекта TraceActivity. Значение по умолчанию — это имя типа значения. :p меткаaram: необязательно, описательная метка для этой операции трассировки. |
| create_typing_activity |
Создает экземпляр класса в Activity виде объекта TypingActivity. |
| get_conversation_reference |
Создает ConversationReference на основе этого действия. |
| get_mentions |
Разрешает упоминания из сущностей этого действия. |
| get_reply_conversation_reference |
Создайте ConversationReference на основе сведений о беседе этого действия и ResourceResponse от отправки действия. |
| has_content |
Указывает, содержит ли это действие содержимое. |
| is_from_streaming_connection |
Определите, было ли действие отправлено через http/https-подключение или потоковую передачу. Это можно определить, просмотрев свойство service_url: (1) Все каналы, отправляющие сообщения по протоколу http/https, не являются потоковыми (2) Каналы, отправляющие сообщения через потоковую передачу, имеют ServiceUrl, который не начинается с http/https. |
apply_conversation_reference
Обновления это действие с помощью сведений о доставке из существующего Объекта ConversationReference.
входящее действие, где бот является получателем; в противном случае — False. Значение по умолчанию — False, и в действии будет отображаться бот в качестве отправителя.
apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)Параметры
| Имя | Описание |
|---|---|
|
reference
Обязательно
|
|
|
is_incoming
|
Default value: False
|
Возвращаемое значение
| Тип | Описание |
|---|---|
|
его деятельность, обновленная с информацией о доставке. |
Комментарии
Вызовите Метод GetConversationReference для входящего действия, чтобы получить ссылку на беседу, которую затем можно использовать для обновления исходящего действия с правильными сведениями о доставке.
as_contact_relation_update_activity
Возвращает это действие в виде объекта ContactRelationUpdateActivity; или Нет, если это не тот тип действия.
as_contact_relation_update_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие сообщения; или Нет. |
as_conversation_update_activity
Возвращает это действие в виде объекта ConversationUpdateActivity; или Нет, если это не тот тип действия.
as_conversation_update_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие обновления беседы; или Нет. |
as_end_of_conversation_activity
Возвращает это действие в виде объекта EndOfConversationActivity; или Нет, если это не тот тип действия.
as_end_of_conversation_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как окончание общения; или Нет. |
as_event_activity
Возвращает это действие как объект EventActivity; или Нет, если это не тот тип действия.
as_event_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие события; или Нет. |
as_handoff_activity
Возвращает это действие в виде объекта HandoffActivity; или Нет, если это не тот тип действия.
as_handoff_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие передачи; или Нет. |
as_installation_update_activity
Возвращает это действие в виде объекта InstallationUpdateActivity; или Нет, если это не тот тип действия.
as_installation_update_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие обновления установки; или Нет. |
as_invoke_activity
Возвращает это действие в виде объекта InvokeActivity; или Нет, если это не тот тип действия.
as_invoke_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие вызова; или Нет. |
as_message_activity
Возвращает это действие в виде объекта MessageActivity; или Нет, если это не тот тип действия.
as_message_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие сообщения; или Нет. |
as_message_delete_activity
Возвращает это действие в виде объекта MessageDeleteActivity; или Нет, если это не тот тип действия.
as_message_delete_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как запрос на удаление сообщения; или Нет. |
as_message_reaction_activity
Возвращает это действие в виде объекта MessageReactionActivity; или Нет, если это не тот тип действия.
as_message_reaction_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие реакции на сообщение; или Нет. |
as_message_update_activity
Возвращает это действие в виде объекта MessageUpdateActivity; или Нет, если это не тот тип действия.
as_message_update_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как запрос на обновление сообщения; или Нет. |
as_suggestion_activity
Возвращает это действие в виде объекта SuggestionActivity; или Нет, если это не тот тип действия.
as_suggestion_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие предложения; или Нет. |
as_trace_activity
Возвращает это действие в виде объекта TraceActivity; или Нет, если это не тот тип действия.
as_trace_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие трассировки; или Нет. |
as_typing_activity
Возвращает это действие в виде объекта TypingActivity; или null, если это не тот тип действия.
as_typing_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Это действие как действие ввода; или null. |
create_contact_relation_update_activity
Создает экземпляр класса в Activity виде объектаContactRelationUpdateActivity.
static create_contact_relation_update_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие обновления связи контактов. |
create_conversation_update_activity
Создает экземпляр класса в Activity виде объекта ConversationUpdateActivity.
static create_conversation_update_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Действие обновления нового диалога. |
create_end_of_conversation_activity
Создает экземпляр класса в Activity виде объекта EndOfConversationActivity.
static create_end_of_conversation_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие завершения общения. |
create_event_activity
Создает экземпляр класса в Activity виде объекта EventActivity.
static create_event_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие события. |
create_handoff_activity
Создает экземпляр класса в Activity виде объекта HandoffActivity.
static create_handoff_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие передачи. |
create_invoke_activity
Создает экземпляр класса в Activity виде объекта InvokeActivity.
static create_invoke_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие invoke. |
create_message_activity
Создает экземпляр класса в Activity виде объекта MessageActivity.
static create_message_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие сообщения. |
create_reply
Создает новое действие сообщения в качестве ответа на это действие.
create_reply(text: str = None, locale: str = None)Параметры
| Имя | Описание |
|---|---|
|
text
|
Текст ответа. Default value: None
|
|
locale
|
Код языка для текста. Default value: None
|
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие сообщения. |
Комментарии
Новое действие настраивает сведения о маршрутизации на основе этого действия.
create_trace
Создает новое действие трассировки на основе этого действия.
Значение по умолчанию — это имя типа значения. :p меткаaram: необязательно, описательная метка для этой операции трассировки.
create_trace(name: str, value: object = None, value_type: str = None, label: str = None)Параметры
| Имя | Описание |
|---|---|
|
name
Обязательно
|
|
|
value
|
Default value: None
|
|
value_type
|
Default value: None
|
|
label
|
Default value: None
|
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие трассировки. |
create_trace_activity
Создает экземпляр класса в Activity виде объекта TraceActivity.
Значение по умолчанию — это имя типа значения. :p меткаaram: необязательно, описательная метка для этой операции трассировки.
static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)Параметры
| Имя | Описание |
|---|---|
|
name
Обязательно
|
|
|
value
|
Default value: None
|
|
value_type
|
Default value: None
|
|
label
|
Default value: None
|
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие трассировки. |
create_typing_activity
Создает экземпляр класса в Activity виде объекта TypingActivity.
static create_typing_activity()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Новое действие ввода. |
get_conversation_reference
Создает ConversationReference на основе этого действия.
get_conversation_reference()Возвращаемое значение
| Тип | Описание |
|---|---|
|
Ссылка на беседу для беседы, содержащей это действие. |
get_mentions
Разрешает упоминания из сущностей этого действия.
get_mentions() -> List[Mention]Возвращаемое значение
| Тип | Описание |
|---|---|
|
Массив упоминаний; или пустой массив, если ни один из них не найден. |
Комментарии
Этот метод определен в Activity классе , но предназначен только для использования с действием сообщения, где действие Activity.Type имеет значение ActivityTypes.Message.
get_reply_conversation_reference
Создайте ConversationReference на основе сведений о беседе этого действия и ResourceResponse от отправки действия.
get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReferenceПараметры
| Имя | Описание |
|---|---|
|
reply
Обязательно
|
ResourceResponse, возвращенный send_activity. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Объект ConversationReference, который можно сохранить и использовать позже для удаления или обновления действия. |
has_content
Указывает, содержит ли это действие содержимое.
has_content() -> boolВозвращаемое значение
| Тип | Описание |
|---|---|
|
True, если в этом действии есть содержимое для отправки; в противном случае — false. |
Комментарии
Этот метод определен в Activity классе , но предназначен только для использования с действием сообщения, где действие Activity.Type имеет значение ActivityTypes.Message.
is_from_streaming_connection
Определите, было ли действие отправлено через http/https-подключение или потоковую передачу. Это можно определить, просмотрев свойство service_url: (1) Все каналы, отправляющие сообщения по протоколу http/https, не являются потоковыми (2) Каналы, отправляющие сообщения через потоковую передачу, имеют ServiceUrl, который не начинается с http/https.
is_from_streaming_connection() -> boolВозвращаемое значение
| Тип | Описание |
|---|---|
|
Значение true, если действие возникло из потокового подключения. |