Condividi tramite

Activity interface

  • Riferimento
Pacchetto:
botframework-schema

Un'attività è il tipo di comunicazione di base per il protocollo Bot Framework 3.0.

Proprietà

action

Indica se il destinatario di un contactRelationUpdate è stato aggiunto o rimosso dall'elenco contatti del mittente.
attachmentLayout

Hint di layout per più allegati. Impostazione predefinita: elenco. I valori possibili includono: 'list', 'carousel'
attachments

Allegati
callerId

Stringa contenente un URI che identifica il chiamante di un bot. Questo campo non deve essere trasmesso in rete, ma viene popolato da bot e client basati su dati verificabili crittograficamente che asserisce l'identità dei chiamanti (ad esempio token).
channelData

Contiene contenuto specifico del canale.
channelId

Contiene un ID che identifica in modo univoco il canale. Impostato dal canale.
code

Codice per le attività endOfConversation che indica il motivo per cui la conversazione è terminata. I valori possibili includono: 'unknown', 'completedSuccessly', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
conversation

Identifica la conversazione a cui appartiene l'attività.
deliveryMode

Suggerimento di recapito per segnalare al destinatario percorsi di recapito alternativi per l'attività. La modalità di recapito predefinita è "default". I valori possibili includono: 'normal', 'notification', 'expectReplies', 'ephemeral'
entities

Rappresenta le entità menzionate nel messaggio.
expiration

Il momento in cui l'attività deve essere considerata "scaduta" e non deve essere presentata al destinatario.
from

Identifica il mittente del messaggio.
historyDisclosed

Indica se la cronologia precedente del canale viene divulgata.
id

Contiene un ID che identifica in modo univoco l'attività nel canale.
importance

Importanza dell'attività. I valori possibili includono: 'low', 'normal', 'high'
inputHint

Indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. I valori possibili includono: 'acceptingInput', 'ignoringInput', 'expectingInput'
label

Etichetta descrittiva per l'attività.
listenFor

Elenco di frasi e riferimenti per i quali i sistemi di priming del parlato e della lingua devono essere in ascolto
locale

Nome delle impostazioni locali per il contenuto del campo di testo. Il nome delle impostazioni locali è una combinazione di codice delle impostazioni cultura ISO 639 a due o tre lettere associato a una lingua e a un codice di sottoculture a due lettere ISO 3166 associato a un paese o a un'area geografica. Il nome delle impostazioni locali può corrispondere anche a un tag di lingua BCP-47 valido.
localTimestamp

Contiene la data e l'ora locali del messaggio, espressa in formato ISO-8601. Ad esempio, 2016-09-23T13:07:49.4714686-07:00.
localTimezone

Contiene il nome del fuso orario locale del messaggio, espresso in formato di database del fuso orario IANA. Ad esempio, America/Los_Angeles.
membersAdded

Raccolta di membri aggiunti alla conversazione.
membersRemoved

Raccolta di membri rimossi dalla conversazione.
name

Nome dell'operazione associata a un'attività invoke o evento.
reactionsAdded

Raccolta di reazioni aggiunte alla conversazione.
reactionsRemoved

Raccolta di reazioni rimosse dalla conversazione.
recipient

Identifica il destinatario del messaggio.
relatesTo

Riferimento a un'altra conversazione o attività.
replyToId

Contiene l'ID del messaggio a cui il messaggio è una risposta.
semanticAction

Azione a livello di codice facoltativa associata a questa richiesta
serviceUrl

Contiene l'URL che specifica l'endpoint del servizio del canale. Impostato dal canale.
speak

Testo da pronunciare.
suggestedActions

Azioni suggerite per l'attività.
summary

Testo da visualizzare se il canale non è in grado di eseguire il rendering delle schede.
text

Contenuto di testo del messaggio.
textFormat

Formato dei campi di testo Default:markdown. I valori possibili includono: 'markdown', 'plain', 'xml'
textHighlights

Raccolta di frammenti di testo da evidenziare quando l'attività contiene un valore ReplyToId.
timestamp

Contiene la data e l'ora in cui il messaggio è stato inviato, in formato UTC, espresso in formato ISO-8601.
topicName

Nome dell'argomento aggiornato della conversazione.
type

Contiene il tipo di attività. I valori possibili includono: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'
value

Valore associato all'attività.
valueType

Tipo dell'oggetto valore dell'attività.

Dettagli proprietà

action

Indica se il destinatario di un contactRelationUpdate è stato aggiunto o rimosso dall'elenco contatti del mittente.

action?: string

Valore della proprietà

string

attachmentLayout

Hint di layout per più allegati. Impostazione predefinita: elenco. I valori possibili includono: 'list', 'carousel'

attachmentLayout?: AttachmentLayoutTypes | string

Valore della proprietà

AttachmentLayoutTypes | string

attachments

Allegati

attachments?: Attachment[]

Valore della proprietà

Attachment[]

callerId

Stringa contenente un URI che identifica il chiamante di un bot. Questo campo non deve essere trasmesso in rete, ma viene popolato da bot e client basati su dati verificabili crittograficamente che asserisce l'identità dei chiamanti (ad esempio token).

callerId: string

Valore della proprietà

string

channelData

Contiene contenuto specifico del canale.

channelData?: any

Valore della proprietà

any

channelId

Contiene un ID che identifica in modo univoco il canale. Impostato dal canale.

channelId: string

Valore della proprietà

string

code

Codice per le attività endOfConversation che indica il motivo per cui la conversazione è terminata. I valori possibili includono: 'unknown', 'completedSuccessly', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

code?: EndOfConversationCodes | string

