Activity interface

Pacote:

botframework-schema

Uma atividade é o tipo de comunicação básico para o protocolo Bot Framework 3.0.

Propriedades

action	Indica se o destinatário de um contactRelationUpdate foi adicionado ou removido da lista de contatos do remetente.
attachmentLayout	A dica de layout para vários anexos. Padrão: lista. Os valores possíveis incluem: 'list', 'carrossel'
attachments	Anexos
callerId	Uma cadeia de caracteres que contém um URI que identifica o chamador de um bot. Esse campo não se destina a ser transmitido pela transmissão, mas é preenchido por bots e clientes com base em dados criptograficamente verificáveis que declaram a identidade dos chamadores (por exemplo, tokens).
channelData	Contém conteúdo específico do canal.
channelId	Contém uma ID que identifica exclusivamente o canal. Definido pelo canal.
code	O código para atividades endOfConversation que indica por que a conversa terminou. Os valores possíveis incluem: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
conversation	Identifica a conversa à qual a atividade pertence.
deliveryMode	Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade. O modo de entrega padrão é "padrão". Os valores possíveis incluem: 'normal', 'notification', 'expectReplies', 'efêmero'
entities	Representa as entidades mencionadas na mensagem.
expiration	O momento em que a atividade deve ser considerada "expirada" e não deve ser apresentada ao destinatário.
from	Identifica o remetente da mensagem.
historyDisclosed	Indica se o histórico anterior do canal é divulgado.
id	Contém uma ID que identifica exclusivamente a atividade no canal.
importance	A importância da atividade. Os valores possíveis incluem: 'baixo', 'normal', 'alto'
inputHint	Indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. Os valores possíveis incluem: 'acceptingInput', 'ignoringInput', 'expectingInput'
label	Um rótulo descritivo para a atividade.
listenFor	Lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar
locale	Um nome de localidade para o conteúdo do campo de texto. O nome da localidade é uma combinação de um código de cultura ISO 639 de duas ou três letras associado a uma linguagem e um código de subcultura iso 3166 de duas letras associado a um país ou região. O nome da localidade também pode corresponder a uma marca de idioma BCP-47 válida.
localTimestamp	Contém a data e a hora locais da mensagem, expressa no formato ISO-8601. Por exemplo, 2016-09-23T13:07:49.4714686-07:00.
localTimezone	Contém o nome do fuso horário local da mensagem, expresso no formato de banco de dados de Fuso Horário IANA. Por exemplo, América/Los_Angeles.
membersAdded	A coleção de membros adicionada à conversa.
membersRemoved	A coleção de membros removidos da conversa.
name	O nome da operação associada a uma atividade de invocação ou evento.
reactionsAdded	A coleção de reações adicionadas à conversa.
reactionsRemoved	A coleção de reações removidas da conversa.
recipient	Identifica o destinatário da mensagem.
relatesTo	Uma referência a outra conversa ou atividade.
replyToId	Contém a ID da mensagem à qual essa mensagem é uma resposta.
semanticAction	Uma ação programática opcional que acompanha essa solicitação
serviceUrl	Contém a URL que especifica o ponto de extremidade de serviço do canal. Definido pelo canal.
speak	O texto a ser falado.
suggestedActions	As ações sugeridas para a atividade.
summary	O texto a ser exibido se o canal não puder renderizar cartões.
text	O conteúdo do texto da mensagem.
textFormat	Formato dos campos de texto Padrão:markdown. Os valores possíveis incluem: 'markdown', 'plain', 'xml'
textHighlights	A coleção de fragmentos de texto a ser realçada quando a atividade contém um valor ReplyToId.
timestamp	Contém a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601.
topicName	O nome do tópico atualizado da conversa.
type	Contém o tipo de atividade. Os valores possíveis incluem: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'
value	Um valor associado à atividade.
valueType	O tipo do objeto de valor da atividade.

Detalhes da propriedade

action

Indica se o destinatário de um contactRelationUpdate foi adicionado ou removido da lista de contatos do remetente.

action?: string

Valor da propriedade

string

attachmentLayout

A dica de layout para vários anexos. Padrão: lista. Os valores possíveis incluem: 'list', 'carrossel'

attachmentLayout?: AttachmentLayoutTypes | string

Valor da propriedade

AttachmentLayoutTypes | string

attachments

Anexos

attachments?: Attachment[]

Valor da propriedade

Attachment[]

callerId

Uma cadeia de caracteres que contém um URI que identifica o chamador de um bot. Esse campo não se destina a ser transmitido pela transmissão, mas é preenchido por bots e clientes com base em dados criptograficamente verificáveis que declaram a identidade dos chamadores (por exemplo, tokens).

callerId: string

Valor da propriedade

string

channelData

Contém conteúdo específico do canal.

channelData?: any

Valor da propriedade

any

channelId

Contém uma ID que identifica exclusivamente o canal. Definido pelo canal.

channelId: string

Valor da propriedade

string

code

O código para atividades endOfConversation que indica por que a conversa terminou. Os valores possíveis incluem: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

code?: EndOfConversationCodes | string

Valor da propriedade

