Share via

Activity interface

  • Référence
Paquet:
botframework-schema

Une activité est le type de communication de base pour le protocole Bot Framework 3.0.

Propriétés

action

Indique si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur.
attachmentLayout

Indicateur de disposition pour plusieurs pièces jointes. Valeur par défaut : liste. Les valeurs possibles sont les suivantes : 'list', 'carrousel'
attachments

Pièces jointes
callerId

Chaîne contenant un URI identifiant l’appelant d’un bot. Ce champ n’est pas destiné à être transmis sur le réseau, mais il est rempli par les bots et les clients basés sur des données vérifiables par chiffrement qui déclarent l’identité des appelants (par exemple des jetons).
channelData

Contient du contenu spécifique au canal.
channelId

Contient un ID qui identifie de manière unique le canal. Défini par le canal.
code

Code pour les activités endOfConversation qui indique la raison pour laquelle la conversation s’est terminée. Les valeurs possibles sont les suivantes : 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
conversation

Identifie la conversation à laquelle l’activité appartient.
deliveryMode

Indicateur de distribution pour signaler au destinataire d’autres chemins de distribution pour l’activité. Le mode de remise par défaut est « default ». Les valeurs possibles sont les suivantes : 'normal', 'notification', 'expectReplies', 'éphémère'
entities

Représente les entités qui ont été mentionnées dans le message.
expiration

Heure à laquelle l’activité doit être considérée comme étant « expirée » et ne doit pas être présentée au destinataire.
from

Identifie l’expéditeur du message.
historyDisclosed

Indique si l’historique antérieur du canal est divulgué.
id

Contient un ID qui identifie de manière unique l’activité sur le canal.
importance

Importance de l’activité. Les valeurs possibles sont les suivantes : 'low', 'normal', 'high'
inputHint

Indique si votre bot accepte, attend ou ignore l’entrée utilisateur une fois le message remis au client. Les valeurs possibles sont les suivantes : 'acceptInput', 'ignoringInput', 'expectingInput'
label

Étiquette descriptive de l’activité.
listenFor

Liste d’expressions et de références que les systèmes d’amorçage vocal et linguistique doivent écouter
locale

Nom des paramètres régionaux pour le contenu du champ de texte. Le nom des paramètres régionaux est une combinaison d’un code de culture ISO 639 à deux ou trois lettres associé à une langue et d’un code de sous-culture ISO 3166 à deux lettres associé à un pays ou à une région. Le nom des paramètres régionaux peut également correspondre à une balise de langue BCP-47 valide.
localTimestamp

Contient la date et l’heure locales du message, exprimées au format ISO-8601. Par exemple, 2016-09-23T13:07:49.4714686-07:00.
localTimezone

Contient le nom du fuseau horaire local du message, exprimé au format de base de données de fuseau horaire IANA. Par exemple, America/Los_Angeles.
membersAdded

Collection de membres ajoutés à la conversation.
membersRemoved

Collection de membres supprimés de la conversation.
name

Nom de l’opération associée à une activité d’appel ou d’événement.
reactionsAdded

Collection de réactions ajoutées à la conversation.
reactionsRemoved

Collection de réactions supprimées de la conversation.
recipient

Identifie le destinataire du message.
relatesTo

Référence à une autre conversation ou activité.
replyToId

Contient l’ID du message auquel ce message est une réponse.
semanticAction

Action par programme facultative accompagnant cette demande
serviceUrl

Contient l’URL qui spécifie le point de terminaison de service du canal. Défini par le canal.
speak

Texte à lire.
suggestedActions

Actions suggérées pour l’activité.
summary

Texte à afficher si le canal ne peut pas afficher les cartes.
text

Contenu textuel du message.
textFormat

Format des champs de texte Default:markdown. Les valeurs possibles sont les suivantes : 'markdown', 'plain', 'xml'
textHighlights

Collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur ReplyToId.
timestamp

Contient la date et l’heure d’envoi du message, en UTC, exprimées au format ISO-8601.
topicName

Nom de la rubrique mise à jour de la conversation.
type

Contient le type d’activité. Les valeurs possibles sont les suivantes : 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'
value

Valeur associée à l’activité.
valueType

Type de l’objet de valeur de l’activité.

Détails de la propriété

action

Indique si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur.

action?: string

Valeur de propriété

string

attachmentLayout

Indicateur de disposition pour plusieurs pièces jointes. Valeur par défaut : liste. Les valeurs possibles sont les suivantes : 'list', 'carrousel'

attachmentLayout?: AttachmentLayoutTypes | string

Valeur de propriété

AttachmentLayoutTypes | string

attachments

Pièces jointes

attachments?: Attachment[]

Valeur de propriété

Attachment[]

callerId

Chaîne contenant un URI identifiant l’appelant d’un bot. Ce champ n’est pas destiné à être transmis sur le réseau, mais il est rempli par les bots et les clients basés sur des données vérifiables par chiffrement qui déclarent l’identité des appelants (par exemple des jetons).

callerId: string

Valeur de propriété

string

channelData

Contient du contenu spécifique au canal.

channelData?: any

Valeur de propriété

any

channelId

Contient un ID qui identifie de manière unique le canal. Défini par le canal.

channelId: string

Valeur de propriété

string

code

Code pour les activités endOfConversation qui indique la raison pour laquelle la conversation s’est terminée. Les valeurs possibles sont les suivantes : 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

code?: EndOfConversationCodes | string

Valeur de propriété

