Compartir a través de


Activity Clase

Una actividad es el tipo de comunicación básico para el protocolo Bot Framework 3.0.

Herencia
msrest.serialization.Model
Activity

Constructor

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)

Parámetros

Nombre Description
type
Requerido
str o <xref:botframework.connector.models.ActivityTypes>

Contiene el tipo de actividad. Entre los valores posibles se incluyen: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

id
Requerido
str

Contiene un identificador que identifica de forma única la actividad en el canal.

timestamp
Requerido

Contiene la fecha y hora en que se envió el mensaje, en FORMATO UTC, expresado en formato ISO-8601.

local_timestamp
Requerido

Contiene la fecha y hora locales del mensaje expresado en formato ISO-8601. Por ejemplo, 2016-09-23T13:07:49.4714686-07:00.

local_timezone
Requerido
str

Contiene el nombre de la zona horaria local del mensaje, expresado en el formato de base de datos de zona horaria de IANA. Por ejemplo, America/Los_Angeles.

service_url
Requerido
str

Contiene la dirección URL que especifica el punto de conexión de servicio del canal. Se establece mediante el canal.

channel_id
Requerido
str

Contiene un identificador que identifica de forma única el canal. Se establece mediante el canal.

from_property
Requerido
<xref:botframework.connector.models.ChannelAccount>

Identifica al remitente del mensaje.

conversation
Requerido
<xref:botframework.connector.models.ConversationAccount>

Identifica la conversación a la que pertenece la actividad.

recipient
Requerido
<xref:botframework.connector.models.ChannelAccount>

Identifica al destinatario del mensaje.

text_format
Requerido
str o <xref:botframework.connector.models.TextFormatTypes>

Formato de los campos de texto Default:Markdown. Entre los valores posibles se incluyen: 'Markdown', 'plain', 'xml'

attachment_layout
Requerido
str o <xref:botframework.connector.models.AttachmentLayoutTypes>

Sugerencia de diseño para varios datos adjuntos. Valor predeterminado: lista. Entre los valores posibles se incluyen: "list", "carrusel".

members_added
Requerido
list[<xref:botframework.connector.models.ChannelAccount>]

Colección de miembros agregados a la conversación.

members_removed
Requerido
list[<xref:botframework.connector.models.ChannelAccount>]

Colección de miembros quitados de la conversación.

reactions_added
Requerido
list[<xref:botframework.connector.models.MessageReaction>]

Colección de reacciones agregada a la conversación.

reactions_removed
Requerido
list[<xref:botframework.connector.models.MessageReaction>]

Colección de reacciones eliminada de la conversación.

topic_name
Requerido
str

Nombre del tema actualizado de la conversación.

history_disclosed
Requerido

Indica si se revela el historial anterior del canal.

locale
Requerido
str

Nombre de configuración regional para el contenido del campo de texto. El nombre de la configuración regional es una combinación de un código de referencia cultural de dos o tres letras ISO 639 asociado a un idioma y un código de subcultura de dos letras ISO 3166 asociado a un país o región. El nombre de la configuración regional también puede corresponder a una etiqueta de idioma BCP-47 válida.

text
Requerido
str

Contenido de texto del mensaje.

speak
Requerido
str

Texto para hablar.

input_hint
Requerido
str o <xref:botframework.connector.models.InputHints>

Indica si el bot acepta, espera o omite la entrada del usuario después de que el mensaje se entregue al cliente. Entre los valores posibles se incluyen: 'acceptingInput', 'ignoreingInput', 'expectingInput'

summary
Requerido
str

Texto que se va a mostrar si el canal no puede representar tarjetas.

suggested_actions
Requerido
<xref:botframework.connector.models.SuggestedActions>

Las acciones sugeridas para la actividad.

attachments
Requerido
list[<xref:botframework.connector.models.Attachment>]

Datos adjuntos

entities
Requerido
list[<xref:botframework.connector.models.Entity>]

Representa las entidades mencionadas en el mensaje.

channel_data
Requerido

Contiene contenido específico del canal.