EndOfConversationCodes | string

conversation

Identifica a conversa à qual a atividade pertence.

conversation: ConversationAccount

Valor da propriedade

ConversationAccount

deliveryMode

Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade. O modo de entrega padrão é "padrão". Os valores possíveis incluem: 'normal', 'notification', 'expectReplies', 'efêmero'

deliveryMode?: DeliveryModes | string

Valor da propriedade

DeliveryModes | string

entities

Representa as entidades mencionadas na mensagem.

entities?: Entity[]

Valor da propriedade

Entity[]

expiration

O momento em que a atividade deve ser considerada "expirada" e não deve ser apresentada ao destinatário.

expiration?: Date

Valor da propriedade

Date

from

Identifica o remetente da mensagem.

from: ChannelAccount

Valor da propriedade

ChannelAccount

historyDisclosed

Indica se o histórico anterior do canal é divulgado.

historyDisclosed?: boolean

Valor da propriedade

boolean

id

Contém uma ID que identifica exclusivamente a atividade no canal.

id?: string

Valor da propriedade

string

importance

A importância da atividade. Os valores possíveis incluem: 'baixo', 'normal', 'alto'

importance?: ActivityImportance | string

Valor da propriedade

ActivityImportance | string

inputHint

Indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. Os valores possíveis incluem: 'acceptingInput', 'ignoringInput', 'expectingInput'

inputHint?: InputHints | string

Valor da propriedade

InputHints | string

label

Um rótulo descritivo para a atividade.

label: string

Valor da propriedade

string

listenFor

Lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar

listenFor: string[]

Valor da propriedade

string[]

locale

Um nome de localidade para o conteúdo do campo de texto. O nome da localidade é uma combinação de um código de cultura ISO 639 de duas ou três letras associado a uma linguagem e um código de subcultura iso 3166 de duas letras associado a um país ou região. O nome da localidade também pode corresponder a uma marca de idioma BCP-47 válida.

locale?: string

Valor da propriedade

string

localTimestamp

Contém a data e a hora locais da mensagem, expressa no formato ISO-8601. Por exemplo, 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: Date

Valor da propriedade

Date

localTimezone

Contém o nome do fuso horário local da mensagem, expresso no formato de banco de dados de Fuso Horário IANA. Por exemplo, América/Los_Angeles.

localTimezone: string

Valor da propriedade

string

membersAdded

A coleção de membros adicionada à conversa.

membersAdded?: ChannelAccount[]

Valor da propriedade

ChannelAccount[]

membersRemoved

A coleção de membros removidos da conversa.

membersRemoved?: ChannelAccount[]

Valor da propriedade

ChannelAccount[]

name

O nome da operação associada a uma atividade de invocação ou evento.

name?: ActivityEventNames | string

Valor da propriedade

ActivityEventNames | string

reactionsAdded

A coleção de reações adicionadas à conversa.

reactionsAdded?: MessageReaction[]

Valor da propriedade

MessageReaction[]

reactionsRemoved

A coleção de reações removidas da conversa.

reactionsRemoved?: MessageReaction[]

Valor da propriedade

MessageReaction[]

recipient

Identifica o destinatário da mensagem.

recipient: ChannelAccount

Valor da propriedade

ChannelAccount

relatesTo

Uma referência a outra conversa ou atividade.

relatesTo?: ConversationReference

Valor da propriedade

ConversationReference

replyToId

Contém a ID da mensagem à qual essa mensagem é uma resposta.

replyToId?: string

Valor da propriedade

string

semanticAction

Uma ação programática opcional que acompanha essa solicitação

semanticAction?: SemanticAction

Valor da propriedade

SemanticAction

serviceUrl

Contém a URL que especifica o ponto de extremidade de serviço do canal. Definido pelo canal.

serviceUrl: string

Valor da propriedade

string

speak

O texto a ser falado.

speak?: string

Valor da propriedade

string

suggestedActions

As ações sugeridas para a atividade.

suggestedActions?: SuggestedActions

Valor da propriedade

SuggestedActions

summary

O texto a ser exibido se o canal não puder renderizar cartões.

summary?: string

Valor da propriedade

string

text

O conteúdo do texto da mensagem.

text: string

Valor da propriedade

string

textFormat

Formato dos campos de texto Padrão:markdown. Os valores possíveis incluem: 'markdown', 'plain', 'xml'

textFormat?: TextFormatTypes | string

Valor da propriedade

TextFormatTypes | string

textHighlights

A coleção de fragmentos de texto a ser realçada quando a atividade contém um valor ReplyToId.

textHighlights?: TextHighlight[]

Valor da propriedade

TextHighlight[]

timestamp

Contém a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601.

timestamp?: Date

Valor da propriedade

Date

topicName

O nome do tópico atualizado da conversa.

topicName?: string

Valor da propriedade

string

type

Contém o tipo de atividade. Os valores possíveis incluem: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

type: ActivityTypes | string

Valor da propriedade

ActivityTypes | string

value

Um valor associado à atividade.

value?: any

Valor da propriedade

any

valueType

O tipo do objeto de valor da atividade.

valueType: string

Valor da propriedade

string