Activity interface

Paket:

botframework-schema

Eine Aktivität ist der grundlegende Kommunikationstyp für das Bot Framework 3.0-Protokoll.

Eigenschaften

action	Gibt an, ob der Empfänger eines contactRelationUpdate hinzugefügt oder aus der Kontaktliste des Absenders entfernt wurde.
attachmentLayout	Der Layouthinweis für mehrere Anlagen. Standard: list. Mögliche Werte: "list", "karussell"
attachments	Attachments
callerId	Eine Zeichenfolge, die einen URI enthält, der den Aufrufer eines Bots identifiziert. Dieses Feld ist nicht für die Übertragung vorgesehen, sondern wird stattdessen durch Bots und Clients auf der Grundlage kryptografisch verifizierbarer Daten aufgefüllt, die die Identität der Aufrufer bestätigen (beispielsweise Token).
channelData	Enthält kanalspezifische Inhalte.
channelId	Enthält eine ID, die den Kanal eindeutig identifiziert. Wird vom Kanal festgelegt.
code	Der Code für endOfConversation-Aktivitäten, der angibt, warum die Unterhaltung beendet wurde. Mögliche Werte: "unknown", "completedSuccessfully", "userCancelled", "botTimedOut", "botIssuedInvalidMessage", "channelFailed"
conversation	Identifiziert die Unterhaltung, zu der die Aktivität gehört.
deliveryMode	Ein Übermittlungshinweis, um den Empfänger über alternative Übermittlungspfade für die Aktivität zu informieren. Der Standardübermittlungsmodus ist "Default". Mögliche Werte: "normal", "notification", "expectReplies", "ephemeral"
entities	Stellt die Entitäten dar, die in der Nachricht erwähnt wurden.
expiration	Die Zeit, zu der die Aktivität als abgelaufen betrachtet und dem Empfänger nicht mehr angezeigt werden soll.
from	Identifiziert den Absender der Nachricht.
historyDisclosed	Gibt an, ob der vorherige Verlauf des Kanals offengelegt wird.
id	Enthält eine ID, die die Aktivität im Kanal eindeutig identifiziert.
importance	Die Wichtigkeit der Aktivität. Mögliche Werte: "low", "normal", "high"
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"
label	Eine aussagekräftige Bezeichnung für die Aktivität.
listenFor	Liste der Ausdrücke und Verweise, auf die Sprach- und Sprachvorbereitungssysteme lauschen sollten
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 iso 3166 zweistelligen Subkulturcode, der einem Land oder einer Region zugeordnet ist. Der Gebietsschemaname kann auch einem gültigen BCP-47-Sprachtag entsprechen.
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.
localTimezone	Enthält den Namen der lokalen Zeitzone der Nachricht, ausgedrückt im Format der IANA-Zeitzonendatenbank. Beispiel: America/Los_Angeles.
membersAdded	Die Sammlung der Mitglieder, die der Unterhaltung hinzugefügt wurden.
membersRemoved	Die Sammlung von Mitgliedern, die aus der Unterhaltung entfernt wurden.
name	Der Name des Vorgangs, der einer Aufruf- oder Ereignisaktivität zugeordnet ist.
reactionsAdded	Die Auflistung von Reaktionen, die der Konversation hinzugefügt werden.
reactionsRemoved	Die Auflistung von Reaktionen, die aus der Konversation entfernt werden.
recipient	Identifiziert den Empfänger der Nachricht.
relatesTo	Ein Verweis auf eine andere Unterhaltung oder Aktivität.
replyToId	Enthält die ID der Nachricht, auf die diese Nachricht eine Antwort ist.
semanticAction	Eine optionale programmgesteuerte Aktion, die diese Anforderung begleitet
serviceUrl	Enthält die URL, die den Dienstendpunkt des Kanals angibt. Wird vom Kanal festgelegt.
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 Default:markdown. Mögliche Werte: "markdown", "plain", "xml"
textHighlights	Die Auflistung von Textfragmenten, die hervorgehoben werden sollen, wenn die Aktivität einen ReplyToId-Wert enthält.
timestamp	Enthält das Datum und die Uhrzeit des Sendens der Nachricht in UTC, ausgedrückt im ISO-8601-Format.
topicName	Der aktualisierte Themenname der Unterhaltung.
type	Enthält den Aktivitätstyp. Mögliche Werte: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff"
value	Ein Wert, der der Aktivität zugeordnet ist.
valueType	Die Art des Wertobjekts der Aktivität.

Details zur Eigenschaft

action

Gibt an, ob der Empfänger eines contactRelationUpdate hinzugefügt oder aus der Kontaktliste des Absenders entfernt wurde.

action?: string

Eigenschaftswert

string

attachmentLayout

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

attachmentLayout?: AttachmentLayoutTypes | string

Eigenschaftswert

AttachmentLayoutTypes | string

attachments

Attachments

attachments?: Attachment[]