action
Requerido
str

Indica si el destinatario de un contactRelationUpdate se agregó o quitó de la lista de contactos del remitente.

reply_to_id
Requerido
str

Contiene el identificador del mensaje al que este mensaje es una respuesta.

label
Requerido
str

Una etiqueta descriptiva para la actividad.

value_type
Requerido
str

Tipo del objeto de valor de la actividad.

value
Requerido

Valor asociado a la actividad.

name
Requerido
str

Nombre de la operación asociada a una actividad de invocación o evento.

relates_to
Requerido
<xref:botframework.connector.models.ConversationReference>

Referencia a otra conversación o actividad.

code
Requerido
str o <xref:botframework.connector.models.EndOfConversationCodes>

Código para las actividades endOfConversation que indica por qué finalizó la conversación. Entre los valores posibles se incluyen: 'unknown', 'completedSuccessly', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

expiration
Requerido

La hora en que la actividad debería considerarse "expirada" y no debería presentarse al destinatario.

importance
Requerido
str o <xref:botframework.connector.models.ActivityImportance>

Importancia de la actividad. Entre los valores posibles se incluyen: "low", "normal", "high"

delivery_mode
Requerido
str o <xref:botframework.connector.models.DeliveryModes>

Una sugerencia de entrega para indicar al destinatario rutas de entrega alternativas para la actividad. El modo de entrega predeterminado es "predeterminado". Entre los valores posibles se incluyen: "normal", "notification", "expectReplies", "efímero".

listen_for
Requerido

Lista de frases y referencias que los sistemas de preparación de voz y lenguaje deben escuchar

text_highlights
Requerido
list[<xref:botframework.connector.models.TextHighlight>]

Colección de fragmentos de texto que se resaltarán cuando la actividad contiene un valor ReplyToId.

semantic_action
Requerido
<xref:botframework.connector.models.SemanticAction>

Una acción de programación opcional que acompaña a esta solicitud

caller_id
Requerido
str

Una cadena que contiene un IRI que identifica al autor de la llamada de un bot. Este campo no está pensado para transmitirse a través de la conexión, sino que los bots y los clientes lo rellenan basándose en datos comprobables criptográficamente que confirman la identidad de los autores de las llamadas (por ejemplo, tokens).

Parámetros de palabra clave únicamente

Nombre Description
type
Requerido
id
Requerido
timestamp
Requerido
local_timestamp
Requerido
local_timezone
Requerido
service_url
Requerido
channel_id
Requerido
from_property
Requerido
conversation
Requerido
recipient
Requerido
text_format
Requerido
attachment_layout
Requerido
members_added
Requerido
members_removed
Requerido
reactions_added
Requerido
reactions_removed
Requerido
topic_name
Requerido
history_disclosed
Requerido
locale
Requerido
text
Requerido
speak
Requerido
input_hint
Requerido
summary
Requerido
suggested_actions
Requerido
attachments
Requerido
entities
Requerido
channel_data
Requerido
action
Requerido
reply_to_id
Requerido
label
Requerido
value_type
Requerido
value
Requerido
name
Requerido
relates_to
Requerido
code
Requerido
expiration
Requerido
importance
Requerido
delivery_mode
Requerido
listen_for
Requerido
text_highlights
Requerido
semantic_action
Requerido
caller_id
Requerido

Métodos

apply_conversation_reference

Novedades esta actividad con la información de entrega de una conversationReference existente

actividad entrante, donde el bot es el destinatario; de lo contrario, False. El valor predeterminado es False y la actividad mostrará el bot como remitente.

as_contact_relation_update_activity

Devuelve esta actividad como un objeto ContactRelationUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_conversation_update_activity

Devuelve esta actividad como un objeto ConversationUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_end_of_conversation_activity

Devuelve esta actividad como un objeto EndOfConversationActivity; o Ninguno, si no es ese tipo de actividad.

as_event_activity

Devuelve esta actividad como un objeto EventActivity; o Ninguno, si no es ese tipo de actividad.

as_handoff_activity

