Message class

Paquet:

botbuilder

Classe générateur de messages qui simplifie la création de messages complexes avec des pièces jointes.

Constructeurs

Message(Session)

Crée un générateur de messages.

Méthodes

addAttachment(AttachmentType)	Ajoute une pièce jointe au message. Consultez IAttachment pour obtenir des exemples.
addEntity(Object)	Ajoute une entité au message.
address(IAddress)	Adressez les informations de routage du message. Enregistrez ce champ dans le stockage externe quelque part pour composer ultérieurement un message proactif à l’utilisateur.
attachmentLayout(string)	Indicateur pour savoir comment les clients doivent mettre en page plusieurs pièces jointes. La valeur par défaut est « list ».
attachments(AttachmentType[])	Cartes ou images à envoyer à l’utilisateur.
code(string)	Code indiquant pourquoi la conversation s’est terminée.
compose(string[][], any[])	Compose une réponse complexe et aléatoire à l’utilisateur.
composePrompt(Session, string[][], any[])	DÉPRÉCIÉ utiliser compose() à la place.
composePrompt(Session, string[][], any[])	Combine un tableau d’invites en une seule invite localisée, puis remplit éventuellement les emplacements de modèle d’invite avec les arguments passés.
entities(Object[])	Objets structurés transmis au bot ou à l’utilisateur.
inputHint(string)	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.
localTimestamp(string)	Heure locale à laquelle le message a été envoyé (défini par client ou bot, ex : 2016-09-23T13:07:49.4714686-07:00.)
name(string)	Nom de l’opération à appeler ou nom de l’événement.
nspeak(TextType, TextType, number)	Définissez conditionnellement le champ speak du message en fonction d’un nombre spécifié.
ntext(TextType, TextType, number)	Définissez conditionnellement le texte du message en fonction d’un nombre spécifié.
originalEvent(any)	Message au format original/natif du canal pour les messages entrants.
randomPrompt(TextType)	Sélectionne une invite au hasard.
relatesTo(IAddress)	Référence à une autre conversation ou message.
setChannelData(any)	DÉPRÉCIÉ utiliser sourceEvent() à la place.
setLanguage(string)	DÉPRÉCIÉ utiliser local() à la place.
setNText(Session, string, string, number)	DÉPRÉCIÉ utiliser ntext() à la place.
setText(Session, TextType, any[])	déprécié utiliser texte() à la place.
sourceEvent(ISourceEventMap)	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(TextType, any[])	Définit le champ speak du message en tant que langage de balisage de synthèse vocale (SSML). Cela sera parlé à l’utilisateur sur les appareils pris en charge.
suggestedActions(ISuggestedActions | IIsSuggestedActions)	Actions suggérées facultatives à envoyer à l’utilisateur. Les actions suggérées sont affichées uniquement sur les canaux qui prennent en charge les actions suggérées.
summary(TextType, any[])	Texte à afficher sous forme de secours et de brève description du contenu du message, par exemple la liste des conversations récentes.
text(TextType, any[])	Définit le texte du message.
textFormat(string)	Format des champs de texte.
textLocale(string)	Langue du message.
timestamp(string)	Défini par le service connecteurs. Utilisez localTimestamp() à la place.
toMessage()	Retourne le json du message.
value(any)	Valeur ouverte.

Détails du constructeur

Message(Session)

Crée un générateur de messages.

new Message(session?: Session)

Paramètres

session

Session

(Facultatif) sera utilisé pour remplir l’adresse des messages et localiser tout texte.

Détails de la méthode

addAttachment(AttachmentType)

Ajoute une pièce jointe au message. Consultez IAttachment pour obtenir des exemples.

function addAttachment(attachment: AttachmentType)

Paramètres

attachment

AttachmentType

Pièce jointe à ajouter.

Retours

Message

addEntity(Object)

Ajoute une entité au message.

function addEntity(obj: Object)

Paramètres

obj

Object

Retours

Message

address(IAddress)

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

function address(adr: IAddress)

Paramètres

adr

IAddress

Retours

Message

attachmentLayout(string)

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

function attachmentLayout(style: string)

Paramètres

style

string

Retours

Message

attachments(AttachmentType[])

Cartes ou images à envoyer à l’utilisateur.

function attachments(list: AttachmentType[])

Paramètres

list

AttachmentType[]

Retours

Message

code(string)

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

function code(value: string)

Paramètres

value

string

Retours

Message

compose(string[][], any[])

Compose une réponse complexe et aléatoire à l’utilisateur.

function compose(prompts: string[][], args: any[])

Paramètres

prompts

string[][]

args

any[]

Retours

Message

composePrompt(Session, string[][], any[])

DÉPRÉCIÉ utiliser compose() à la place.

function composePrompt(session: Session, prompts: string[][], args: any[])

Paramètres

session

Session

prompts

