Partager via

IMessageActivity interface

  • Référence
Paquet:
botframework-schema
Extends
IActivity

Propriétés

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
deliveryMode

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

Heure à laquelle l’activité doit être considérée comme « expirée » et ne doit pas être présentée au destinataire.
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 de l’utilisateur une fois le message remis au client. Les valeurs possibles sont les suivantes : « acceptInput », « ignoreingInput », « expectingInput »
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 un code de sous-culture à deux lettres ISO 3166 associé à un pays ou une région. Le nom des paramètres régionaux peut également correspondre à une balise de langue BCP-47 valide.
speak

Texte à parler.
suggestedActions

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

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

Contenu texte du message.
textFormat

Format des champs de texte Par défaut :markdown. Les valeurs possibles sont les suivantes : 'markdown', 'plain', 'xml'
value

Valeur associée à l’activité.

Propriétés héritées

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

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

Représente les entités mentionnées dans le message.
from

Identifie l’expéditeur du message.
id

Contient un ID qui identifie de façon unique l’activité sur le canal.
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.
recipient

Identifie le destinataire du message.
replyToId

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

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

Contient la date et l’heure à laquelle le message a été envoyé, au format UTC, exprimé au format ISO-8601.
type

Contient le type d’activité « iActivity »

Détails de la propriété

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[]

deliveryMode

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

deliveryMode?: DeliveryModes | string

Valeur de propriété

DeliveryModes | string

expiration

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

expiration?: Date

Valeur de propriété

Date

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 de l’utilisateur une fois le message remis au client. Les valeurs possibles sont les suivantes : « acceptInput », « ignoreingInput », « expectingInput »

inputHint?: InputHints | string

Valeur de propriété

InputHints | 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 un code de sous-culture à deux lettres ISO 3166 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

speak

Texte à parler.

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 texte du message.

text: string

Valeur de propriété

string

textFormat

Format des champs de texte Par défaut :markdown. Les valeurs possibles sont les suivantes : 'markdown', 'plain', 'xml'

textFormat?: TextFormatTypes | string

Valeur de propriété

TextFormatTypes | string

value

Valeur associée à l’activité.

value?: any

Valeur de propriété

any

Détails de la propriété héritée

channelData

Contient du contenu spécifique au canal.

channelData?: any

Valeur de propriété

any

héritée deIActivity.channelData

channelId

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

channelId: string

Valeur de propriété

string

héritée deIActivity.channelId

conversation

Identifie la conversation à laquelle appartient l’activité.

conversation: ConversationAccount

Valeur de propriété

ConversationAccount

héritée de IActivity.conversation

entities

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

entities?: Entity[]

Valeur de propriété

Entity[]

héritée deIActivity.entities

from

Identifie l’expéditeur du message.

from: ChannelAccount

Valeur de propriété

ChannelAccount

héritée deIActivity.from

id

Contient un ID qui identifie de façon unique l’activité sur le canal.

id?: string

Valeur de propriété

string

héritée deIActivity.id

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

héritée deIActivity.localTimestamp

recipient

Identifie le destinataire du message.

recipient: ChannelAccount

Valeur de propriété

ChannelAccount

héritée du IActivity.recipient

replyToId

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

replyToId?: string

Valeur de propriété

string

héritée deIActivity.replyToId

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

héritée deIActivity.serviceUrl

timestamp

Contient la date et l’heure à laquelle le message a été envoyé, au format UTC, exprimé au format ISO-8601.

timestamp?: Date

Valeur de propriété

Date

héritée deIActivity.timestamp

type

Contient le type d’activité « iActivity »

type: ActivityTypes | string

Valeur de propriété

ActivityTypes | string

héritée deIActivity.type