Devuelve esta actividad como un objeto HandoffActivity; o Ninguno, si no es ese tipo de actividad.

as_installation_update_activity

Devuelve esta actividad como un objeto InstallationUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_invoke_activity

Devuelve esta actividad como un objeto InvokeActivity; o Ninguno, si no es ese tipo de actividad.

as_message_activity

Devuelve esta actividad como un objeto MessageActivity; o Ninguno, si no es ese tipo de actividad.

as_message_delete_activity

Devuelve esta actividad como un objeto MessageDeleteActivity; o Ninguno, si no es ese tipo de actividad.

as_message_reaction_activity

Devuelve esta actividad como un objeto MessageReactionActivity; o Ninguno, si no es ese tipo de actividad.

as_message_update_activity

Devuelve esta actividad como un objeto MessageUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_suggestion_activity

Devuelve esta actividad como un objeto SuggestionActivity; o Ninguno, si no es ese tipo de actividad.

as_trace_activity

Devuelve esta actividad como un objeto TraceActivity; o Ninguno, si no es ese tipo de actividad.

as_typing_activity

Devuelve esta actividad como un objeto TypingActivity; o null, si no es ese tipo de actividad.

create_contact_relation_update_activity

Crea una instancia de la Activity clase como un objetoContactRelationUpdateActivity.

create_conversation_update_activity

Crea una instancia de la Activity clase como un objeto ConversationUpdateActivity.

create_end_of_conversation_activity

Crea una instancia de la Activity clase como un objeto EndOfConversationActivity.

create_event_activity

Crea una instancia de la Activity clase como un objeto EventActivity.

create_handoff_activity

Crea una instancia de la Activity clase como un objeto HandoffActivity.

create_invoke_activity

Crea una instancia de la Activity clase como un objeto InvokeActivity.

create_message_activity

Crea una instancia de la Activity clase como un objeto MessageActivity.

create_reply

Crea una nueva actividad de mensaje como respuesta a esta actividad.

create_trace

Crea una nueva actividad de seguimiento basada en esta actividad.

El valor predeterminado es el nombre del tipo del valor. :p aram etiqueta: opcional, una etiqueta descriptiva para esta operación de seguimiento.

create_trace_activity

Crea una instancia de la Activity clase como un objeto TraceActivity.

El valor predeterminado es el nombre del tipo del valor. :p aram etiqueta: opcional, una etiqueta descriptiva para esta operación de seguimiento.

create_typing_activity

Crea una instancia de la Activity clase como un objeto TypingActivity.

get_conversation_reference

Crea una conversationReference basada en esta actividad.

get_mentions

Resuelve las menciones de las entidades de esta actividad.

get_reply_conversation_reference

Cree una ConversationReference basada en la información de conversación de esta actividad y resourceResponse desde el envío de una actividad.

has_content

Indica si esta actividad tiene contenido.

is_from_streaming_connection

Determine si la actividad se envió a través de una conexión Http/Https o Streaming Esto se puede determinar examinando la propiedad service_url: (1) Todos los canales que envían mensajes a través de http/https no son canales de streaming (2) los canales que envían mensajes a través de streaming tienen un ServiceUrl que no comienza con http/https.

apply_conversation_reference

Novedades esta actividad con la información de entrega de una conversationReference existente

actividad entrante, donde el bot es el destinatario; de lo contrario, False. El valor predeterminado es False y la actividad mostrará el bot como remitente.

apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)

Parámetros

Nombre Description
reference
Requerido
is_incoming
Valor predeterminado: False

Devoluciones

Tipo Description

su actividad, actualizada con la información de entrega.

Comentarios

Llame a GetConversationReference en una actividad entrante para obtener una referencia de conversación que puede usar para actualizar una actividad saliente con la información de entrega correcta.

as_contact_relation_update_activity

Devuelve esta actividad como un objeto ContactRelationUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_contact_relation_update_activity()

Devoluciones

Tipo Description

Esta actividad como una actividad de mensaje; o Ninguno.

as_conversation_update_activity

