Message class

Paket:

botbuilder

Nachrichten-Generator-Klasse, die das Erstellen komplexer Nachrichten mit Anlagen vereinfacht.

Konstruktoren

Message(Session)

Erstellt einen neuen Nachrichten-Generator.

Methoden

addAttachment(AttachmentType)	Fügt der Nachricht eine Anlage hinzu. Beispiele finden Sie unter IAttachment-.
addEntity(Object)	Fügt der Nachricht eine Entität hinzu.
address(IAddress)	Adressweiterleitungsinformationen für die Nachricht. Speichern Sie dieses Feld an einer beliebigen Stelle, um dem Benutzer später eine proaktive Nachricht zu erstellen.
attachmentLayout(string)	Hinweis, wie Clients mehrere Anlagen layouten sollen. Der Standardwert ist "list".
attachments(AttachmentType[])	Karten oder Bilder, die an den Benutzer gesendet werden sollen.
code(string)	Code, der angibt, warum die Unterhaltung beendet wurde.
compose(string[][], any[])	Verfasst eine komplexe und zufällige Antwort auf den Benutzer.
composePrompt(Session, string[][], any[])	stattdessen compose() verwenden.
composePrompt(Session, string[][], any[])	Kombiniert ein Array von Eingabeaufforderungen in einer einzigen lokalisierten Eingabeaufforderung und füllt dann optional die Eingabeaufforderungsvorlagenplätze mit den übergebenen Argumenten aus.
entities(Object[])	Strukturierte Objekte, die an den Bot oder benutzer übergeben werden.
inputHint(string)	Hinweis für Clients, die sie darüber informieren, ob der Bot weitere Eingaben erwartet oder nicht. Die integrierten Eingabeaufforderungen füllen diesen Wert automatisch für ausgehende Nachrichten auf.
localTimestamp(string)	Ortszeit, zu der die Nachricht gesendet wurde (vom Client oder Bot festgelegt, z. B. 2016-09-23T13:07:49.4714686-07:00.)
name(string)	Der Name des auszuführenden Vorgangs oder der Name des Ereignisses.
nspeak(TextType, TextType, number)	Legen Sie das Sprechen-Feld der Nachricht mit einer angegebenen Anzahl bedingt fest.
ntext(TextType, TextType, number)	Legen Sie den Nachrichtentext mit einer angegebenen Anzahl bedingt fest.
originalEvent(any)	Nachricht im ursprünglichen/nativen Format des Kanals für eingehende Nachrichten.
randomPrompt(TextType)	Wählt eine Eingabeaufforderung nach dem Zufallsprinzip aus.
relatesTo(IAddress)	Verweisen auf eine andere Unterhaltung oder Nachricht.
setChannelData(any)	veraltete stattdessen sourceEvent() verwenden.
setLanguage(string)	veraltete stattdessen local() verwenden.
setNText(Session, string, string, number)	veraltete stattdessen ntext() verwenden.
setText(Session, TextType, any[])	veraltete stattdessen Text() verwenden.
sourceEvent(ISourceEventMap)	Bei ausgehenden Nachrichten können Quellereignisdaten wie benutzerdefinierte Anlagen übergeben werden.
speak(TextType, any[])	Legt das Sprechen-Feld der Nachricht als Speech Synthesis Markup Language (SSML)fest. Dies wird dem Benutzer auf unterstützten Geräten gesprochen.
suggestedActions(ISuggestedActions | IIsSuggestedActions)	Optionale vorgeschlagene Aktionen, die an den Benutzer gesendet werden sollen. Vorgeschlagene Aktionen werden nur auf den Kanälen angezeigt, die vorgeschlagene Aktionen unterstützen.
summary(TextType, any[])	Text, der als Fallback und als kurze Beschreibung des Nachrichteninhalts in der Liste der zuletzt verwendeten Unterhaltungen angezeigt werden soll.
text(TextType, any[])	Legt den Nachrichtentext fest.
textFormat(string)	Format von Textfeldern.
textLocale(string)	Sprache der Nachricht.
timestamp(string)	Wird vom Connectors-Dienst festgelegt. Verwenden Sie stattdessen localTimestamp().
toMessage()	Gibt den JSON-Code für die Nachricht zurück.
value(any)	Open-ended-Wert.