EndOfConversationCodes | string

conversation

Identifie la conversation à laquelle l’activité appartient.

conversation: ConversationAccount

Valeur de propriété

ConversationAccount

deliveryMode

Indicateur de distribution pour signaler au destinataire d’autres chemins de distribution pour l’activité. Le mode de remise par défaut est « default ». Les valeurs possibles sont les suivantes : 'normal', 'notification', 'expectReplies', 'éphémère'

deliveryMode?: DeliveryModes | string

Valeur de propriété

DeliveryModes | string

entities

Représente les entités qui ont été mentionnées dans le message.

entities?: Entity[]

Valeur de propriété

Entity[]

expiration

Heure à laquelle l’activité doit être considérée comme étant « expirée » et ne doit pas être présentée au destinataire.

expiration?: Date

Valeur de propriété

Date

from

Identifie l’expéditeur du message.

from: ChannelAccount

Valeur de propriété

ChannelAccount

historyDisclosed

Indique si l’historique antérieur du canal est divulgué.

historyDisclosed?: boolean

Valeur de propriété

boolean

id

Contient un ID qui identifie de manière unique l’activité sur le canal.

id?: string

Valeur de propriété

string

importance

Importance de l’activité. Les valeurs possibles sont les suivantes : 'low', 'normal', 'high'

importance?: ActivityImportance | string

Valeur de propriété

ActivityImportance | string

inputHint

Indique si votre bot accepte, attend ou ignore l’entrée utilisateur une fois le message remis au client. Les valeurs possibles sont les suivantes : 'acceptInput', 'ignoringInput', 'expectingInput'

inputHint?: InputHints | string

Valeur de propriété

InputHints | string

label

Étiquette descriptive de l’activité.

label: string

Valeur de propriété

string

listenFor

Liste d’expressions et de références que les systèmes d’amorçage vocal et linguistique doivent écouter

listenFor: string[]

Valeur de propriété

string[]

locale

Nom des paramètres régionaux pour le contenu du champ de texte. Le nom des paramètres régionaux est une combinaison d’un code de culture ISO 639 à deux ou trois lettres associé à une langue et d’un code de sous-culture ISO 3166 à deux lettres associé à un pays ou à une région. Le nom des paramètres régionaux peut également correspondre à une balise de langue BCP-47 valide.

locale?: string

Valeur de propriété

string

localTimestamp

Contient la date et l’heure locales du message, exprimées au format ISO-8601. Par exemple, 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: Date

Valeur de propriété

Date

localTimezone

Contient le nom du fuseau horaire local du message, exprimé au format de base de données de fuseau horaire IANA. Par exemple, America/Los_Angeles.

localTimezone: string

Valeur de propriété

string

membersAdded

Collection de membres ajoutés à la conversation.

membersAdded?: ChannelAccount[]

Valeur de propriété

ChannelAccount[]

membersRemoved

Collection de membres supprimés de la conversation.

membersRemoved?: ChannelAccount[]

Valeur de propriété

ChannelAccount[]

name

Nom de l’opération associée à une activité d’appel ou d’événement.

name?: ActivityEventNames | string

Valeur de propriété

ActivityEventNames | string

reactionsAdded

Collection de réactions ajoutées à la conversation.

reactionsAdded?: MessageReaction[]

Valeur de propriété

MessageReaction[]

reactionsRemoved

Collection de réactions supprimées de la conversation.

reactionsRemoved?: MessageReaction[]

Valeur de propriété

MessageReaction[]

recipient

Identifie le destinataire du message.

recipient: ChannelAccount

Valeur de propriété

ChannelAccount

relatesTo

Référence à une autre conversation ou activité.

relatesTo?: ConversationReference

Valeur de propriété

ConversationReference

replyToId

Contient l’ID du message auquel ce message est une réponse.

replyToId?: string

Valeur de propriété

string

semanticAction

Action par programme facultative accompagnant cette demande

semanticAction?: SemanticAction

Valeur de propriété

SemanticAction

serviceUrl

Contient l’URL qui spécifie le point de terminaison de service du canal. Défini par le canal.

serviceUrl: string

Valeur de propriété

string

speak

Texte à lire.

speak?: string

Valeur de propriété

string

suggestedActions

Actions suggérées pour l’activité.

suggestedActions?: SuggestedActions

Valeur de propriété

SuggestedActions

summary

Texte à afficher si le canal ne peut pas afficher les cartes.

summary?: string

Valeur de propriété

string

text

Contenu textuel du message.

text: string

Valeur de propriété

string

textFormat

Format des champs de texte Default:markdown. Les valeurs possibles sont les suivantes : 'markdown', 'plain', 'xml'

textFormat?: TextFormatTypes | string

Valeur de propriété

TextFormatTypes | string

textHighlights

Collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur ReplyToId.

textHighlights?: TextHighlight[]

Valeur de propriété

TextHighlight[]

timestamp

Contient la date et l’heure d’envoi du message, en UTC, exprimées au format ISO-8601.

timestamp?: Date

Valeur de propriété

Date

topicName

Nom de la rubrique mise à jour de la conversation.

topicName?: string

Valeur de propriété

string

type

Contient le type d’activité. Les valeurs possibles sont les suivantes : 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

type: ActivityTypes | string

Valeur de propriété

ActivityTypes | string

value

Valeur associée à l’activité.

value?: any

Valeur de propriété

any

valueType

Type de l’objet de valeur de l’activité.

valueType: string

Valeur de propriété

string