Devuelve esta actividad como un objeto ConversationUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_conversation_update_activity()

Devoluciones

Tipo Description

Esta actividad como actividad de actualización de conversación; o Ninguno.

as_end_of_conversation_activity

Devuelve esta actividad como un objeto EndOfConversationActivity; o Ninguno, si no es ese tipo de actividad.

as_end_of_conversation_activity()

Devoluciones

Tipo Description

Esta actividad como fin de la actividad de conversación; o Ninguno.

as_event_activity

Devuelve esta actividad como un objeto EventActivity; o Ninguno, si no es ese tipo de actividad.

as_event_activity()

Devoluciones

Tipo Description

Esta actividad como una actividad de evento; o Ninguno.

as_handoff_activity

Devuelve esta actividad como un objeto HandoffActivity; o Ninguno, si no es ese tipo de actividad.

as_handoff_activity()

Devoluciones

Tipo Description

Esta actividad como actividad de entrega; o Ninguno.

as_installation_update_activity

Devuelve esta actividad como un objeto InstallationUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_installation_update_activity()

Devoluciones

Tipo Description

Esta actividad como actividad de actualización de instalación; o Ninguno.

as_invoke_activity

Devuelve esta actividad como un objeto InvokeActivity; o Ninguno, si no es ese tipo de actividad.

as_invoke_activity()

Devoluciones

Tipo Description

Esta actividad como una actividad de invocación; o Ninguno.

as_message_activity

Devuelve esta actividad como un objeto MessageActivity; o Ninguno, si no es ese tipo de actividad.

as_message_activity()

Devoluciones

Tipo Description

Esta actividad como una actividad de mensaje; o Ninguno.

as_message_delete_activity

Devuelve esta actividad como un objeto MessageDeleteActivity; o Ninguno, si no es ese tipo de actividad.

as_message_delete_activity()

Devoluciones

Tipo Description

Esta actividad como una solicitud de eliminación de mensajes; o Ninguno.

as_message_reaction_activity

Devuelve esta actividad como un objeto MessageReactionActivity; o Ninguno, si no es ese tipo de actividad.

as_message_reaction_activity()

Devoluciones

Tipo Description

Esta actividad como una actividad de reacción de mensaje; o Ninguno.

as_message_update_activity

Devuelve esta actividad como un objeto MessageUpdateActivity; o Ninguno, si no es ese tipo de actividad.

as_message_update_activity()

Devoluciones

Tipo Description

Esta actividad como una solicitud de actualización de mensajes; o Ninguno.

as_suggestion_activity

Devuelve esta actividad como un objeto SuggestionActivity; o Ninguno, si no es ese tipo de actividad.

as_suggestion_activity()

Devoluciones

Tipo Description

Esta actividad como actividad de sugerencia; o Ninguno.

as_trace_activity

Devuelve esta actividad como un objeto TraceActivity; o Ninguno, si no es ese tipo de actividad.

as_trace_activity()

Devoluciones

Tipo Description

Esta actividad como actividad de seguimiento; o Ninguno.

as_typing_activity

Devuelve esta actividad como un objeto TypingActivity; o null, si no es ese tipo de actividad.

as_typing_activity()

Devoluciones

Tipo Description

Esta actividad como actividad de escritura; o null.

create_contact_relation_update_activity

Crea una instancia de la Activity clase como un objetoContactRelationUpdateActivity.

static create_contact_relation_update_activity()

Devoluciones

Tipo Description

Nueva actividad de actualización de relación de contacto.

create_conversation_update_activity

Crea una instancia de la Activity clase como un objeto ConversationUpdateActivity.

static create_conversation_update_activity()

Devoluciones

Tipo Description

Nueva actividad de actualización de conversación.

create_end_of_conversation_activity

Crea una instancia de la Activity clase como un objeto EndOfConversationActivity.

static create_end_of_conversation_activity()

Devoluciones

Tipo Description

Nuevo final de la actividad de conversación.

create_event_activity

Crea una instancia de la Activity clase como un objeto EventActivity.

static create_event_activity()

Devoluciones

