IMessageActivity interface

Paket:

botframework-schema

Extends

IActivity

Eigenschaften

attachmentLayout	Der Layouthinweis für mehrere Anlagen. Standard: list. Mögliche Werte: "list", "carousel"
attachments	Attachments
deliveryMode	Ein Übermittlungshinweis, um den Empfänger über alternative Übermittlungspfade für die Aktivität zu informieren. Der Standardübermittlungsmodus ist "Standard". Mögliche Werte: "normal", "notification"
expiration	Die Zeit, zu der die Aktivität als abgelaufen betrachtet und dem Empfänger nicht mehr angezeigt werden soll.
importance	Die Bedeutung der Aktivität. Mögliche Werte: "niedrig", "normal", "hoch"
inputHint	Gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Mögliche Werte sind: "acceptingInput", "ignoringInput", "expectingInput"
locale	Ein Gebietsschemaname für den Inhalt des Textfelds. Der Gebietsschemaname ist eine Kombination aus einem zwei- oder dreibuchstabenigen ISO 639-Kulturcode, der einer Sprache zugeordnet ist, und einem ZWEI-Buchstaben-Subkulturcode nach ISO 3166, der einem Land oder einer Region zugeordnet ist. Der Gebietsschemaname kann auch einem gültigen BCP-47-Sprachtag entsprechen.
speak	Der zu sprechende Text.
suggestedActions	Die vorgeschlagenen Aktionen für die Aktivität.
summary	Der Text, der angezeigt werden soll, wenn der Kanal keine Karten rendern kann.
text	Der Textinhalt der Nachricht.
textFormat	Format der Textfelder Standard:Markdown. Mögliche Werte: "markdown", "plain", "xml"
value	Ein Wert, der der Aktivität zugeordnet ist.

Geerbte Eigenschaften

channelData	Enthält kanalspezifische Inhalte.
channelId	Enthält eine ID, die den Kanal eindeutig identifiziert. Wird vom Kanal festgelegt.
conversation	Identifiziert die Unterhaltung, zu der die Aktivität gehört.
entities	Stellt die Entitäten dar, die in der Nachricht erwähnt wurden.
from	Identifiziert den Absender der Nachricht.
id	Enthält eine ID, die die Aktivität im Kanal eindeutig identifiziert.
localTimestamp	Enthält das lokale Datum und die lokale Uhrzeit der Nachricht, ausgedrückt im ISO-8601-Format. Beispiel: 2016-09-23T13:07:49.4714686-07:00.
recipient	Identifiziert den Empfänger der Nachricht.
replyToId	Enthält die ID der Nachricht, auf die diese Nachricht eine Antwort ist.
serviceUrl	Enthält die URL, die den Dienstendpunkt des Kanals angibt. Wird vom Kanal festgelegt.
timestamp	Enthält das Datum und die Uhrzeit des Sendens der Nachricht in UTC, ausgedrückt im ISO-8601-Format.
type	Enthält den Aktivitätstyp "iActivity"

Details zur Eigenschaft

attachmentLayout

Der Layouthinweis für mehrere Anlagen. Standard: list. Mögliche Werte: "list", "carousel"

attachmentLayout?: AttachmentLayoutTypes | string

Eigenschaftswert

AttachmentLayoutTypes | string

attachments

Attachments

attachments?: Attachment[]

Eigenschaftswert

Attachment[]

deliveryMode

Ein Übermittlungshinweis, um den Empfänger über alternative Übermittlungspfade für die Aktivität zu informieren. Der Standardübermittlungsmodus ist "Standard". Mögliche Werte: "normal", "notification"

deliveryMode?: DeliveryModes | string

Eigenschaftswert

DeliveryModes | string

expiration

Die Zeit, zu der die Aktivität als abgelaufen betrachtet und dem Empfänger nicht mehr angezeigt werden soll.

expiration?: Date

Eigenschaftswert

Date

importance

Die Bedeutung der Aktivität. Mögliche Werte: "niedrig", "normal", "hoch"

