Activity Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Działanie to podstawowy typ komunikacji dla protokołu Bot Framework 3.0.
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
- Dziedziczenie
-
Activity
- Implementuje
-
IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity
Uwagi
Klasa Activity zawiera wszystkie właściwości, które mogą zawierać poszczególne, bardziej szczegółowe działania. Jest to typ nadzbioru.
Konstruktory
Pola
ContentType |
Nagłówek jednostki |
Właściwości
Action |
Pobiera lub ustawia ciąg wskazujący, czy odbiorca contactRelationUpdate został dodany do lub usunięty z listy kontaktów nadawcy. |
AttachmentLayout |
Pobiera lub ustawia wskazówkę układu dla wielu załączników. Ustawienie domyślne: lista. Możliwe wartości są definiowane przez AttachmentLayoutTypes. |
Attachments |
Pobiera lub ustawia załączniki dla działania. |
CallerId |
Pobiera lub ustawia ciąg zawierający IRI identyfikujący obiekt wywołujący bota. To pole nie jest przeznaczone do przesyłania za pośrednictwem przewodu, ale zamiast tego jest wypełniane przez boty i klientów na podstawie kryptograficznie weryfikowalnych danych, które potwierdzają tożsamość osób wywołujących (np. tokeny). |
ChannelData |
Pobiera lub ustawia zawartość specyficzną dla kanału. |
ChannelId |
Pobiera lub ustawia identyfikator, który jednoznacznie identyfikuje kanał. Ustaw według kanału. |
Code |
Pobiera lub ustawia kod dla działań endOfConversation, które wskazują, dlaczego konwersacja została zakończona. Możliwe wartości są definiowane w EndOfConversationCodes. |
Conversation |
Pobiera lub ustawia konwersację, do której należy działanie. |
DeliveryMode |
Pobiera lub ustawia wskazówkę dostarczania, aby sygnalizować adresatowi alternatywne ścieżki dostarczania dla działania. Domyślny tryb dostarczania to "default". Możliwe wartości są definiowane w DeliveryModes. |
Entities |
Pobiera lub ustawia jednostki wymienione w komunikacie. |
Expiration |
Pobiera lub ustawia czas, w którym działanie powinno być uznawane za "wygasłe" i nie powinno być prezentowane odbiorcy. |
From |
Pobiera lub ustawia nadawcę wiadomości. |
HistoryDisclosed |
Pobiera lub ustawia wartość wskazującą, czy poprzednia historia kanału jest ujawniana. |
Id |
Pobiera lub ustawia identyfikator, który jednoznacznie identyfikuje działanie w kanale. |
Importance |
Pobiera lub ustawia znaczenie działania. Możliwe wartości są definiowane w ActivityImportance. |
InputHint |
Pobiera lub ustawia ciąg wskazujący, czy bot akceptuje, oczekuje lub ignoruje dane wejściowe użytkownika po dostarczeniu komunikatu do klienta (zobacz InputHints. |
Label |
Pobiera lub ustawia opisową etykietę działania. |
ListenFor |
Pobiera lub ustawia listę fraz i odwołań, na które powinny nasłuchiwać systemy mowy i języka priming. |
Locale |
Pobiera lub ustawia nazwę ustawień regionalnych BCP-47 dla zawartości pola tekstowego. |
LocalTimestamp |
Pobiera lub ustawia datę i godzinę wysłania wiadomości w czasie lokalnym wyrażoną w formacie ISO-8601. Na przykład 2016-09-23T13:07:49.4714686-07:00. |
LocalTimezone |
Pobiera lub ustawia nazwę strefy czasowej używanej do definiowania czasu lokalnego dla komunikatu wyrażonego w formacie bazy danych strefy czasowej IANA. Na przykład Ameryka/Los_Angeles. |
MembersAdded |
Pobiera lub ustawia kolekcję członków dodanych do konwersacji. |
MembersRemoved |
Pobiera lub ustawia kolekcję członków usuniętych z konwersacji. |
Name |
Pobiera lub ustawia nazwę operacji skojarzonej z działaniem wywołania lub zdarzenia. |
Properties |
Pobiera lub ustawia właściwości, które nie są w inny sposób zdefiniowane przez typ Activity, ale mogą być wyświetlane w serializowanym obiekcie REST JSON. |
ReactionsAdded |
Pobiera lub ustawia kolekcję reakcji dodanych do konwersacji. |
ReactionsRemoved |
Pobiera lub ustawia kolekcję reakcji usuniętych z konwersacji. |
Recipient |
Pobiera lub ustawia adresata wiadomości. |
RelatesTo |
Pobiera lub ustawia ConversationReference na inną konwersację lub działanie. |
ReplyToId |
Pobiera lub ustawia identyfikator wiadomości, do której ta wiadomość jest odpowiedzią. |
SemanticAction |
Pobiera lub ustawia opcjonalną akcję programową towarzyszących temu żądaniu. |
ServiceUrl |
Pobiera lub ustawia adres URL określający punkt końcowy usługi kanału. Ustaw według kanału. |
Speak |
Pobiera lub ustawia tekst do mówienia. |
SuggestedActions |
Pobiera lub ustawia sugerowane akcje dla działania. |
Summary |
Pobiera lub ustawia tekst do wyświetlenia, jeśli kanał nie może renderować kart. |
Text |
Pobiera lub ustawia zawartość tekstowa wiadomości. |
TextFormat |
Pobiera lub ustawia format pól tekstowych. Ustawienie domyślne: markdown. Możliwe wartości są definiowane przez TextFormatTypes. |
TextHighlights |
Pobiera lub ustawia kolekcję fragmentów tekstu w celu wyróżnienia, gdy działanie zawiera wartość ReplyToId. |
Timestamp |
Pobiera lub ustawia datę i godzinę wysłania komunikatu w formacie UTC wyrażonym w formacie ISO-8601. |
TopicName |
Pobiera lub ustawia zaktualizowaną nazwę tematu konwersacji. |
Type |
Pobiera lub ustawia typ działania. Możliwe wartości obejmują: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff". |
Value |
Pobiera lub ustawia wartość skojarzona z działaniem. |
ValueType |
Pobiera lub ustawia typ obiektu wartości działania. |
Metody
ApplyConversationReference(ConversationReference, Boolean) |
Aktualizuje to działanie przy użyciu informacji o dostarczaniu z istniejącego ConversationReference. |
AsCommandActivity() |
Zwraca to działanie jako obiekt ICommandActivity; lub null, jeśli nie jest to typ działania. |
AsCommandResultActivity() |
Zwraca to działanie jako obiekt ICommandResultActivity; lub null, jeśli nie jest to typ działania. |
AsContactRelationUpdateActivity() |
Zwraca to działanie jako obiekt IContactRelationUpdateActivity; lub null, jeśli nie jest to typ działania. |
AsConversationUpdateActivity() |
Zwraca to działanie jako obiekt IConversationUpdateActivity; lub null, jeśli nie jest to typ działania. |
AsEndOfConversationActivity() |
Zwraca to działanie jako obiekt IEndOfConversationActivity; lub null, jeśli nie jest to typ działania. |
AsEventActivity() |
Zwraca to działanie jako obiekt IEventActivity; lub null, jeśli nie jest to typ działania. |
AsHandoffActivity() |
Zwraca to działanie jako obiekt IHandoffActivity; lub null, jeśli nie jest to typ działania. |
AsInstallationUpdateActivity() |
Zwraca to działanie jako obiekt IInstallationUpdateActivity; lub null, jeśli nie jest to typ działania. |
AsInvokeActivity() |
Zwraca to działanie jako obiekt IInvokeActivity; lub null, jeśli nie jest to typ działania. |
AsMessageActivity() |
Zwraca to działanie jako obiekt IMessageActivity; lub null, jeśli nie jest to typ działania. |
AsMessageDeleteActivity() |
Zwraca to działanie jako obiekt IMessageDeleteActivity; lub null, jeśli nie jest to typ działania. |
AsMessageReactionActivity() |
Zwraca to działanie jako obiekt IMessageReactionActivity; lub null, jeśli nie jest to typ działania. |
AsMessageUpdateActivity() |
Zwraca to działanie jako obiekt IMessageUpdateActivity; lub null, jeśli nie jest to typ działania. |
AsSuggestionActivity() |
Zwraca to działanie jako obiekt ISuggestionActivity; lub null, jeśli nie jest to typ działania. |
AsTraceActivity() |
Zwraca to działanie jako obiekt ITraceActivity; lub null, jeśli nie jest to typ działania. |
AsTypingActivity() |
Zwraca to działanie jako obiekt ITypingActivity; lub null, jeśli nie jest to typ działania. |
CreateContactRelationUpdateActivity() |
Tworzy wystąpienie klasy Activity jako obiekt IContactRelationUpdateActivity. |
CreateConversationUpdateActivity() |
Tworzy wystąpienie klasy Activity jako obiekt IConversationUpdateActivity. |
CreateEndOfConversationActivity() |
Tworzy wystąpienie klasy Activity jako obiekt IEndOfConversationActivity. |
CreateEventActivity() |
Tworzy wystąpienie klasy Activity jako obiekt IEventActivity. |
CreateHandoffActivity() |
Tworzy wystąpienie klasy Activity jako obiekt IHandoffActivity. |
CreateInvokeActivity() |
Tworzy wystąpienie klasy Activity jako obiekt IInvokeActivity. |
CreateMessageActivity() |
Tworzy wystąpienie klasy Activity jako obiekt IMessageActivity. |
CreateReply(String, String) |
Tworzy nowe działanie komunikatu jako odpowiedź na to działanie. |
CreateTrace(String, Object, String, String) |
Tworzy nowe działanie śledzenia na podstawie tego działania. |
CreateTraceActivity(String, String, Object, String) |
Tworzy wystąpienie klasy Activity jako obiekt ITraceActivity. |
CreateTypingActivity() |
Tworzy wystąpienie klasy Activity jako obiekt ITypingActivity. |
GetChannelData<TypeT>() |
Pobiera dane kanału dla tego działania jako silnie typizowanego obiektu. |
GetConversationReference() |
Tworzy ConversationReference na podstawie tego działania. |
GetMentions() |
Usuwa wzmianki z jednostek tego działania. |
GetReplyConversationReference(ResourceResponse) |
Utwórz element ConversationReference na podstawie informacji o konwersacji tego działania i zasobuResponse z wysyłania działania. |
HasContent() |
Wskazuje, czy to działanie ma zawartość. |
IsActivity(String) |
Wskazuje, czy to działanie jest określonego typu działania. |
IsFromStreamingConnection() |
Ustal, czy działanie zostało wysłane za pośrednictwem połączenia HTTP/Https lub przesyłania strumieniowego. Można to określić, patrząc na właściwość ServiceUrl: (1) Wszystkie kanały wysyłające komunikaty za pośrednictwem protokołu http/https nie są przesyłane strumieniowo (2) kanały, które wysyłają komunikaty za pośrednictwem przesyłania strumieniowego, mają właściwość ServiceUrl, która nie zaczyna się od http/https. |
TryGetChannelData<TypeT>(TypeT) |
Pobiera dane kanału dla tego działania jako silnie typizowanego obiektu. Wartość zwracana wskazuje, czy operacja zakończyła się pomyślnie. |
Metody rozszerzania
TeamsGetChannelId(IActivity) |
Pobiera identyfikator kanału zespołu z bieżącego działania. |
TeamsGetMeetingInfo(IActivity) |
Pobiera obiekt TeamsMeetingInfo z bieżącego działania. |
TeamsGetSelectedChannelId(IActivity) |
Pobiera identyfikator wybranego kanału zespołu z bieżącego działania. |
TeamsGetTeamInfo(IActivity) |
Pobiera obiekt TeamsInfo z bieżącego działania. |
TeamsGetTeamOnBehalfOf(IActivity) |
Pobiera listę Aplikacji Teams OnBehalfOf z bieżącego działania. |
TeamsNotifyUser(IActivity, Boolean, String) |
Konfiguruje bieżące działanie w celu wygenerowania powiadomienia w usłudze Teams. |
TeamsNotifyUser(IActivity) |
Konfiguruje bieżące działanie w celu wygenerowania powiadomienia w usłudze Teams. |
MentionsId(IMessageActivity, String) |
Czy istnieje wzmianka o identyfikatorze we właściwości Text. |
MentionsRecipient(IMessageActivity) |
Czy istnieje wzmianka o Recipient.Id we właściwości Text. |
RemoveMentionText(IMessageActivity, String) |
Usuń dowolny tekst wzmianki dla danego identyfikatora z właściwości Activity.Text. Na przykład, biorąc pod uwagę komunikat @echoBot Hi Bot, spowoduje to usunięcie "@echoBot", pozostawiając "Hi Bot". |
RemoveRecipientMention(IMessageActivity) |
Usuń tekst wzmianki adresata z właściwości Text. Należy zachować ostrożność, ponieważ ta funkcja zmienia tekst działania. |
GetLocale(IActivity) |
Pobiera ustawienia regionalne dla działania. |
SetLocale(IActivity, String) |
Ustawia ustawienia regionalne dla działania. |