string[][]

args

any[]

Retours

Message

composePrompt(Session, string[][], any[])

Combine un tableau d’invites en une seule invite localisée, puis remplit éventuellement les emplacements de modèle d’invite avec les arguments passés.

static function composePrompt(session: Session, prompts: string[][], args?: any[])

Paramètres

session

Session

Objet de session utilisé pour localiser les parties d’invite individuelles.

prompts

string[][]

Tableau de listes d’invites. Chaque entrée dans le tableau est un autre tableau d’invites qui sera choisi au hasard. Le texte de sortie combiné sera délimité par l’espace.

args

any[]

(Facultatif) tableau d’arguments utilisés pour mettre en forme le texte de sortie lorsque l’invite est un modèle.

Retours

string

entities(Object[])

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

function entities(list: Object[])

Paramètres

list

Object[]

Retours

Message

inputHint(string)

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.

function inputHint(hint: string)

Paramètres

hint

string

Retours

Message

localTimestamp(string)

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

function localTimestamp(time?: string)

Paramètres

time

string

(Facultatif) heure exprimée sous forme de chaîne ISO. La valeur par défaut est new Date().toISOString().

Retours

Message

name(string)

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

function name(name: string)

Paramètres

name

string

Retours

Message

nspeak(TextType, TextType, number)

Définissez conditionnellement le champ speak du message en fonction d’un nombre spécifié.

function nspeak(ssml: TextType, ssml_plural: TextType, count: number)

Paramètres

ssml

TextType

ssml_plural

TextType

count

number

Retours

Message

ntext(TextType, TextType, number)

Définissez conditionnellement le texte du message en fonction d’un nombre spécifié.

function ntext(msg: TextType, msg_plural: TextType, count: number)

Paramètres

msg

TextType

msg_plural

TextType

count

number

Retours

Message

originalEvent(any)

Message au format original/natif du canal pour les messages entrants.

function originalEvent(event: any)

Paramètres

event

any

Retours

Message

randomPrompt(TextType)

Sélectionne une invite au hasard.

static function randomPrompt(prompts: TextType)

Paramètres

prompts

TextType

Tableau d’invites à choisir. Lorsque les invites sont de type chaîne l’invite est simplement retournée non modifiée.

Retours

string

relatesTo(IAddress)

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

function relatesTo(adr: IAddress)

Paramètres

adr

IAddress

Retours

Message

setChannelData(any)

DÉPRÉCIÉ utiliser sourceEvent() à la place.

function setChannelData(data: any)

Paramètres

data

any

Retours

Message

setLanguage(string)

DÉPRÉCIÉ utiliser local() à la place.

function setLanguage(language: string)

Paramètres

language

string

Retours

Message

setNText(Session, string, string, number)

DÉPRÉCIÉ utiliser ntext() à la place.

function setNText(session: Session, msg: string, msg_plural: string, count: number)

Paramètres

session

Session

msg

string

msg_plural

string

count

number

Retours

Message

setText(Session, TextType, any[])

déprécié utiliser texte() à la place.

function setText(session: Session, prompt: TextType, args: any[])

Paramètres

session

Session

prompt

TextType

args

any[]

Retours

Message

sourceEvent(ISourceEventMap)

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.

function sourceEvent(map: ISourceEventMap)

Paramètres

map

ISourceEventMap

Retours

Message

speak(TextType, any[])

Définit le champ speak du message en tant que langage de balisage de synthèse vocale (SSML). Cela sera parlé à l’utilisateur sur les appareils pris en charge.

function speak(ssml: TextType, args: any[])

Paramètres

ssml

TextType

args

any[]

Retours

Message

suggestedActions(ISuggestedActions | IIsSuggestedActions)

Actions suggérées facultatives à envoyer à l’utilisateur. Les actions suggérées sont affichées uniquement sur les canaux qui prennent en charge les actions suggérées.

function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)

Paramètres

suggestedActions

ISuggestedActions | IIsSuggestedActions

Retours

Message

summary(TextType, any[])

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

function summary(text: TextType, args: any[])

Paramètres

text

TextType

args

any[]

Retours

Message

text(TextType, any[])

Définit le texte du message.

function text(text: TextType, args: any[])

Paramètres

text

TextType

args

any[]

Retours

Message

textFormat(string)

Format des champs de texte.

function textFormat(style: string)

Paramètres

style

string

Retours

Message

textLocale(string)

Langue du message.

function textLocale(locale: string)

Paramètres

locale

string

Retours

Message

timestamp(string)

Défini par le service connecteurs. Utilisez localTimestamp() à la place.

function timestamp(time?: string)

Paramètres

time

string

Retours

Message

toMessage()

Retourne le json du message.

function toMessage()

Retours

IMessage

value(any)

Valeur ouverte.

function value(param: any)

Paramètres

param

any

Retours

Message