importance?: ActivityImportance | string

Eigenschaftswert

ActivityImportance | string

inputHint

Gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Mögliche Werte sind: "acceptingInput", "ignoringInput", "expectingInput"

inputHint?: InputHints | string

Eigenschaftswert

InputHints | string

locale

Ein Gebietsschemaname für den Inhalt des Textfelds. Der Gebietsschemaname ist eine Kombination aus einem zwei- oder dreibuchstabenigen ISO 639-Kulturcode, der einer Sprache zugeordnet ist, und einem ZWEI-Buchstaben-Subkulturcode nach ISO 3166, der einem Land oder einer Region zugeordnet ist. Der Gebietsschemaname kann auch einem gültigen BCP-47-Sprachtag entsprechen.

locale?: string

Eigenschaftswert

string

speak

Der zu sprechende Text.

speak?: string

Eigenschaftswert

string

suggestedActions

Die vorgeschlagenen Aktionen für die Aktivität.

suggestedActions?: SuggestedActions

Eigenschaftswert

SuggestedActions

summary

Der Text, der angezeigt werden soll, wenn der Kanal keine Karten rendern kann.

summary?: string

Eigenschaftswert

string

text

Der Textinhalt der Nachricht.

text: string

Eigenschaftswert

string

textFormat

Format der Textfelder Standard:Markdown. Mögliche Werte: "markdown", "plain", "xml"

textFormat?: TextFormatTypes | string

Eigenschaftswert

TextFormatTypes | string

value

Ein Wert, der der Aktivität zugeordnet ist.

value?: any

Eigenschaftswert

any

Geerbte Eigenschaftsdetails

channelData

Enthält kanalspezifische Inhalte.

channelData?: any

Eigenschaftswert

any

Geerbt vonIActivity.channelData

channelId

Enthält eine ID, die den Kanal eindeutig identifiziert. Wird vom Kanal festgelegt.

channelId: string

Eigenschaftswert

string

Geerbt vonIActivity.channelId

conversation

Identifiziert die Unterhaltung, zu der die Aktivität gehört.

conversation: ConversationAccount

Eigenschaftswert

ConversationAccount

Geerbt vonIActivity.conversation

entities

Stellt die Entitäten dar, die in der Nachricht erwähnt wurden.

entities?: Entity[]

Eigenschaftswert

Entity[]

Geerbt vonIActivity.entities

from

Identifiziert den Absender der Nachricht.

from: ChannelAccount

Eigenschaftswert

ChannelAccount

Geerbt vonIActivity.from

id

Enthält eine ID, die die Aktivität im Kanal eindeutig identifiziert.

id?: string

Eigenschaftswert

string

Geerbt vonIActivity.id

localTimestamp

Enthält das lokale Datum und die lokale Uhrzeit der Nachricht, ausgedrückt im ISO-8601-Format. Beispiel: 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: Date

Eigenschaftswert

Date

Geerbt vonIActivity.localTimestamp

recipient

Identifiziert den Empfänger der Nachricht.

recipient: ChannelAccount

Eigenschaftswert

ChannelAccount

Geerbt vonIActivity.recipient

replyToId

Enthält die ID der Nachricht, auf die diese Nachricht eine Antwort ist.

replyToId?: string

Eigenschaftswert

string

Geerbt vonIActivity.replyToId

serviceUrl

Enthält die URL, die den Dienstendpunkt des Kanals angibt. Wird vom Kanal festgelegt.

serviceUrl: string

Eigenschaftswert

string

Geerbt vonIActivity.serviceUrl

timestamp

Enthält das Datum und die Uhrzeit des Sendens der Nachricht in UTC, ausgedrückt im ISO-8601-Format.

timestamp?: Date

Eigenschaftswert

Date

Geerbt vonIActivity.timestamp

type

Enthält den Aktivitätstyp "iActivity"

type: ActivityTypes | string

Eigenschaftswert

ActivityTypes | string

Geerbt vonIActivity.type