IMessage interface

Paquet:

botbuilder

Message de conversation envoyé entre un utilisateur et un bot. Les messages du bot à l’utilisateur sont de deux versions :

• messages réactifs sont des messages envoyés du bot à l’utilisateur en tant que réponse à un message entrant de l’utilisateur.
• messages proactifs sont des messages envoyés du bot à l’utilisateur en réponse à un événement externe comme un déclenchement d’alarme.

Dans le cas réactif, vous devez copier l’adresse champ du message entrant vers le message sortant (si vous utilisez la classe Message générateur et l’initialisez avec la session cela se produit automatiquement), puis définissez le texte texte ou pièces jointes. Pour les messages proactifs, vous devez enregistrer l’adresse du message entrant vers un stockage externe quelque part. Vous pouvez ensuite le transmettre ultérieurement à UniversalBot.beginDialog() ou le copier dans un message sortant passé à UniversalBot.send().

La composition d’un message à l’utilisateur à l’aide de l’objet d’adresse entrant envoie par défaut une réponse à l’utilisateur dans le contexte de la conversation actuelle. Certains canaux permettent le démarrage de nouvelles conversations avec l’utilisateur. Pour démarrer une nouvelle conversation proactive avec l’utilisateur, supprimez simplement le champ conversation de l’objet d’adresse avant de composer le message sortant.

Extends

IEvent

Propriétés

address	Adressez les informations de routage de l’événement. Enregistrez ce champ dans le stockage externe quelque part pour composer ultérieurement un message proactif à l’utilisateur.
agent	Kit de développement logiciel (SDK) qui traite l’événement. Sera toujours « botbuilder ».
attachmentLayout	Indicateur pour savoir comment les clients doivent mettre en page plusieurs pièces jointes. La valeur par défaut est « list ».
attachments	Pour les messages entrants contient des pièces jointes telles que des images envoyées par l’utilisateur. Pour les messages sortants contient des objets tels que des cartes ou des images à envoyer à l’utilisateur.
code	Code indiquant pourquoi la conversation s’est terminée.
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 ».
entities	Objets structurés transmis au bot ou à l’utilisateur.
expriation	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é.
inputHint	Conseil pour les clients qui leur indiquent si le bot s’attend à une entrée supplémentaire ou non. Les invites intégrées remplissent automatiquement cette valeur pour les messages sortants.
label	Étiquette descriptive de l’activité.
listenFor	Liste des expressions et références que les systèmes d’priming vocale et linguistique doivent écouter.
localTimestamp	Heure locale à laquelle le message a été envoyé (défini par client ou bot, ex : 2016-09-23T13:07:49.4714686-07:00.)
localTimezone	Contient le nom du fuseau horaire dans lequel le message, dans l’heure locale, exprimé au format de base de données de fuseau horaire IANA. Par exemple, l’Amérique/Los_Angeles.
name	Nom de l’opération à appeler ou nom de l’événement.
relatesTo	Référence à une autre conversation ou message.
replyToId	ID de l’événement où cette mise à jour est liée.
semanticAction	Action de programmation facultative qui accompagne cette demande.
source	Source d’origine de l’événement (c’est-à-dire « facebook », « skype », « slack », etc.)
sourceEvent	Événement d’origine dans le schéma natif sources. Pour les messages sortants, vous pouvez passer des données d’événement spécifiques à la source, telles que des pièces jointes personnalisées.
speak	Message parlé en tant que langage de balisage de synthèse vocale .
summary	Texte à afficher sous forme de secours et de brève description du contenu du message, par exemple la liste des conversations récentes.
text	Texte du message.
textFormat	Format des champs de texte. La valeur par défaut est « markdown ».
textHighlights	Collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur ReplyToId.
textLocale	Langue identifiée du texte du message si elle est connue.
timestamp	Heure UTC à laquelle le message a été envoyé (défini par service.)
type	Définit le type d’événement. Doit être « message » pour un IMessage.
user	Pour les messages entrants, il s’agit de l’utilisateur qui a envoyé le message. Par défaut, il s’agit d’une copie de address.user, mais vous pouvez configurer votre bot avec une fonction lookupUser qui permet de mapper l’utilisateur entrant à un ID d’utilisateur interne.
value	Valeur ouverte.
valueType	Type de l’objet valeur de l’activité.

Détails de la propriété

address

