IMessage interface

Paket:

botbuilder

Eine Chatnachricht, die zwischen einem Benutzer und einem Bot gesendet wurde. Nachrichten vom Bot an den Benutzer kommen in zwei Varianten:

• reaktiven Nachrichten sind Nachrichten, die vom Bot an den Benutzer gesendet werden, als Antwort auf eine eingehende Nachricht des Benutzers.
• proaktive Nachrichten sind Nachrichten, die vom Bot an den Benutzer als Reaktion auf ein externes Ereignis gesendet werden, z. B. ein Alarm, der ausgelöst wird.

Im reaktiven Fall sollten Sie die Adresse Feld aus der eingehenden Nachricht in die ausgehende Nachricht kopieren (wenn Sie die Message Builder-Klasse verwenden und mit der Sitzung initialisieren, dies automatisch geschieht) und dann den Text oder Anlagenfestlegen. Für proaktive Nachrichten müssen Sie die Adresse aus der eingehenden Nachricht an einem externen Speicher speichern. Sie können dies später an UniversalBot.beginDialog() übergeben oder in eine ausgehende Nachricht kopieren, die an UniversalBot.send()übergeben wird.

Durch das Verfassen einer Nachricht an den Benutzer mithilfe des eingehenden Adressobjekts wird standardmäßig eine Antwort an den Benutzer im Kontext der aktuellen Unterhaltung gesendet. Einige Kanäle ermöglichen das Starten neuer Unterhaltungen mit dem Benutzer. Um eine neue proaktive Unterhaltung mit dem Benutzer zu beginnen, löschen Sie einfach die Unterhaltung Feld aus dem Adressobjekt, bevor Sie die ausgehende Nachricht verfassen.

Extends

IEvent

Eigenschaften

address	Adressweiterleitungsinformationen für das Ereignis. Speichern Sie dieses Feld an einer beliebigen Stelle, um dem Benutzer später eine proaktive Nachricht zu erstellen.
agent	SDK, das das Ereignis verarbeitet. Wird immer "botbuilder" sein.
attachmentLayout	Hinweis, wie Clients mehrere Anlagen layouten sollen. Der Standardwert ist "list".
attachments	Für eingehende Nachrichten enthält Anlagen wie Bilder, die vom Benutzer gesendet werden. Für ausgehende Nachrichten enthält Objekte wie Karten oder Bilder, die an den Benutzer gesendet werden sollen.
code	Code, der angibt, warum die Unterhaltung beendet wurde.
deliveryMode	Ein Übermittlungshinweis, der dem Empfänger alternative Übermittlungspfade für die Aktivität signalisiert. Der Standardübermittlungsmodus ist "Standard".
entities	Strukturierte Objekte, die an den Bot oder benutzer übergeben werden.
expriation	Der Zeitpunkt, zu dem die Aktivität als "abgelaufen" betrachtet werden sollte und dem Empfänger nicht angezeigt werden sollte.
importance	Die Bedeutung der Aktivität.
inputHint	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.
label	Eine beschreibende Bezeichnung für die Aktivität.
listenFor	Liste der Ausdrücke und Verweise, auf die Sprach- und Sprachprimierungssysteme lauschen sollten.
localTimestamp	Ortszeit, zu der die Nachricht gesendet wurde (vom Client oder Bot festgelegt, z. B. 2016-09-23T13:07:49.4714686-07:00.)
localTimezone	Enthält den Namen der Zeitzone, in der die Nachricht in der Ortszeit im IANA Time Zone-Datenbankformat ausgedrückt wird. Beispiel: Amerika/Los_Angeles.
name	Der Name des auszuführenden Vorgangs oder der Name des Ereignisses.
relatesTo	Verweisen auf eine andere Unterhaltung oder Nachricht.
replyToId	Die ID des Ereignisses, mit dem dieses Update verknüpft ist.
semanticAction	Eine optionale programmgesteuerte Aktion, die diese Anforderung begleitet.
source	Die ursprüngliche Quelle des Ereignisses (z. B. "facebook", "skype", "slack" usw.)
sourceEvent	Das ursprüngliche Ereignis im systemeigenen Quellschema. Bei ausgehenden Nachrichten können Quellereignisdaten wie benutzerdefinierte Anlagen übergeben werden.
speak	Gesprochene Nachricht als Speech Synthesis Markup Language.
summary	Text, der als Fallback und als kurze Beschreibung des Nachrichteninhalts in der Liste der zuletzt verwendeten Unterhaltungen angezeigt werden soll.
text	Nachrichtentext.
textFormat	Format von Textfeldern. Der Standardwert ist "markdown".
textHighlights	Die Sammlung von Textfragmenten, die hervorgehoben werden sollen, wenn die Aktivität einen ReplyToId-Wert enthält.
textLocale	Identifizierte Sprache des Nachrichtentexts, falls bekannt.
timestamp	UTC-Zeit, zu der die Nachricht gesendet wurde (vom Dienst festgelegt).)
type	Definiert den Ereignistyp. Sollte 'message' für eine IMessage sein.
user	Bei eingehenden Nachrichten ist dies der Benutzer, der die Nachricht gesendet hat. Standardmäßig ist dies eine Kopie von address.user, Sie können Ihren Bot jedoch mit einer LookupUser--Funktion konfigurieren, mit der der eingehende Benutzer einer internen Benutzer-ID zugeordnet werden kann.
value	Open-ended-Wert.
valueType	Der Typ des Wertobjekts der Aktivität.