Details zum Konstruktor

Message(Session)

Erstellt einen neuen Nachrichten-Generator.

new Message(session?: Session)

Parameter

session

Session

(Optional) wird verwendet, um die Nachrichtenadresse aufzufüllen und beliebigen Text zu lokalisieren.

Details zur Methode

addAttachment(AttachmentType)

Fügt der Nachricht eine Anlage hinzu. Beispiele finden Sie unter IAttachment-.

function addAttachment(attachment: AttachmentType)

Parameter

attachment

AttachmentType

Die anlage, die hinzugefügt werden soll.

Gibt zurück

Message

addEntity(Object)

Fügt der Nachricht eine Entität hinzu.

function addEntity(obj: Object)

Parameter

obj

Object

Gibt zurück

Message

address(IAddress)

Adressweiterleitungsinformationen für die Nachricht. Speichern Sie dieses Feld an einer beliebigen Stelle, um dem Benutzer später eine proaktive Nachricht zu erstellen.

function address(adr: IAddress)

Parameter

adr

IAddress

Gibt zurück

Message

attachmentLayout(string)

Hinweis, wie Clients mehrere Anlagen layouten sollen. Der Standardwert ist "list".

function attachmentLayout(style: string)

Parameter

style

string

Gibt zurück

Message

attachments(AttachmentType[])

Karten oder Bilder, die an den Benutzer gesendet werden sollen.

function attachments(list: AttachmentType[])

Parameter

list

AttachmentType[]

Gibt zurück

Message

code(string)

Code, der angibt, warum die Unterhaltung beendet wurde.

function code(value: string)

Parameter

value

string

Gibt zurück

Message

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

Verfasst eine komplexe und zufällige Antwort auf den Benutzer.

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

Parameter

prompts

string[][]

args

any[]

Gibt zurück

Message

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

stattdessen compose() verwenden.

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

Parameter

session

Session

prompts

string[][]

args

any[]

Gibt zurück

Message

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

Kombiniert ein Array von Eingabeaufforderungen in einer einzigen lokalisierten Eingabeaufforderung und füllt dann optional die Eingabeaufforderungsvorlagenplätze mit den übergebenen Argumenten aus.

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

Parameter

session

Session

Sitzungsobjekt zum Lokalisieren der einzelnen Eingabeaufforderungsteile.

prompts

string[][]

Array von Eingabeaufforderungslisten. Jeder Eintrag im Array ist ein weiteres Array von Eingabeaufforderungen, die zufällig ausgewählt werden. Der kombinierte Ausgabetext ist durch Leerzeichen getrennt.

args

any[]

(Optional) Array von Argumenten, die zum Formatieren des Ausgabetexts verwendet werden, wenn die Eingabeaufforderung eine Vorlage ist.

Gibt zurück

string

entities(Object[])

Strukturierte Objekte, die an den Bot oder benutzer übergeben werden.

function entities(list: Object[])

Parameter

list

Object[]

Gibt zurück

Message

inputHint(string)

Hinweis für Clients, die sie darüber informieren, ob der Bot weitere Eingaben erwartet oder nicht. Die integrierten Eingabeaufforderungen füllen diesen Wert automatisch für ausgehende Nachrichten auf.

function inputHint(hint: string)

Parameter

hint

string

Gibt zurück

Message

localTimestamp(string)

Ortszeit, zu der die Nachricht gesendet wurde (vom Client oder Bot festgelegt, z. B. 2016-09-23T13:07:49.4714686-07:00.)

function localTimestamp(time?: string)

Parameter

time

string

(Optional) Als ISO-Zeichenfolge ausgedrückte Zeit. Standardmäßig wird new Date().toISOString().

Gibt zurück

Message

name(string)

Der Name des auszuführenden Vorgangs oder der Name des Ereignisses.

function name(name: string)

Parameter

name

string

Gibt zurück

Message