Eigenschaftswert

Attachment[]

callerId

Eine Zeichenfolge, die einen URI enthält, der den Aufrufer eines Bots identifiziert. Dieses Feld ist nicht für die Übertragung vorgesehen, sondern wird stattdessen durch Bots und Clients auf der Grundlage kryptografisch verifizierbarer Daten aufgefüllt, die die Identität der Aufrufer bestätigen (beispielsweise Token).

callerId: string

Eigenschaftswert

string

channelData

Enthält kanalspezifische Inhalte.

channelData?: any

Eigenschaftswert

any

channelId

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

channelId: string

Eigenschaftswert

string

code

Der Code für endOfConversation-Aktivitäten, der angibt, warum die Unterhaltung beendet wurde. Mögliche Werte: "unknown", "completedSuccessfully", "userCancelled", "botTimedOut", "botIssuedInvalidMessage", "channelFailed"

code?: EndOfConversationCodes | string

Eigenschaftswert

EndOfConversationCodes | string

conversation

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

conversation: ConversationAccount

Eigenschaftswert

ConversationAccount

deliveryMode

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

deliveryMode?: DeliveryModes | string

Eigenschaftswert

DeliveryModes | string

entities

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

entities?: Entity[]

Eigenschaftswert

Entity[]

expiration

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

expiration?: Date

Eigenschaftswert

Date

from

Identifiziert den Absender der Nachricht.

from: ChannelAccount

Eigenschaftswert

ChannelAccount

historyDisclosed

Gibt an, ob der vorherige Verlauf des Kanals offengelegt wird.

historyDisclosed?: boolean

Eigenschaftswert

boolean

id

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

id?: string

Eigenschaftswert

string

importance

Die Wichtigkeit der Aktivität. Mögliche Werte: "low", "normal", "high"

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

label

Eine aussagekräftige Bezeichnung für die Aktivität.

label: string

Eigenschaftswert

string

listenFor

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

listenFor: string[]

Eigenschaftswert

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 iso 3166 zweistelligen Subkulturcode, der einem Land oder einer Region zugeordnet ist. Der Gebietsschemaname kann auch einem gültigen BCP-47-Sprachtag entsprechen.

locale?: string

Eigenschaftswert

string

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

localTimezone

Enthält den Namen der lokalen Zeitzone der Nachricht, ausgedrückt im Format der IANA-Zeitzonendatenbank. Beispiel: America/Los_Angeles.

localTimezone: string

Eigenschaftswert

string

membersAdded

Die Sammlung der Mitglieder, die der Unterhaltung hinzugefügt wurden.

membersAdded?: ChannelAccount[]

Eigenschaftswert

ChannelAccount[]

membersRemoved

Die Sammlung von Mitgliedern, die aus der Unterhaltung entfernt wurden.

membersRemoved?: ChannelAccount[]

Eigenschaftswert

ChannelAccount[]

name

Der Name des Vorgangs, der einer Aufruf- oder Ereignisaktivität zugeordnet ist.

name?: ActivityEventNames | string

Eigenschaftswert

ActivityEventNames | string

reactionsAdded

Die Auflistung von Reaktionen, die der Konversation hinzugefügt werden.

reactionsAdded?: MessageReaction[]

Eigenschaftswert

MessageReaction[]

reactionsRemoved

Die Auflistung von Reaktionen, die aus der Konversation entfernt werden.

reactionsRemoved?: MessageReaction[]

Eigenschaftswert

MessageReaction[]

recipient

Identifiziert den Empfänger der Nachricht.

recipient: ChannelAccount

Eigenschaftswert

ChannelAccount

relatesTo

Ein Verweis auf eine andere Unterhaltung oder Aktivität.

relatesTo?: ConversationReference

Eigenschaftswert

ConversationReference

replyToId

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

replyToId?: string

Eigenschaftswert

string

semanticAction

Eine optionale programmgesteuerte Aktion, die diese Anforderung begleitet

semanticAction?: SemanticAction

Eigenschaftswert

SemanticAction

serviceUrl

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

serviceUrl: 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 Default:markdown. Mögliche Werte: "markdown", "plain", "xml"

textFormat?: TextFormatTypes | string

Eigenschaftswert

TextFormatTypes | string

textHighlights

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

textHighlights?: TextHighlight[]

Eigenschaftswert

TextHighlight[]

timestamp

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

timestamp?: Date

Eigenschaftswert

Date

topicName

Der aktualisierte Themenname der Unterhaltung.

topicName?: string

Eigenschaftswert

string

type

Enthält den Aktivitätstyp. Mögliche Werte: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff"

type: ActivityTypes | string

Eigenschaftswert

ActivityTypes | string

value

Ein Wert, der der Aktivität zugeordnet ist.

value?: any

Eigenschaftswert

any

valueType

Die Art des Wertobjekts der Aktivität.

valueType: string

Eigenschaftswert

string