ActivityEx module
Functions
| as |
Gibt die Quellaktivität als ICommandActivity-Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als ICommandResultActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IContactRelationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IConversationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IEndOfConversationActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IEventActivity-Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IHandoffActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IInstallationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IInvokeActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IMessageActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IMessageDeleteActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IMessageReactionActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als IMessageUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als ISuggestionActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als ITraceActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| as |
Gibt die Quellaktivität als ITypingActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
| create |
Erstellt eine Aktivität als IContactRelationUpdateActivity -Objekt. |
| create |
Erstellt eine Aktivität als IConversationUpdateActivity -Objekt. |
| create |
Erstellt eine Aktivität als IEndOfConversationActivity -Objekt. |
| create |
Erstellt eine Aktivität als IEventActivity -Objekt. |
| create |
Erstellt eine Aktivität als IHandoffActivity -Objekt. |
| create |
Erstellt eine Aktivität als IInvokeActivity -Objekt. |
| create |
Erstellt eine Aktivität als IMessageActivity -Objekt. |
| create |
Erstellt eine neue Nachrichtenaktivität als Antwort auf diese Aktivität. |
| create |
Erstellt eine neue Ablaufverfolgungsaktivität basierend auf der Quellaktivität. |
| create |
Erstellt eine Aktivität als ITraceActivity -Objekt. |
| create |
Erstellt eine Aktivität als ITypingActivity -Objekt. |
| get |
Erstellt eine Aktivität aus dem Unterhaltungsverweis, wie sie in Bot gepostet wird. |
| get |
Erstellt eine ConversationReference basierend auf der Quellaktivität. |
| get |
Löst die Erwähnungen aus den Entitäten der Quellaktivität auf. Siehe cref="entities" . Siehe cref="mention" . |
| has |
Gibt an, ob die Quellaktivität Inhalte enthält. |
| is |
Gibt an, ob diese Aktivität einen angegebenen Aktivitätstyp aufweist. |
| is |
Bestimmt, ob die Aktivität über eine Http/Https-Verbindung oder Streaming gesendet wurde. Dies kann anhand der ServiceUrl-Eigenschaft bestimmt werden: (1) Alle Kanäle, die Nachrichten über http/https senden, sind kein Streaming (2) Kanäle, die Nachrichten über Streaming senden, verfügen über einen ServiceUrl, der nicht mit http/https beginnt. |
Details zur Funktion
asCommandActivity<T>(Partial<Activity>)
Gibt die Quellaktivität als ICommandActivity-Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asCommandActivity<T>(source: Partial<Activity>): Partial<ICommandActivity<T>>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<ICommandActivity<T>>
Diese Aktivität als Befehlsaktivität; oder NULL.
asCommandResultActivity<T>(Partial<Activity>)
Gibt die Quellaktivität als ICommandResultActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asCommandResultActivity<T>(source: Partial<Activity>): Partial<ICommandResultActivity<T>>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<ICommandResultActivity<T>>
Diese Aktivität als Befehlsergebnisaktivität; oder NULL.
asContactRelationUpdateActivity(Partial<Activity>)
Gibt die Quellaktivität als IContactRelationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asContactRelationUpdateActivity(source: Partial<Activity>): Partial<IContactRelationUpdateActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IContactRelationUpdateActivity>
Diese Aktivität als Kontaktbeziehungsaktualisierungsaktivität; oder NULL.
asConversationUpdateActivity(Partial<Activity>)
Gibt die Quellaktivität als IConversationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asConversationUpdateActivity(source: Partial<Activity>): Partial<IConversationUpdateActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IConversationUpdateActivity>
Diese Aktivität als Unterhaltungsaktualisierungsaktivität; oder NULL.
asEndOfConversationActivity(Partial<Activity>)
Gibt die Quellaktivität als IEndOfConversationActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asEndOfConversationActivity(source: Partial<Activity>): Partial<IEndOfConversationActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IEndOfConversationActivity>
Diese Aktivität als Ende der Unterhaltungsaktivität; oder NULL.
asEventActivity(Partial<Activity>)
Gibt die Quellaktivität als IEventActivity-Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asEventActivity(source: Partial<Activity>): Partial<IEventActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IEventActivity>
Diese Aktivität als Ereignisaktivität; oder NULL.
asHandoffActivity(Partial<Activity>)
Gibt die Quellaktivität als IHandoffActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asHandoffActivity(source: Partial<Activity>): Partial<IHandoffActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IHandoffActivity>
Diese Aktivität als Übergabeaktivität; oder NULL.
asInstallationUpdateActivity(Partial<Activity>)
Gibt die Quellaktivität als IInstallationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asInstallationUpdateActivity(source: Partial<Activity>): Partial<IInstallationUpdateActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IInstallationUpdateActivity>
Diese Aktivität als Installationsupdateaktivität; oder NULL.
asInvokeActivity(Partial<Activity>)
Gibt die Quellaktivität als IInvokeActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asInvokeActivity(source: Partial<Activity>): Partial<IInvokeActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IInvokeActivity>
Diese Aktivität als Aufrufaktivität; oder NULL.
asMessageActivity(Partial<Activity>)
Gibt die Quellaktivität als IMessageActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asMessageActivity(source: Partial<Activity>): Partial<IMessageActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IMessageActivity>
Diese Aktivität als Nachrichtenaktivität; oder NULL.
asMessageDeleteActivity(Partial<Activity>)
Gibt die Quellaktivität als IMessageDeleteActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asMessageDeleteActivity(source: Partial<Activity>): Partial<IMessageDeleteActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IMessageDeleteActivity>
Diese Aktivität als Anforderung zum Löschen von Nachrichten; oder NULL.
asMessageReactionActivity(Partial<Activity>)
Gibt die Quellaktivität als IMessageReactionActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asMessageReactionActivity(source: Partial<Activity>): Partial<IMessageReactionActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IMessageReactionActivity>
Diese Aktivität als Nachrichtenreaktionsaktivität; oder NULL.
asMessageUpdateActivity(Partial<Activity>)
Gibt die Quellaktivität als IMessageUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asMessageUpdateActivity(source: Partial<Activity>): Partial<IMessageUpdateActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<IMessageUpdateActivity>
Diese Aktivität als Nachrichtenaktualisierungsanforderung; oder NULL.
asSuggestionActivity(Partial<Activity>)
Gibt die Quellaktivität als ISuggestionActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asSuggestionActivity(source: Partial<Activity>): Partial<ISuggestionActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<ISuggestionActivity>
Diese Aktivität als Vorschlagsaktivität; oder NULL.
asTraceActivity(Partial<Activity>)
Gibt die Quellaktivität als ITraceActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asTraceActivity(source: Partial<Activity>): Partial<ITraceActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<ITraceActivity>
Diese Aktivität als Ablaufverfolgungsaktivität; oder NULL.
asTypingActivity(Partial<Activity>)
Gibt die Quellaktivität als ITypingActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist.
function asTypingActivity(source: Partial<Activity>): Partial<ITypingActivity>
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Partial<ITypingActivity>
Diese Aktivität als Typisierungsaktivität; oder NULL.
createContactRelationUpdateActivity()
Erstellt eine Aktivität als IContactRelationUpdateActivity -Objekt.
function createContactRelationUpdateActivity(): Partial<IContactRelationUpdateActivity>
Gibt zurück
Partial<IContactRelationUpdateActivity>
Die neue Kontaktbeziehungsaktualisierungsaktivität.
createConversationUpdateActivity()
Erstellt eine Aktivität als IConversationUpdateActivity -Objekt.
function createConversationUpdateActivity(): Partial<IConversationUpdateActivity>
Gibt zurück
Partial<IConversationUpdateActivity>
Die neue Unterhaltungsaktualisierungsaktivität.
createEndOfConversationActivity()
Erstellt eine Aktivität als IEndOfConversationActivity -Objekt.
function createEndOfConversationActivity(): Partial<IEndOfConversationActivity>
Gibt zurück
Partial<IEndOfConversationActivity>
Das neue Ende der Unterhaltungsaktivität.
createEventActivity()
Erstellt eine Aktivität als IEventActivity -Objekt.
function createEventActivity(): Partial<IEventActivity>
Gibt zurück
Partial<IEventActivity>
Die neue Ereignisaktivität.
createHandoffActivity()
Erstellt eine Aktivität als IHandoffActivity -Objekt.
function createHandoffActivity(): Partial<IHandoffActivity>
Gibt zurück
Partial<IHandoffActivity>
Die neue Übergabeaktivität.
createInvokeActivity()
Erstellt eine Aktivität als IInvokeActivity -Objekt.
function createInvokeActivity(): Partial<IInvokeActivity>
Gibt zurück
Partial<IInvokeActivity>
Die neue Aufrufaktivität.
createMessageActivity()
Erstellt eine Aktivität als IMessageActivity -Objekt.
function createMessageActivity(): Partial<IMessageActivity>
Gibt zurück
Partial<IMessageActivity>
Die neue Nachrichtenaktivität.
createReply(Activity, string, string)
Erstellt eine neue Nachrichtenaktivität als Antwort auf diese Aktivität.
function createReply(source: Activity, text?: string, locale?: string): Activity
Parameter
- source
- Activity
Die aktivität, die reagiert werden soll.
- text
-
string
Der Text der Antwort.
- locale
-
string
Der Sprachcode für den @param Text.
Gibt zurück
Die neue Nachrichtenaktivität.
Hinweise
Die neue Aktivität richtet Routinginformationen basierend auf dieser Aktivität ein.
createTrace(Activity, string, unknown, string, string)
Erstellt eine neue Ablaufverfolgungsaktivität basierend auf der Quellaktivität.
function createTrace(source: Activity, name: string, value?: unknown, valueType?: string, label?: string): ITraceActivity
Parameter
- source
- Activity
Die Aktivität, die die Ablaufverfolgung zugrunde bezieht.
- name
-
string
Der Name des zu erstellenden Ablaufverfolgungsvorgangs.
- value
-
unknown
Optional, der Inhalt für diesen Ablaufverfolgungsvorgang.
- valueType
-
string
Optionaler Bezeichner für das Format des @param Werts. Der Standardwert ist der Name des Typs des @param Werts.
- label
-
string
Optional, eine beschreibende Bezeichnung für diesen Ablaufverfolgungsvorgang.
Gibt zurück
Die neue Ablaufverfolgungsaktivität.
createTraceActivity(string, string, unknown, string)
Erstellt eine Aktivität als ITraceActivity -Objekt.
function createTraceActivity(name: string, valueType?: string, value?: unknown, label?: string): Partial<ITraceActivity>
Parameter
- name
-
string
Der Name des zu erstellenden Ablaufverfolgungsvorgangs.
- valueType
-
string
Optionaler Bezeichner für das Format des @param Werts. Der Standardwert ist der Name des Typs des @param Werts.
- value
-
unknown
Optional, der Inhalt für diesen Ablaufverfolgungsvorgang.
- label
-
string
Optional, eine beschreibende Bezeichnung für diesen Ablaufverfolgungsvorgang.
Gibt zurück
Partial<ITraceActivity>
Die neue Ablaufverfolgungsaktivität.
createTypingActivity()
Erstellt eine Aktivität als ITypingActivity -Objekt.
function createTypingActivity(): Partial<ITypingActivity>
Gibt zurück
Partial<ITypingActivity>
Die neue Eingabeaktivität.
getContinuationActivity(Partial<ConversationReference>)
Erstellt eine Aktivität aus dem Unterhaltungsverweis, wie sie in Bot gepostet wird.
function getContinuationActivity(reference: Partial<ConversationReference>): Partial<Activity>
Parameter
- reference
-
Partial<ConversationReference>
die Unterhaltungsreferenz
Gibt zurück
Partial<Activity>
die Aktivität
getConversationReference(Partial<Activity>)
Erstellt eine ConversationReference basierend auf der Quellaktivität.
function getConversationReference(source: Partial<Activity>): ConversationReference
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Ein Unterhaltungsverweis für die Unterhaltung, die die Aktivität enthält.
getMentions(Partial<Activity>)
Löst die Erwähnungen aus den Entitäten der Quellaktivität auf.
Siehe cref="entities" .
Siehe cref="mention" .
function getMentions(source: Partial<Activity>): Mention[]
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
Mention[]
Das Array von Erwähnungen; oder ein leeres Array, wenn keine gefunden wird.
Hinweise
Diese Methode ist nur für die Verwendung mit einer Nachrichtenaktivität vorgesehen, bei der der Aktivitätstyp auf "Nachricht" festgelegt ist.
hasContent(Partial<Activity>)
Gibt an, ob die Quellaktivität Inhalte enthält.
function hasContent(source: Partial<Activity>): boolean
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
boolean
True, wenn diese Aktivität Inhalte zum Senden hat; andernfalls "false".
Hinweise
Diese Methode ist nur für die Verwendung mit einer Nachrichtenaktivität vorgesehen, bei der der Aktivitätstyp auf "Nachricht" festgelegt ist.
isActivity(Partial<Activity>, string)
Gibt an, ob diese Aktivität einen angegebenen Aktivitätstyp aufweist.
function isActivity(source: Partial<Activity>, activityType: string): boolean
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
- activityType
-
string
Der zu überprüfende Aktivitätstyp.
Gibt zurück
boolean
True, wenn die Aktivität vom angegebenen Aktivitätstyp ist; andernfalls "false".
isFromStreamingConnection(Partial<Activity>)
Bestimmt, ob die Aktivität über eine Http/Https-Verbindung oder Streaming gesendet wurde. Dies kann anhand der ServiceUrl-Eigenschaft bestimmt werden: (1) Alle Kanäle, die Nachrichten über http/https senden, sind kein Streaming (2) Kanäle, die Nachrichten über Streaming senden, verfügen über einen ServiceUrl, der nicht mit http/https beginnt.
function isFromStreamingConnection(source: Partial<Activity>): boolean
Parameter
- source
-
Partial<Activity>
Die Quellaktivität.
Gibt zurück
boolean
True, wenn die Aktivität von einer Streamingverbindung stammt.