Valore della proprietà

EndOfConversationCodes | string

conversation

Identifica la conversazione a cui appartiene l'attività.

conversation: ConversationAccount

Valore della proprietà

ConversationAccount

deliveryMode

Suggerimento di recapito per segnalare al destinatario percorsi di recapito alternativi per l'attività. La modalità di recapito predefinita è "default". I valori possibili includono: 'normal', 'notification', 'expectReplies', 'ephemeral'

deliveryMode?: DeliveryModes | string

Valore della proprietà

DeliveryModes | string

entities

Rappresenta le entità menzionate nel messaggio.

entities?: Entity[]

Valore della proprietà

Entity[]

expiration

Il momento in cui l'attività deve essere considerata "scaduta" e non deve essere presentata al destinatario.

expiration?: Date

Valore della proprietà

Date

from

Identifica il mittente del messaggio.

from: ChannelAccount

Valore della proprietà

ChannelAccount

historyDisclosed

Indica se la cronologia precedente del canale viene divulgata.

historyDisclosed?: boolean

Valore della proprietà

boolean

id

Contiene un ID che identifica in modo univoco l'attività nel canale.

id?: string

Valore della proprietà

string

importance

Importanza dell'attività. I valori possibili includono: 'low', 'normal', 'high'

importance?: ActivityImportance | string

Valore della proprietà

ActivityImportance | string

inputHint

Indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. I valori possibili includono: 'acceptingInput', 'ignoringInput', 'expectingInput'

inputHint?: InputHints | string

Valore della proprietà

InputHints | string

label

Etichetta descrittiva per l'attività.

label: string

Valore della proprietà

string

listenFor

Elenco di frasi e riferimenti per i quali i sistemi di priming del parlato e della lingua devono essere in ascolto

listenFor: string[]

Valore della proprietà

string[]

locale

Nome delle impostazioni locali per il contenuto del campo di testo. Il nome delle impostazioni locali è una combinazione di codice delle impostazioni cultura ISO 639 a due o tre lettere associato a una lingua e a un codice di sottoculture a due lettere ISO 3166 associato a un paese o a un'area geografica. Il nome delle impostazioni locali può corrispondere anche a un tag di lingua BCP-47 valido.

locale?: string

Valore della proprietà

string

localTimestamp

Contiene la data e l'ora locali del messaggio, espressa in formato ISO-8601. Ad esempio, 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: Date

Valore della proprietà

Date

localTimezone

Contiene il nome del fuso orario locale del messaggio, espresso in formato di database del fuso orario IANA. Ad esempio, America/Los_Angeles.

localTimezone: string

Valore della proprietà

string

membersAdded

Raccolta di membri aggiunti alla conversazione.

membersAdded?: ChannelAccount[]

Valore della proprietà

ChannelAccount[]

membersRemoved

Raccolta di membri rimossi dalla conversazione.

membersRemoved?: ChannelAccount[]

Valore della proprietà

ChannelAccount[]

name

Nome dell'operazione associata a un'attività invoke o evento.

name?: ActivityEventNames | string

Valore della proprietà

ActivityEventNames | string

reactionsAdded

Raccolta di reazioni aggiunte alla conversazione.

reactionsAdded?: MessageReaction[]

Valore della proprietà

MessageReaction[]

reactionsRemoved

Raccolta di reazioni rimosse dalla conversazione.

reactionsRemoved?: MessageReaction[]

Valore della proprietà

MessageReaction[]

recipient

Identifica il destinatario del messaggio.

recipient: ChannelAccount

Valore della proprietà

ChannelAccount

relatesTo

Riferimento a un'altra conversazione o attività.

relatesTo?: ConversationReference

Valore della proprietà

ConversationReference

replyToId

Contiene l'ID del messaggio a cui il messaggio è una risposta.

replyToId?: string

Valore della proprietà

string

semanticAction

Azione a livello di codice facoltativa associata a questa richiesta

semanticAction?: SemanticAction

Valore della proprietà

SemanticAction

serviceUrl

Contiene l'URL che specifica l'endpoint del servizio del canale. Impostato dal canale.

serviceUrl: string

Valore della proprietà

string

speak

Testo da pronunciare.

speak?: string

Valore della proprietà

string

suggestedActions

Azioni suggerite per l'attività.

suggestedActions?: SuggestedActions

Valore della proprietà

SuggestedActions

summary

Testo da visualizzare se il canale non è in grado di eseguire il rendering delle schede.

summary?: string

Valore della proprietà

string

text

Contenuto di testo del messaggio.

text: string

Valore della proprietà

string

textFormat

Formato dei campi di testo Default:markdown. I valori possibili includono: 'markdown', 'plain', 'xml'

textFormat?: TextFormatTypes | string

Valore della proprietà

TextFormatTypes | string

textHighlights

Raccolta di frammenti di testo da evidenziare quando l'attività contiene un valore ReplyToId.

textHighlights?: TextHighlight[]

Valore della proprietà

TextHighlight[]

timestamp

Contiene la data e l'ora in cui il messaggio è stato inviato, in formato UTC, espresso in formato ISO-8601.

timestamp?: Date

Valore della proprietà

Date

topicName

Nome dell'argomento aggiornato della conversazione.

topicName?: string

Valore della proprietà

string

type

Contiene il tipo di attività. I valori possibili includono: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

type: ActivityTypes | string

Valore della proprietà

ActivityTypes | string

value

Valore associato all'attività.

value?: any

Valore della proprietà

any

valueType

Tipo dell'oggetto valore dell'attività.

valueType: string

Valore della proprietà

string