Tipo Description

Nueva actividad de eventos.

create_handoff_activity

Crea una instancia de la Activity clase como un objeto HandoffActivity.

static create_handoff_activity()

Devoluciones

Tipo Description

Nueva actividad de entrega.

create_invoke_activity

Crea una instancia de la Activity clase como un objeto InvokeActivity.

static create_invoke_activity()

Devoluciones

Tipo Description

Nueva actividad de invocación.

create_message_activity

Crea una instancia de la Activity clase como un objeto MessageActivity.

static create_message_activity()

Devoluciones

Tipo Description

Nueva actividad de mensaje.

create_reply

Crea una nueva actividad de mensaje como respuesta a esta actividad.

create_reply(text: str = None, locale: str = None)

Parámetros

Nombre Description
text

Texto de la respuesta.

Valor predeterminado: None
locale

Código de idioma del texto.

Valor predeterminado: None

Devoluciones

Tipo Description

Nueva actividad de mensaje.

Comentarios

La nueva actividad configura información de enrutamiento basada en esta actividad.

create_trace

Crea una nueva actividad de seguimiento basada en esta actividad.

El valor predeterminado es el nombre del tipo del valor. :p aram etiqueta: opcional, una etiqueta descriptiva para esta operación de seguimiento.

create_trace(name: str, value: object = None, value_type: str = None, label: str = None)

Parámetros

Nombre Description
name
Requerido
value
Valor predeterminado: None
value_type
Valor predeterminado: None
label
Valor predeterminado: None

Devoluciones

Tipo Description

Nueva actividad de seguimiento.

create_trace_activity

Crea una instancia de la Activity clase como un objeto TraceActivity.

El valor predeterminado es el nombre del tipo del valor. :p aram etiqueta: opcional, una etiqueta descriptiva para esta operación de seguimiento.

static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)

Parámetros

Nombre Description
name
Requerido
value
Valor predeterminado: None
value_type
Valor predeterminado: None
label
Valor predeterminado: None

Devoluciones

Tipo Description

Nueva actividad de seguimiento.

create_typing_activity

Crea una instancia de la Activity clase como un objeto TypingActivity.

static create_typing_activity()

Devoluciones

Tipo Description

Nueva actividad de escritura.

get_conversation_reference

Crea una conversationReference basada en esta actividad.

get_conversation_reference()

Devoluciones

Tipo Description

Referencia de conversación para la conversación que contiene esta actividad.

get_mentions

Resuelve las menciones de las entidades de esta actividad.

get_mentions() -> List[Mention]

Devoluciones

Tipo Description

Matriz de menciones; o una matriz vacía, si no se encuentra ninguna.

Comentarios

Este método se define en la Activity clase , pero solo está pensado para su uso con una actividad de mensaje, donde la actividad Activity.Type se establece en ActivityTypes.Message.

get_reply_conversation_reference

Cree una ConversationReference basada en la información de conversación de esta actividad y resourceResponse desde el envío de una actividad.

get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReference

Parámetros

Nombre Description
reply
Requerido

ResourceResponse devuelto de send_activity.

Devoluciones

Tipo Description

ConversationReference que se puede almacenar y usar más adelante para eliminar o actualizar la actividad.

has_content

Indica si esta actividad tiene contenido.

has_content() -> bool

Devoluciones

Tipo Description

True, si esta actividad tiene contenido que se va a enviar; de lo contrario, false.

Comentarios

Este método se define en la Activity clase , pero solo está pensado para su uso con una actividad de mensaje, donde la actividad Activity.Type se establece en ActivityTypes.Message.

is_from_streaming_connection

Determine si la actividad se envió a través de una conexión Http/Https o Streaming Esto se puede determinar examinando la propiedad service_url: (1) Todos los canales que envían mensajes a través de http/https no son canales de streaming (2) los canales que envían mensajes a través de streaming tienen un ServiceUrl que no comienza con http/https.

is_from_streaming_connection() -> bool

Devoluciones

Tipo Description

True si la actividad se originó en una conexión de streaming.