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 Supersettyp.
Konstruktoren
Felder
ContentType |
Der HTTP- |
Eigenschaften
Action |
Dient zum Abrufen oder Festlegen einer Zeichenfolge, die angibt, ob der Empfänger eines contactRelationUpdate zu der Kontaktliste des Absenders hinzugefügt oder daraus entfernt wurde. |
AttachmentLayout |
Ruft den Layouthinweis für mehrere Anlagen ab oder legt diese fest. Standard: Liste. Mögliche Werte werden durch AttachmentLayoutTypesdefiniert. |
Attachments |
Ruft die Anlagen für die Aktivität ab oder legt sie fest. |
CallerId |
Dient zum Abrufen oder Festlegen einer Zeichenfolge, die einen IRI enthält, der den Aufrufer eines Bots identifiziert. Dieses Feld soll nicht über das Kabel übertragen werden, sondern von Bots und Clients basierend auf kryptografisch überprüften Daten gefüllt werden, die die Identität der Aufrufer (z. B. Token) bestätigen. |
ChannelData |
Ruft kanalspezifische Inhalte ab oder legt sie fest. |
ChannelId |
Dient zum Abrufen oder Festlegen einer ID, die den Kanal eindeutig identifiziert. Vom Kanal festgelegt. |
Code |
Dient zum Abrufen oder Festlegen eines Codes für endOfConversation-Aktivitäten, der angibt, warum die Unterhaltung beendet wurde. Mögliche Werte werden in EndOfConversationCodesdefiniert. |
Conversation |
Ruft die Unterhaltung ab, zu der die Aktivität gehört, oder legt sie fest. |
DeliveryMode |
Dient zum Abrufen oder Festlegen eines Übermittlungshinweiss, der an den Empfänger alternative Übermittlungspfade für die Aktivität signalisiert. Der Standardübermittlungsmodus ist "Standard". Mögliche Werte werden in DeliveryModesdefiniert. |
Entities |
Ruft die Entitäten ab, die in der Nachricht erwähnt wurden, oder legt diese fest. |
Expiration |
Ruft die Uhrzeit ab, zu der die Aktivität als "abgelaufen" betrachtet werden soll, und sollte dem Empfänger nicht angezeigt werden. |
From |
Dient zum Abrufen oder Festlegen des Absenders der Nachricht. |
HistoryDisclosed |
Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der vorherige Verlauf des Kanals offengelegt wird. |
Id |
Dient zum Abrufen oder Festlegen einer ID, die die Aktivität im Kanal eindeutig identifiziert. |
Importance |
Ruft die Wichtigkeit der Aktivität ab oder legt sie fest. Mögliche Werte werden in ActivityImportancedefiniert. |
InputHint |
Dient zum Abrufen oder Festlegen einer Zeichenfolge, die angibt, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde (siehe InputHints. |
Label |
Dient zum Abrufen oder Festlegen einer beschreibenden Bezeichnung für die Aktivität. |
ListenFor |
Dient zum Abrufen oder Festlegen einer Liste von Ausdrücken und Verweisen, auf die Sprach- und Sprachprimierungssysteme lauschen sollten. |
Locale |
Dient zum Abrufen oder Festlegen eines BCP-47-Gebietsschemanamens für den Inhalt des Textfelds. |
LocalTimestamp |
Ruft Datum und Uhrzeit des Sendens der Nachricht im ISO-8601-Format ab oder legt sie fest. Beispiel: 2016-09-23T13:07:49.4714686-07:00. |
LocalTimezone |
Dient zum Abrufen oder Festlegen des Namens der Zeitzone, die zum Definieren der ortszeit für die Nachricht verwendet wird, ausgedrückt im IANA Time Zone-Datenbankformat. Beispiel: Amerika/Los_Angeles. |
MembersAdded |
Dient zum Abrufen oder Festlegen der Auflistung von Mitgliedern, die der Unterhaltung hinzugefügt wurden. |
MembersRemoved |
Dient zum Abrufen oder Festlegen der Auflistung von Mitgliedern, die aus der Unterhaltung entfernt wurden. |
Name |
Dient zum Abrufen oder Festlegen des Namens des Vorgangs, der einer Aufruf- oder Ereignisaktivität zugeordnet ist. |
Properties |
Dient zum Abrufen oder Festlegen von Eigenschaften, die nicht anderweitig vom Activity Typ definiert sind, die jedoch im serialisierten REST-JSON-Objekt angezeigt werden. |
ReactionsAdded |
Dient zum Abrufen oder Festlegen der Auflistung von Reaktionen, die der Unterhaltung hinzugefügt wurden. |
ReactionsRemoved |
Dient zum Abrufen oder Festlegen der Auflistung von Reaktionen, die aus der Unterhaltung entfernt wurden. |
Recipient |
Dient zum Abrufen oder Festlegen des Empfängers der Nachricht. |
RelatesTo |
Dient zum Abrufen oder Festlegen eines ConversationReference auf eine andere Unterhaltung oder Aktivität. |
ReplyToId |
Ruft die ID der Nachricht ab, auf die diese Nachricht eine Antwort ist, oder legt sie fest. |
SemanticAction |
Dient zum Abrufen oder Festlegen einer optionalen programmgesteuerten Aktion, die diese Anforderung begleitet. |
ServiceUrl |
Dient zum Abrufen oder Festlegen der URL, die den Dienstendpunkt des Kanals angibt. 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 anzuzeigenden Text ab oder legt diesen fest, wenn der Kanal Karten nicht rendern kann. |
Text |
Dient zum Abrufen oder Festlegen des Textinhalts der Nachricht. |
TextFormat |
Ruft das Format von Textfeldern ab oder legt dieses fest. Standard: Markdown. Mögliche Werte werden durch TextFormatTypesdefiniert. |
TextHighlights |
Dient zum Abrufen oder Festlegen der Auflistung von Textfragmenten, die hervorgehoben werden sollen, wenn die Aktivität einen ReplyToId -Wert enthält. |
Timestamp |
Ruft das Datum und die Uhrzeit des Sendens der Nachricht in UTC ab, ausgedrückt im ISO-8601-Format. |
TopicName |
Dient zum Abrufen oder Festlegen des aktualisierten Themennamens der Unterhaltung. |
Type |
Dient zum Abrufen oder Festlegen des Aktivitätstyps. Mögliche Werte sind: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'. |
Value |
Dient zum Abrufen oder Festlegen eines Werts, der der Aktivität zugeordnet ist. |
ValueType |
Dient zum Abrufen oder Festlegen des Typs des Wertobjekts der Aktivität. |
Methoden
ApplyConversationReference(ConversationReference, Boolean) |
Aktualisiert diese Aktivität mit den Übermittlungsinformationen aus einer vorhandenen ConversationReference. |
AsCommandActivity() |
Gibt diese Aktivität als ICommandActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsCommandResultActivity() |
Gibt diese Aktivität als ICommandResultActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsContactRelationUpdateActivity() |
Gibt diese Aktivität als IContactRelationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsConversationUpdateActivity() |
Gibt diese Aktivität als IConversationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsEndOfConversationActivity() |
Gibt diese Aktivität als IEndOfConversationActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsEventActivity() |
Gibt diese Aktivität als IEventActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsHandoffActivity() |
Gibt diese Aktivität als IHandoffActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsInstallationUpdateActivity() |
Gibt diese Aktivität als IInstallationUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsInvokeActivity() |
Gibt diese Aktivität als IInvokeActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsMessageActivity() |
Gibt diese Aktivität als IMessageActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsMessageDeleteActivity() |
Gibt diese Aktivität als IMessageDeleteActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsMessageReactionActivity() |
Gibt diese Aktivität als IMessageReactionActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsMessageUpdateActivity() |
Gibt diese Aktivität als IMessageUpdateActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsSuggestionActivity() |
Gibt diese Aktivität als ISuggestionActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsTraceActivity() |
Gibt diese Aktivität als ITraceActivity -Objekt zurück; oder NULL, wenn dies nicht dieser Aktivitätstyp ist. |
AsTypingActivity() |
Gibt diese Aktivität als ITypingActivity -Objekt zurück; oder NULL, wenn dies nicht dieser 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 typiertes 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 aus dem Senden einer Aktivität. |
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 Sie, ob die Aktivität über eine Http/Https-Verbindung oder Streaming gesendet wurde. Dies kann durch Einen Blick auf die ServiceUrl-Eigenschaft bestimmt werden: (1) Alle Kanäle, die Nachrichten über http/https senden, streamen nicht (2) Kanäle, die Nachrichten über Streaming senden, verfügen über einen ServiceUrl, der nicht mit http/https beginnt. |
TryGetChannelData<TypeT>(TypeT) |
Ruft die Kanaldaten für diese Aktivität als stark typiertes 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. |
TeamsGetTeamOnBehalfOf(IActivity) |
Ruft die Liste "Teams OnBehalfOf" aus der aktuellen Aktivität ab. |
TeamsNotifyUser(IActivity, Boolean, String) |
Konfiguriert die aktuelle Aktivität, um eine Benachrichtigung in Teams zu generieren. |
TeamsNotifyUser(IActivity) |
Konfiguriert die aktuelle Aktivität, um eine Benachrichtigung in Teams zu generieren. |
MentionsId(IMessageActivity, String) |
Gibt es eine Erwähnung der ID in der Text-Eigenschaft. |
MentionsRecipient(IMessageActivity) |
Gibt es eine Erwähnung von Recipient.Id in der Text-Eigenschaft. |
RemoveMentionText(IMessageActivity, String) |
Entfernen Sie einen Erwähnungstext für die angegebene ID aus der Activity.Text-Eigenschaft. Wenn die Nachricht beispielsweise @echoBot Hi Bot angezeigt wird, wird dadurch "@echoBot" entfernt, sodass "Hi Bot" verlassen wird. |
RemoveRecipientMention(IMessageActivity) |
Entfernen von Empfänger-Erwähnungstext aus der Text-Eigenschaft. Verwenden Sie vorsichtig, 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. |