Adressez les informations de routage de l’événement. Enregistrez ce champ dans le stockage externe quelque part pour composer ultérieurement un message proactif à l’utilisateur.

address: IAddress

Valeur de propriété

IAddress

agent

Kit de développement logiciel (SDK) qui traite l’événement. Sera toujours « botbuilder ».

agent: string

Valeur de propriété

string

attachmentLayout

Indicateur pour savoir comment les clients doivent mettre en page plusieurs pièces jointes. La valeur par défaut est « list ».

attachmentLayout?: string

Valeur de propriété

string

attachments

Pour les messages entrants contient des pièces jointes telles que des images envoyées par l’utilisateur. Pour les messages sortants contient des objets tels que des cartes ou des images à envoyer à l’utilisateur.

attachments?: IAttachment[]

Valeur de propriété

IAttachment[]

code

Code indiquant pourquoi la conversation s’est terminée.

code?: string

Valeur de propriété

string

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

deliveryMode?: string

Valeur de propriété

string

entities

Objets structurés transmis au bot ou à l’utilisateur.

entities?: any[]

Valeur de propriété

any[]

expriation

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

expriation?: string

Valeur de propriété

string

importance

Importance de l’activité.

importance?: string

Valeur de propriété

string

inputHint

Conseil pour les clients qui leur indiquent si le bot s’attend à une entrée supplémentaire ou non. Les invites intégrées remplissent automatiquement cette valeur pour les messages sortants.

inputHint?: string

Valeur de propriété

string

label

Étiquette descriptive de l’activité.

label?: string

Valeur de propriété

string

listenFor

Liste des expressions et références que les systèmes d’priming vocale et linguistique doivent écouter.

listenFor?: string[]

Valeur de propriété

string[]

localTimestamp

Heure locale à laquelle le message a été envoyé (défini par client ou bot, ex : 2016-09-23T13:07:49.4714686-07:00.)

localTimestamp?: string

Valeur de propriété

string

localTimezone

Contient le nom du fuseau horaire dans lequel le message, dans l’heure locale, exprimé au format de base de données de fuseau horaire IANA. Par exemple, l’Amérique/Los_Angeles.

localTimezone?: string

Valeur de propriété

string

name

Nom de l’opération à appeler ou nom de l’événement.

name?: string

Valeur de propriété

string

relatesTo

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

relatesTo?: IAddress

Valeur de propriété

IAddress

replyToId

ID de l’événement où cette mise à jour est liée.

replyToId?: string

Valeur de propriété

string

semanticAction

Action de programmation facultative qui accompagne cette demande.

semanticAction?: ISemanticAction

Valeur de propriété

ISemanticAction

source

Source d’origine de l’événement (c’est-à-dire « facebook », « skype », « slack », etc.)

source: string

Valeur de propriété

string

sourceEvent

Événement d’origine dans le schéma natif sources. Pour les messages sortants, vous pouvez passer des données d’événement spécifiques à la source, telles que des pièces jointes personnalisées.

sourceEvent: any

Valeur de propriété

any

speak

Message parlé en tant que langage de balisage de synthèse vocale .

speak?: string

Valeur de propriété

string

summary

Texte à afficher sous forme de secours et de brève description du contenu du message, par exemple la liste des conversations récentes.

summary?: string

Valeur de propriété

string

text

Texte du message.

text?: string

Valeur de propriété

string

textFormat

Format des champs de texte. La valeur par défaut est « markdown ».

textFormat?: string

Valeur de propriété

string

textHighlights

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

textHighlights?: ITextHighlight[]

Valeur de propriété

ITextHighlight[]

textLocale

Langue identifiée du texte du message si elle est connue.

textLocale?: string

Valeur de propriété

string

timestamp

Heure UTC à laquelle le message a été envoyé (défini par service.)

timestamp?: string

Valeur de propriété

string

type

Définit le type d’événement. Doit être « message » pour un IMessage.

type: string

Valeur de propriété

string

user

Pour les messages entrants, il s’agit de l’utilisateur qui a envoyé le message. Par défaut, il s’agit d’une copie de address.user, mais vous pouvez configurer votre bot avec une fonction lookupUser qui permet de mapper l’utilisateur entrant à un ID d’utilisateur interne.

user: IIdentity

Valeur de propriété

IIdentity

value

Valeur ouverte.

value?: any

Valeur de propriété

any

valueType

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

valueType?: string

Valeur de propriété

string