Activity interface

  • Referencia
Paquete:
botframework-schema

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

Propiedades

action

Indica si el destinatario de una contactRelationUpdate se ha agregado o quitado de la lista de contactos del remitente.
attachmentLayout

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

Datos adjuntos
callerId

Cadena que contiene un URI 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).
channelData

Contiene contenido específico del canal.
channelId

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

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

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

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

Representa las entidades mencionadas en el mensaje.
expiration

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

Identifica al remitente del mensaje.
historyDisclosed

Indica si se revela el historial anterior del canal.
id

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

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

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

Una etiqueta descriptiva para la actividad.
listenFor

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

Nombre de configuración regional del 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.
localTimestamp

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

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.
membersAdded

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

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

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

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

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

Identifica el destinatario del mensaje.
relatesTo

Referencia a otra conversación o actividad.
replyToId

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

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

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

Texto para hablar.
suggestedActions

Las acciones sugeridas para la actividad.
summary

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

Contenido de texto del mensaje.
textFormat

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

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

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

Nombre del tema actualizado de la conversación.
type

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'
value

Valor asociado a la actividad.
valueType

Tipo del objeto de valor de la actividad.

Detalles de las propiedades

action

Indica si el destinatario de una contactRelationUpdate se ha agregado o quitado de la lista de contactos del remitente.

action?: string

Valor de propiedad

string

attachmentLayout

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

attachmentLayout?: AttachmentLayoutTypes | string

Valor de propiedad

AttachmentLayoutTypes | string

attachments

Datos adjuntos

attachments?: Attachment[]

Valor de propiedad

Attachment[]

callerId

Cadena que contiene un URI 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).

callerId: string

Valor de propiedad

string

channelData

Contiene contenido específico del canal.

channelData?: any

Valor de propiedad

any

channelId

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

channelId: string

Valor de propiedad

string

code

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

code?: EndOfConversationCodes | string

Valor de propiedad

EndOfConversationCodes | string

conversation

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

conversation: ConversationAccount

Valor de propiedad

ConversationAccount

deliveryMode

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

deliveryMode?: DeliveryModes | string

Valor de propiedad

DeliveryModes | string

entities

Representa las entidades mencionadas en el mensaje.

entities?: Entity[]

Valor de propiedad

Entity[]

expiration

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

expiration?: Date

Valor de propiedad

Date

from

Identifica al remitente del mensaje.

from: ChannelAccount

Valor de propiedad

ChannelAccount

historyDisclosed

Indica si se revela el historial anterior del canal.

historyDisclosed?: boolean

Valor de propiedad

boolean

id

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

id?: string

Valor de propiedad

string

importance

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

importance?: ActivityImportance | string

Valor de propiedad

ActivityImportance | string

inputHint

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

inputHint?: InputHints | string

Valor de propiedad

InputHints | string

label

Una etiqueta descriptiva para la actividad.

label: string

Valor de propiedad

string

listenFor

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

listenFor: string[]

Valor de propiedad

string[]

locale

Nombre de configuración regional del 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.

locale?: string

Valor de propiedad

string

localTimestamp

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

localTimestamp?: Date

Valor de propiedad

Date

localTimezone

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.

localTimezone: string

Valor de propiedad

string

membersAdded

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

membersAdded?: ChannelAccount[]

Valor de propiedad

ChannelAccount[]

membersRemoved

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

membersRemoved?: ChannelAccount[]

Valor de propiedad

ChannelAccount[]

name

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

name?: ActivityEventNames | string

Valor de propiedad

ActivityEventNames | string

reactionsAdded

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

reactionsAdded?: MessageReaction[]

Valor de propiedad

MessageReaction[]

reactionsRemoved

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

reactionsRemoved?: MessageReaction[]

Valor de propiedad

MessageReaction[]

recipient

Identifica el destinatario del mensaje.

recipient: ChannelAccount

Valor de propiedad

ChannelAccount

relatesTo

Referencia a otra conversación o actividad.

relatesTo?: ConversationReference

Valor de propiedad

ConversationReference

replyToId

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

replyToId?: string

Valor de propiedad

string

semanticAction

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

semanticAction?: SemanticAction

Valor de propiedad

SemanticAction

serviceUrl

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

serviceUrl: string

Valor de propiedad

string

speak

Texto para hablar.

speak?: string

Valor de propiedad

string

suggestedActions

Las acciones sugeridas para la actividad.

suggestedActions?: SuggestedActions

Valor de propiedad

SuggestedActions

summary

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

summary?: string

Valor de propiedad

string

text

Contenido de texto del mensaje.

text: string

Valor de propiedad

string

textFormat

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

textFormat?: TextFormatTypes | string

Valor de propiedad

TextFormatTypes | string

textHighlights

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

textHighlights?: TextHighlight[]

Valor de propiedad

TextHighlight[]

timestamp

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

timestamp?: Date

Valor de propiedad

Date

topicName

Nombre del tema actualizado de la conversación.

topicName?: string

Valor de propiedad

string

type

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'

type: ActivityTypes | string

Valor de propiedad

ActivityTypes | string

value

Valor asociado a la actividad.

value?: any

Valor de propiedad

any

valueType

Tipo del objeto de valor de la actividad.

valueType: string

Valor de propiedad

string