nspeak(TextType, TextType, number)

Legen Sie das Sprechen-Feld der Nachricht mit einer angegebenen Anzahl bedingt fest.

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

Parameter

ssml

TextType

ssml_plural

TextType

count

number

Gibt zurück

Message

ntext(TextType, TextType, number)

Legen Sie den Nachrichtentext mit einer angegebenen Anzahl bedingt fest.

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

Parameter

msg

TextType

msg_plural

TextType

count

number

Gibt zurück

Message

originalEvent(any)

Nachricht im ursprünglichen/nativen Format des Kanals für eingehende Nachrichten.

function originalEvent(event: any)

Parameter

event

any

Gibt zurück

Message

randomPrompt(TextType)

Wählt eine Eingabeaufforderung nach dem Zufallsprinzip aus.

static function randomPrompt(prompts: TextType)

Parameter

prompts

TextType

Array von Eingabeaufforderungen, aus der Sie auswählen können. Wenn Aufforderungen eingegeben werden, Zeichenfolge wird die Eingabeaufforderung einfach nicht geändert zurückgegeben.

Gibt zurück

string

relatesTo(IAddress)

Verweisen auf eine andere Unterhaltung oder Nachricht.

function relatesTo(adr: IAddress)

Parameter

adr

IAddress

Gibt zurück

Message

setChannelData(any)

veraltete stattdessen sourceEvent() verwenden.

function setChannelData(data: any)

Parameter

data

any

Gibt zurück

Message

setLanguage(string)

veraltete stattdessen local() verwenden.

function setLanguage(language: string)

Parameter

language

string

Gibt zurück

Message

setNText(Session, string, string, number)

veraltete stattdessen ntext() verwenden.

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

Parameter

session

Session

msg

string

msg_plural

string

count

number

Gibt zurück

Message

setText(Session, TextType, any[])

veraltete stattdessen Text() verwenden.

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

Parameter

session

Session

prompt

TextType

args

any[]

Gibt zurück

Message

sourceEvent(ISourceEventMap)

Bei ausgehenden Nachrichten können Quellereignisdaten wie benutzerdefinierte Anlagen übergeben werden.

function sourceEvent(map: ISourceEventMap)

Parameter

map

ISourceEventMap

Gibt zurück

Message

speak(TextType, any[])

Legt das Sprechen-Feld der Nachricht als Speech Synthesis Markup Language (SSML)fest. Dies wird dem Benutzer auf unterstützten Geräten gesprochen.

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

Parameter

ssml

TextType

args

any[]

Gibt zurück

Message

suggestedActions(ISuggestedActions | IIsSuggestedActions)

Optionale vorgeschlagene Aktionen, die an den Benutzer gesendet werden sollen. Vorgeschlagene Aktionen werden nur auf den Kanälen angezeigt, die vorgeschlagene Aktionen unterstützen.

function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)

Parameter

suggestedActions

ISuggestedActions | IIsSuggestedActions

Gibt zurück

Message

summary(TextType, any[])

Text, der als Fallback und als kurze Beschreibung des Nachrichteninhalts in der Liste der zuletzt verwendeten Unterhaltungen angezeigt werden soll.

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

Parameter

text

TextType

args

any[]

Gibt zurück

Message

text(TextType, any[])

Legt den Nachrichtentext fest.

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

Parameter

text

TextType

args

any[]

Gibt zurück

Message

textFormat(string)

Format von Textfeldern.

function textFormat(style: string)

Parameter

style

string

Gibt zurück

Message

textLocale(string)

Sprache der Nachricht.

function textLocale(locale: string)

Parameter

locale

string

Gibt zurück

Message

timestamp(string)

Wird vom Connectors-Dienst festgelegt. Verwenden Sie stattdessen localTimestamp().

function timestamp(time?: string)

Parameter

time

string

Gibt zurück

Message

toMessage()

Gibt den JSON-Code für die Nachricht zurück.

function toMessage()

Gibt zurück

IMessage

value(any)

Open-ended-Wert.

function value(param: any)

Parameter

param

any

Gibt zurück

Message