Details zur Eigenschaft

address

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

address: IAddress

Eigenschaftswert

IAddress

agent

SDK, das das Ereignis verarbeitet. Wird immer "botbuilder" sein.

agent: string

Eigenschaftswert

string

attachmentLayout

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

attachmentLayout?: string

Eigenschaftswert

string

attachments

Für eingehende Nachrichten enthält Anlagen wie Bilder, die vom Benutzer gesendet werden. Für ausgehende Nachrichten enthält Objekte wie Karten oder Bilder, die an den Benutzer gesendet werden sollen.

attachments?: IAttachment[]

Eigenschaftswert

IAttachment[]

code

Code, der angibt, warum die Unterhaltung beendet wurde.

code?: string

Eigenschaftswert

string

deliveryMode

Ein Übermittlungshinweis, der dem Empfänger alternative Übermittlungspfade für die Aktivität signalisiert. Der Standardübermittlungsmodus ist "Standard".

deliveryMode?: string

Eigenschaftswert

string

entities

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

entities?: any[]

Eigenschaftswert

any[]

expriation

Der Zeitpunkt, zu dem die Aktivität als "abgelaufen" betrachtet werden sollte und dem Empfänger nicht angezeigt werden sollte.

expriation?: string

Eigenschaftswert

string

importance

Die Bedeutung der Aktivität.

importance?: string

Eigenschaftswert

string

inputHint

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.

inputHint?: string

Eigenschaftswert

string

label

Eine beschreibende Bezeichnung für die Aktivität.

label?: string

Eigenschaftswert

string

listenFor

Liste der Ausdrücke und Verweise, auf die Sprach- und Sprachprimierungssysteme lauschen sollten.

listenFor?: string[]

Eigenschaftswert

string[]

localTimestamp

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

localTimestamp?: string

Eigenschaftswert

string

localTimezone

Enthält den Namen der Zeitzone, in der die Nachricht in der Ortszeit im IANA Time Zone-Datenbankformat ausgedrückt wird. Beispiel: Amerika/Los_Angeles.

localTimezone?: string

Eigenschaftswert

string

name

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

name?: string

Eigenschaftswert

string

relatesTo

Verweisen auf eine andere Unterhaltung oder Nachricht.

relatesTo?: IAddress

Eigenschaftswert

IAddress

replyToId

Die ID des Ereignisses, mit dem dieses Update verknüpft ist.

replyToId?: string

Eigenschaftswert

string

semanticAction

Eine optionale programmgesteuerte Aktion, die diese Anforderung begleitet.

semanticAction?: ISemanticAction

Eigenschaftswert

ISemanticAction

source

Die ursprüngliche Quelle des Ereignisses (z. B. "facebook", "skype", "slack" usw.)

source: string

Eigenschaftswert

string

sourceEvent

Das ursprüngliche Ereignis im systemeigenen Quellschema. Bei ausgehenden Nachrichten können Quellereignisdaten wie benutzerdefinierte Anlagen übergeben werden.

sourceEvent: any

Eigenschaftswert

any

speak

Gesprochene Nachricht als Speech Synthesis Markup Language.

speak?: string

Eigenschaftswert

string

summary

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

summary?: string

Eigenschaftswert

string

text

Nachrichtentext.

text?: string

Eigenschaftswert

string

textFormat

Format von Textfeldern. Der Standardwert ist "markdown".

textFormat?: string

Eigenschaftswert

string

textHighlights

Die Sammlung von Textfragmenten, die hervorgehoben werden sollen, wenn die Aktivität einen ReplyToId-Wert enthält.

textHighlights?: ITextHighlight[]

Eigenschaftswert

ITextHighlight[]

textLocale

Identifizierte Sprache des Nachrichtentexts, falls bekannt.

textLocale?: string

Eigenschaftswert

string

timestamp

UTC-Zeit, zu der die Nachricht gesendet wurde (vom Dienst festgelegt).)

timestamp?: string

Eigenschaftswert

string

type

Definiert den Ereignistyp. Sollte 'message' für eine IMessage sein.

type: string

Eigenschaftswert

string

user

Bei eingehenden Nachrichten ist dies der Benutzer, der die Nachricht gesendet hat. Standardmäßig ist dies eine Kopie von address.user, Sie können Ihren Bot jedoch mit einer LookupUser--Funktion konfigurieren, mit der der eingehende Benutzer einer internen Benutzer-ID zugeordnet werden kann.

user: IIdentity

Eigenschaftswert

IIdentity

value

Open-ended-Wert.

value?: any

Eigenschaftswert

any

valueType

Der Typ des Wertobjekts der Aktivität.

valueType?: string

Eigenschaftswert

string