Activity Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Eine Aktivität ist der grundlegende Kommunikationstyp für das Bot Framework 3.0-Protokoll.
public class Activity : Microsoft.Bot.Schema.ICommandActivity, Microsoft.Bot.Schema.ICommandResultActivity, Microsoft.Bot.Schema.IContactRelationUpdateActivity, Microsoft.Bot.Schema.IConversationUpdateActivity, Microsoft.Bot.Schema.IEndOfConversationActivity, Microsoft.Bot.Schema.IEventActivity, Microsoft.Bot.Schema.IHandoffActivity, Microsoft.Bot.Schema.IInstallationUpdateActivity, Microsoft.Bot.Schema.IInvokeActivity, Microsoft.Bot.Schema.IMessageDeleteActivity, Microsoft.Bot.Schema.IMessageReactionActivity, Microsoft.Bot.Schema.IMessageUpdateActivity, Microsoft.Bot.Schema.ISuggestionActivity, Microsoft.Bot.Schema.ITraceActivity, Microsoft.Bot.Schema.ITypingActivity
type Activity = class
interface IActivity
interface IConversationUpdateActivity
interface IContactRelationUpdateActivity
interface IInstallationUpdateActivity
interface IMessageActivity
interface IMessageUpdateActivity
interface IMessageDeleteActivity
interface IMessageReactionActivity
interface ISuggestionActivity
interface ITypingActivity
interface IEndOfConversationActivity
interface IEventActivity
interface IInvokeActivity
interface ITraceActivity
interface IHandoffActivity
interface ICommandActivity
interface ICommandResultActivity
Public Class Activity
Implements ICommandActivity, ICommandResultActivity, IContactRelationUpdateActivity, IConversationUpdateActivity, IEndOfConversationActivity, IEventActivity, IHandoffActivity, IInstallationUpdateActivity, IInvokeActivity, IMessageDeleteActivity, IMessageReactionActivity, IMessageUpdateActivity, ISuggestionActivity, ITraceActivity, ITypingActivity
- Vererbung
-
Activity
- Implementiert
-
IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity
Hinweise
Die Activity-Klasse enthält alle Eigenschaften, die einzelne spezifischere Aktivitäten enthalten können. Es handelt sich um einen Superset-Typ.
Konstruktoren
Felder
ContentType |
Der HTTP-Entitätsheader |
Eigenschaften
Action |
Ruft eine Zeichenfolge ab, die angibt, ob der Empfänger eines contactRelationUpdate der Kontaktliste des Absenders hinzugefügt oder daraus entfernt wurde, oder legt diese fest. |
AttachmentLayout |
Ruft den Layouthinweis für mehrere Anlagen ab oder legt diese fest. Standard: list. Mögliche Werte werden durch AttachmentLayoutTypesdefiniert. |
Attachments |
Ruft die Anlagen für die Aktivität ab oder legt sie fest. |
CallerId |
Ruft eine Zeichenfolge ab, die eine IRI enthält, die den Aufrufer eines Bots identifiziert, oder legt diese fest. 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 |
Ruft kanalspezifische Inhalte ab oder legt sie fest. |
ChannelId |
Ruft eine ID ab, die den Kanal eindeutig identifiziert, oder legt diese fest. Wird vom Kanal festgelegt. |
Code |
Ruft einen Code für endOfConversation-Aktivitäten ab, der angibt, warum die Unterhaltung beendet wurde, oder legt diesen fest. Mögliche Werte werden in EndOfConversationCodesdefiniert. |
Conversation |
Ruft die Unterhaltung ab, zu der die Aktivität gehört, oder legt diese fest. |
DeliveryMode |
Ruft einen Übermittlungshinweis ab, der dem Empfänger alternative Übermittlungspfade für die Aktivität signalisiert, oder legt diesen fest. Der Standardübermittlungsmodus ist "Default". Mögliche Werte werden in DeliveryModesdefiniert. |
Entities |
Ruft die Entitäten ab, die in der Nachricht erwähnt wurden, oder legt sie fest. |
Expiration |
Ruft den Zeitpunkt ab, zu dem die Aktivität als "abgelaufen" betrachtet werden soll und dem Empfänger nicht angezeigt werden soll, oder legt diesen fest. |
From |
Ruft den Absender der Nachricht ab oder legt den Absender der Nachricht fest. |
HistoryDisclosed |
Ruft einen Wert ab, der angibt, ob der vorherige Verlauf des Kanals offengelegt wird, oder legt einen Wert fest. |
Id |
Ruft eine ID ab, die die Aktivität im Kanal eindeutig identifiziert, oder legt diese fest. |
Importance |
Ruft die Wichtigkeit der Aktivität ab oder legt sie fest. Mögliche Werte werden in ActivityImportancedefiniert. |
InputHint |
Ruft eine Zeichenfolge ab, die angibt, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde , oder legt diese fest (siehe InputHints. |
Label |
Ruft eine beschreibende Bezeichnung für die Aktivität ab oder legt diese fest. |
ListenFor |
Ruft eine Liste von Ausdrücken und Verweisen ab, auf die Sprach- und Sprachvorbereitungssysteme lauschen sollen, oder legt diese fest. |
Locale |
Ruft einen BCP-47-Gebietsschemanamen für den Inhalt des Textfelds ab oder legt diese fest. |
LocalTimestamp |
Ruft das Datum und die Uhrzeit des Sendens der Nachricht in Ortszeit im ISO-8601-Format ab oder legt dieses fest. Beispiel: 2016-09-23T13:07:49.4714686-07:00. |
LocalTimezone |
Ruft den Namen der Zeitzone ab, die zum Definieren der Ortszeit für die Nachricht verwendet wird, ausgedrückt im IANA-Zeitzonen-Datenbankformat, oder legt diesen fest. Beispiel: America/Los_Angeles. |
MembersAdded |
Ruft die Auflistung der Mitglieder ab, die der Unterhaltung hinzugefügt wurden, oder legt diese fest. |
MembersRemoved |
Ruft die Auflistung von Mitgliedern ab, die aus der Unterhaltung entfernt wurden, oder legt diese fest. |
Name |
Ruft den Namen des Vorgangs ab, der einer Aufruf- oder Ereignisaktivität zugeordnet ist, oder legt diesen fest. |
Properties |
Ruft Eigenschaften ab, die nicht anderweitig vom Activity Typ definiert werden, die aber im serialisierten REST-JSON-Objekt angezeigt werden können, oder legt diese fest. |
ReactionsAdded |
Ruft die Auflistung der Reaktionen ab, die der Konversation hinzugefügt wurden, oder legt diese fest. |
ReactionsRemoved |
Ruft die Auflistung von Reaktionen ab, die aus der Unterhaltung entfernt wurden, oder legt diese fest. |
Recipient |
Ruft den Empfänger der Nachricht ab oder legt den Empfänger der Nachricht fest. |
RelatesTo |
Ruft eine auf eine andere Unterhaltung oder Aktivität ab oder legt sie ConversationReference fest. |
ReplyToId |
Ruft die ID der Nachricht ab, auf die diese Nachricht eine Antwort ist, oder legt diese fest. |
SemanticAction |
Ruft eine optionale programmgesteuerte Aktion ab, die diese Anforderung begleitet, oder legt diese fest. |
ServiceUrl |
Ruft die URL ab, die den Dienstendpunkt des Kanals angibt, oder legt diese fest. Wird vom Kanal festgelegt. |
Speak |
Ruft den zu sprechenden Text ab oder legt diesen fest. |
SuggestedActions |
Ruft die vorgeschlagenen Aktionen für die Aktivität ab oder legt sie fest. |
Summary |
Ruft den text ab, der angezeigt werden soll, wenn der Kanal Karten nicht rendern kann, oder legt diesen fest. |
Text |
Ruft den Textinhalt der Nachricht ab oder legt diese fest. |
TextFormat |
Ruft das Format von Textfelder ab oder legt es fest. Standard: Markdown. Mögliche Werte werden durch TextFormatTypesdefiniert. |
TextHighlights |
Ruft die Auflistung von Textfragmenten ab, die hervorgehoben werden sollen, wenn die Aktivität einen ReplyToId-Wert enthält, oder legt diese fest. |
Timestamp |
Ruft das Datum und die Uhrzeit des Sendens der Nachricht in UTC im ISO-8601-Format ab oder legt diese fest. |
TopicName |
Ruft den aktualisierten Themennamen der Unterhaltung ab oder legt diese fest. |
Type |
Ruft den Aktivitätstyp ab oder legt den Aktivitätstyp fest. Mögliche Werte sind: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff". |
Value |
Ruft einen Wert ab, der der Aktivität zugeordnet ist, oder legt diesen fest. |
ValueType |
Ruft den Typ des Wertobjekts der Aktivität ab oder legt diese fest. |
Methoden
ApplyConversationReference(ConversationReference, Boolean) |
Aktualisierungen diese Aktivität mit den Übermittlungsinformationen aus einer vorhandenen ConversationReference. |
AsCommandActivity() |
Gibt diese Aktivität als Objekt ICommandActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsCommandResultActivity() |
Gibt diese Aktivität als Objekt ICommandResultActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsContactRelationUpdateActivity() |
Gibt diese Aktivität als Objekt IContactRelationUpdateActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsConversationUpdateActivity() |
Gibt diese Aktivität als Objekt IConversationUpdateActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsEndOfConversationActivity() |
Gibt diese Aktivität als Objekt IEndOfConversationActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsEventActivity() |
Gibt diese Aktivität als Objekt IEventActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsHandoffActivity() |
Gibt diese Aktivität als Objekt IHandoffActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsInstallationUpdateActivity() |
Gibt diese Aktivität als Objekt IInstallationUpdateActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsInvokeActivity() |
Gibt diese Aktivität als Objekt IInvokeActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsMessageActivity() |
Gibt diese Aktivität als Objekt IMessageActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsMessageDeleteActivity() |
Gibt diese Aktivität als Objekt IMessageDeleteActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsMessageReactionActivity() |
Gibt diese Aktivität als Objekt IMessageReactionActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsMessageUpdateActivity() |
Gibt diese Aktivität als Objekt IMessageUpdateActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsSuggestionActivity() |
Gibt diese Aktivität als Objekt ISuggestionActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsTraceActivity() |
Gibt diese Aktivität als Objekt ITraceActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
AsTypingActivity() |
Gibt diese Aktivität als Objekt ITypingActivity oder NULL zurück, wenn dies nicht der Aktivitätstyp ist. |
CreateContactRelationUpdateActivity() |
Erstellt eine Instanz der Activity -Klasse als IContactRelationUpdateActivity -Objekt. |
CreateConversationUpdateActivity() |
Erstellt eine Instanz der Activity -Klasse als IConversationUpdateActivity -Objekt. |
CreateEndOfConversationActivity() |
Erstellt eine Instanz der Activity -Klasse als IEndOfConversationActivity -Objekt. |
CreateEventActivity() |
Erstellt eine Instanz der Activity -Klasse als IEventActivity -Objekt. |
CreateHandoffActivity() |
Erstellt eine Instanz der Activity -Klasse als IHandoffActivity -Objekt. |
CreateInvokeActivity() |
Erstellt eine Instanz der Activity -Klasse als IInvokeActivity -Objekt. |
CreateMessageActivity() |
Erstellt eine Instanz der Activity -Klasse als IMessageActivity -Objekt. |
CreateReply(String, String) |
Erstellt eine neue Nachrichtenaktivität als Antwort auf diese Aktivität. |
CreateTrace(String, Object, String, String) |
Erstellt eine neue Ablaufverfolgungsaktivität basierend auf dieser Aktivität. |
CreateTraceActivity(String, String, Object, String) |
Erstellt eine Instanz der Activity -Klasse als ITraceActivity -Objekt. |
CreateTypingActivity() |
Erstellt eine Instanz der Activity -Klasse als ITypingActivity -Objekt. |
GetChannelData<TypeT>() |
Ruft die Kanaldaten für diese Aktivität als stark typisiertes Objekt ab. |
GetConversationReference() |
Erstellt eine ConversationReference basierend auf dieser Aktivität. |
GetMentions() |
Löst die Erwähnungen aus den Entitäten dieser Aktivität auf. |
GetReplyConversationReference(ResourceResponse) |
Erstellen Sie eine ConversationReference basierend auf den Unterhaltungsinformationen dieser Aktivität und dem ResourceResponse-Objekt, das eine Aktivität sendet. |
HasContent() |
Gibt an, ob diese Aktivität Inhalte enthält. |
IsActivity(String) |
Gibt an, ob diese Aktivität einen angegebenen Aktivitätstyp aufweist. |
IsFromStreamingConnection() |
Ermitteln, ob die Aktivität über eine Http/Https-Verbindung oder Streaming gesendet wurde. Dies kann anhand der ServiceUrl-Eigenschaft ermittelt 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 eine ServiceUrl, die nicht mit http/https beginnt. |
TryGetChannelData<TypeT>(TypeT) |
Ruft die Kanaldaten für diese Aktivität als stark typisiertes Objekt ab. Ein Rückgabewert gibt an, ob der Vorgang erfolgreich war. |
Erweiterungsmethoden
TeamsGetChannelId(IActivity) |
Ruft die Kanal-ID des Teams aus der aktuellen Aktivität ab. |
TeamsGetMeetingInfo(IActivity) |
Ruft das TeamsMeetingInfo-Objekt aus der aktuellen Aktivität ab. |
TeamsGetSelectedChannelId(IActivity) |
Ruft die ausgewählte Kanal-ID des Teams aus der aktuellen Aktivität ab. |
TeamsGetTeamInfo(IActivity) |
Ruft das TeamsInfo-Objekt aus der aktuellen Aktivität ab. |
TeamsNotifyUser(IActivity) |
Konfiguriert die aktuelle Aktivität, um eine Benachrichtigung in Teams zu generieren. |
TeamsNotifyUser(IActivity, Boolean, String) |
Konfiguriert die aktuelle Aktivität, um eine Benachrichtigung in Teams zu generieren. |
MentionsId(IMessageActivity, String) |
Gibt es eine Erwähnung von ID in der Text-Eigenschaft. |
MentionsRecipient(IMessageActivity) |
Gibt es eine Erwähnung von Recipient.Id in der Text-Eigenschaft. |
RemoveMentionText(IMessageActivity, String) |
Entfernen Sie jeden Erwähnungstext für die angegebene ID aus der Activity.Text-Eigenschaft. Aufgrund der Meldung @echoBot Hi Bot wird beispielsweise "@echoBot" entfernt, wobei "Hi Bot" belassen wird. |
RemoveRecipientMention(IMessageActivity) |
Entfernen Sie den Empfängererwähnungstext aus der Text-Eigenschaft. Verwenden Sie mit Vorsicht, da diese Funktion den Text in der Aktivität ändert. |
GetLocale(IActivity) |
Ruft das Gebietsschema für die Aktivität ab. |
SetLocale(IActivity, String) |
Legt das Gebietsschema für die Aktivität fest. |