Activity Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
En aktivitet är den grundläggande kommunikationstypen för Bot Framework 3.0-protokollet.
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
- Arv
-
Activity
- Implementeringar
-
IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity
Kommentarer
Klassen Aktivitet innehåller alla egenskaper som enskilda, mer specifika aktiviteter kan innehålla. Det är en superuppsättningstyp.
Konstruktorer
Fält
ContentType |
HTTP-entitetsrubriken |
Egenskaper
Action |
Hämtar eller anger en sträng som anger om mottagaren av en contactRelationUpdate har lagts till i eller tagits bort från avsändarens kontaktlista. |
AttachmentLayout |
Hämtar eller anger layouttipset för flera bifogade filer. Standard: lista. Möjliga värden definieras av AttachmentLayoutTypes. |
Attachments |
Hämtar eller anger de bifogade filerna för aktiviteten. |
CallerId |
Hämtar eller anger en sträng som innehåller en IRI som identifierar anroparen för en robot. Det här fältet är inte avsett att överföras via kabeln, utan fylls i stället av robotar och klienter baserat på kryptografiskt verifierbara data som kontrollerar anroparnas identitet (t.ex. token). |
ChannelData |
Hämtar eller anger kanalspecifikt innehåll. |
ChannelId |
Hämtar eller anger ett ID som unikt identifierar kanalen. Anges av kanalen. |
Code |
Hämtar eller anger en kod för endOfConversation-aktiviteter som anger varför konversationen avslutades. Möjliga värden definieras i EndOfConversationCodes. |
Conversation |
Hämtar eller ställer in konversationen som aktiviteten tillhör. |
DeliveryMode |
Hämtar eller anger ett leveranstips för att signalera till mottagarens alternativa leveransvägar för aktiviteten. Standardleveransläget är "default". Möjliga värden definieras i DeliveryModes. |
Entities |
Hämtar eller anger de entiteter som nämndes i meddelandet. |
Expiration |
Hämtar eller anger den tid då aktiviteten ska anses vara "upphörd" och bör inte presenteras för mottagaren. |
From |
Hämtar eller anger meddelandets avsändare. |
HistoryDisclosed |
Hämtar eller anger ett värde som anger om kanalens tidigare historik avslöjas. |
Id |
Hämtar eller anger ett ID som unikt identifierar aktiviteten på kanalen. |
Importance |
Hämtar eller anger aktivitetens betydelse. Möjliga värden definieras i ActivityImportance. |
InputHint |
Hämtar eller anger en sträng som anger om roboten accepterar, förväntar sig eller ignorerar användarindata när meddelandet har levererats till klienten (se InputHints. |
Label |
Hämtar eller anger en beskrivande etikett för aktiviteten. |
ListenFor |
Hämtar eller anger en lista över fraser och referenser som tal- och språkprimeringssystem ska lyssna efter. |
Locale |
Hämtar eller anger ett BCP-47-språknamn för innehållet i textfältet. |
LocalTimestamp |
Hämtar eller anger datum och tid när meddelandet skickades, i lokal tid, uttryckt i ISO-8601-format. Till exempel 2016-09-23T13:07:49.4714686-07:00. |
LocalTimezone |
Hämtar eller anger namnet på tidszonen som används för att definiera lokal tid för meddelandet, uttryckt i databasformatet IANA-tidszon. Till exempel Amerika/Los_Angeles. |
MembersAdded |
Hämtar eller anger samlingen med medlemmar som läggs till i konversationen. |
MembersRemoved |
Hämtar eller ställer in samlingen med medlemmar som tagits bort från konversationen. |
Name |
Hämtar eller anger namnet på den åtgärd som är associerad med en anrops- eller händelseaktivitet. |
Properties |
Hämtar eller anger egenskaper som inte definieras av Activity typen på något annat sätt, men som kan visas i det serialiserade REST JSON-objektet. |
ReactionsAdded |
Hämtar eller anger samlingen av reaktioner som lagts till i konversationen. |
ReactionsRemoved |
Hämtar eller anger samlingen av reaktioner som tagits bort från konversationen. |
Recipient |
Hämtar eller anger mottagaren av meddelandet. |
RelatesTo |
Hämtar eller anger en till en ConversationReference annan konversation eller aktivitet. |
ReplyToId |
Hämtar eller anger ID för det meddelande som meddelandet är ett svar på. |
SemanticAction |
Hämtar eller anger en valfri programmässig åtgärd som medföljer denna begäran. |
ServiceUrl |
Hämtar eller anger den URL som anger kanalens tjänstslutpunkt. Anges av kanalen. |
Speak |
Hämtar eller ställer in texten så att den talar. |
SuggestedActions |
Hämtar eller anger föreslagna åtgärder för aktiviteten. |
Summary |
Hämtar eller ställer in texten så att den visas om kanalen inte kan återge kort. |
Text |
Hämtar eller anger textinnehållet i meddelandet. |
TextFormat |
Hämtar eller anger formatet för textfält. Standard: markdown. Möjliga värden definieras av TextFormatTypes. |
TextHighlights |
Hämtar eller anger den samling textfragment som ska markeras när aktiviteten innehåller ett ReplyToId-värde. |
Timestamp |
Hämtar eller anger datum och tid när meddelandet skickades i UTC-format uttryckt i ISO-8601-format. |
TopicName |
Hämtar eller anger det uppdaterade ämnesnamnet för konversationen. |
Type |
Hämtar eller anger aktivitetstypen. Möjliga värden är: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'. |
Value |
Hämtar eller anger ett värde som är associerat med aktiviteten. |
ValueType |
Hämtar eller anger typen av aktivitetens värdeobjekt. |
Metoder
ApplyConversationReference(ConversationReference, Boolean) |
Uppdateringar den här aktiviteten med leveransinformationen från en befintlig ConversationReference. |
AsCommandActivity() |
Returnerar den här aktiviteten som ett ICommandActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsCommandResultActivity() |
Returnerar den här aktiviteten som ett ICommandResultActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsContactRelationUpdateActivity() |
Returnerar den här aktiviteten som ett IContactRelationUpdateActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsConversationUpdateActivity() |
Returnerar den här aktiviteten som ett IConversationUpdateActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsEndOfConversationActivity() |
Returnerar den här aktiviteten som ett IEndOfConversationActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsEventActivity() |
Returnerar den här aktiviteten som ett IEventActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsHandoffActivity() |
Returnerar den här aktiviteten som ett IHandoffActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsInstallationUpdateActivity() |
Returnerar den här aktiviteten som ett IInstallationUpdateActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsInvokeActivity() |
Returnerar den här aktiviteten som ett IInvokeActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsMessageActivity() |
Returnerar den här aktiviteten som ett IMessageActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsMessageDeleteActivity() |
Returnerar den här aktiviteten som ett IMessageDeleteActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsMessageReactionActivity() |
Returnerar den här aktiviteten som ett IMessageReactionActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsMessageUpdateActivity() |
Returnerar den här aktiviteten som ett IMessageUpdateActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsSuggestionActivity() |
Returnerar den här aktiviteten som ett ISuggestionActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsTraceActivity() |
Returnerar den här aktiviteten som ett ITraceActivity objekt, eller null, om det inte är den typen av aktivitet. |
AsTypingActivity() |
Returnerar den här aktiviteten som ett ITypingActivity objekt, eller null, om det inte är den typen av aktivitet. |
CreateContactRelationUpdateActivity() |
Skapar en instans av Activity klassen som ett IContactRelationUpdateActivity -objekt. |
CreateConversationUpdateActivity() |
Skapar en instans av Activity klassen som ett IConversationUpdateActivity -objekt. |
CreateEndOfConversationActivity() |
Skapar en instans av Activity klassen som ett IEndOfConversationActivity -objekt. |
CreateEventActivity() |
Skapar en instans av Activity klassen som ett IEventActivity -objekt. |
CreateHandoffActivity() |
Skapar en instans av Activity klassen som ett IHandoffActivity -objekt. |
CreateInvokeActivity() |
Skapar en instans av Activity klassen som ett IInvokeActivity -objekt. |
CreateMessageActivity() |
Skapar en instans av Activity klassen som ett IMessageActivity -objekt. |
CreateReply(String, String) |
Skapar en ny meddelandeaktivitet som ett svar på den här aktiviteten. |
CreateTrace(String, Object, String, String) |
Skapar en ny spårningsaktivitet baserat på den här aktiviteten. |
CreateTraceActivity(String, String, Object, String) |
Skapar en instans av Activity klassen som ett ITraceActivity -objekt. |
CreateTypingActivity() |
Skapar en instans av Activity klassen som ett ITypingActivity -objekt. |
GetChannelData<TypeT>() |
Hämtar kanaldata för den här aktiviteten som ett starkt typifierat objekt. |
GetConversationReference() |
Skapar en ConversationReference baserat på den här aktiviteten. |
GetMentions() |
Löser omnämnanden från entiteterna för den här aktiviteten. |
GetReplyConversationReference(ResourceResponse) |
Skapa en ConversationReference baserat på den här aktivitetens konversationsinformation och ResourceResponse från att skicka en aktivitet. |
HasContent() |
Anger om den här aktiviteten har innehåll. |
IsActivity(String) |
Anger om den här aktiviteten är av en angiven aktivitetstyp. |
IsFromStreamingConnection() |
Fastställ om aktiviteten skickades via en Http/Https-anslutning eller strömning Detta kan fastställas genom att titta på egenskapen ServiceUrl: (1) Alla kanaler som skickar meddelanden via http/https strömmar inte (2) Kanaler som skickar meddelanden via strömning har en ServiceUrl som inte börjar med http/https. |
TryGetChannelData<TypeT>(TypeT) |
Hämtar kanaldata för den här aktiviteten som ett starkt typifierat objekt. Ett returvärde anger om åtgärden lyckades. |
Tilläggsmetoder
TeamsGetChannelId(IActivity) |
Hämtar teamets kanal-ID från den aktuella aktiviteten. |
TeamsGetMeetingInfo(IActivity) |
Hämtar TeamsMeetingInfo-objektet från den aktuella aktiviteten. |
TeamsGetSelectedChannelId(IActivity) |
Hämtar teamets valda kanal-ID från den aktuella aktiviteten. |
TeamsGetTeamInfo(IActivity) |
Hämtar TeamsInfo-objektet från den aktuella aktiviteten. |
TeamsNotifyUser(IActivity) |
Konfigurerar den aktuella aktiviteten för att generera ett meddelande i Teams. |
TeamsNotifyUser(IActivity, Boolean, String) |
Konfigurerar den aktuella aktiviteten för att generera ett meddelande i Teams. |
MentionsId(IMessageActivity, String) |
Finns det ett omnämnande av ID i textegenskapen. |
MentionsRecipient(IMessageActivity) |
Finns det ett omnämnande av Recipient.Id i textegenskapen. |
RemoveMentionText(IMessageActivity, String) |
Ta bort eventuell omnämnandetext för angivet ID från egenskapen Activity.Text. Med meddelandet @echoBot Hi Bot tar det till exempel bort "@echoBot" och lämnar "Hi Bot". |
RemoveRecipientMention(IMessageActivity) |
Ta bort mottagarens omnämnandetext från egenskapen Text. Använd med försiktighet eftersom den här funktionen ändrar texten i aktiviteten. |
GetLocale(IActivity) |
Hämtar nationella inställningar för aktiviteten. |
SetLocale(IActivity, String) |
Anger nationella inställningar för aktiviteten. |