Jazyk

Activity Třída

Definice

Aktivita je základní typ komunikace pro protokol 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
Dědičnost
Activity
Implementuje

Poznámky

Třída Activity obsahuje všechny vlastnosti, které mohou obsahovat jednotlivé, konkrétnější aktivity. Je to typ nadmnožina.

Konstruktory

Name Description
Activity()

Inicializuje novou instanci Activity třídy.

Activity(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, ChannelAccount, ConversationAccount, ChannelAccount, String, String, IList<ChannelAccount>, IList<ChannelAccount>, IList<MessageReaction>, IList<MessageReaction>, String, Nullable<Boolean>, String, String, String, String, String, SuggestedActions, IList<Attachment>, IList<Entity>, Object, String, String, String, String, Object, String, ConversationReference, String, Nullable<DateTimeOffset>, String, String, IList<String>, IList<TextHighlight>, SemanticAction, String)

Inicializuje novou instanci Activity třídy.

Pole

Name Description
ContentType

HTTP entity hlavička Content-Type , která identifikuje Activity zdroj typu média.

Vlastnosti

Name Description
Action

Získá nebo nastaví řetězec určující, zda příjemce contactRelationUpdate byl přidán nebo odebrán ze seznamu kontaktů odesílatele.

AttachmentLayout

Získá nebo nastaví nápovědu rozložení pro více příloh. Výchozí: seznam. Možné hodnoty jsou definovány jako AttachmentLayoutTypes.

Attachments

Získá nebo nastaví přílohy pro aktivitu.

CallerId

Získá nebo nastaví řetězec obsahující IRI identifikující volajícího robota. Toto pole není určeno k přenosu přes drát, ale místo toho je naplněno roboty a klienty na základě kryptograficky ověřitelných dat, která uplatňují identitu volajících (např. tokenů).

ChannelData

Získá nebo nastaví obsah specifický pro kanál.

ChannelId

Získá nebo nastaví ID, které jednoznačně identifikuje kanál. Nastavte kanál.

Code

Získá nebo nastaví kód pro aktivity endOfConversation, které označují, proč konverzace skončila. Možné hodnoty jsou definovány v EndOfConversationCodes.

Conversation

Získá nebo nastaví konverzaci, do které aktivita patří.

DeliveryMode

Získá nebo nastaví nápovědu k doručení signálu pro alternativní cesty doručení příjemce pro aktivitu. Výchozí režim doručování je "výchozí". Možné hodnoty jsou definovány v DeliveryModes.

Entities

Získá nebo nastaví entity, které byly zmíněny ve zprávě.

Expiration

Získá nebo nastaví čas, kdy má být aktivita považována za "vypršela", a neměla by být předložena příjemci.

From

Získá nebo nastaví odesílatele zprávy.

HistoryDisclosed

Získá nebo nastaví hodnotu určující, zda předchozí historie kanálu je zpřístupněna.

Id

Získá nebo nastaví ID, které jednoznačně identifikuje aktivitu v kanálu.

Importance

Získá nebo nastaví důležitost aktivity. Možné hodnoty jsou definovány v ActivityImportance.

InputHint

Získá nebo nastaví řetězec indikující, zda váš bot přijímá, očekává nebo ignoruje uživatelský vstup poté, co je zpráva doručena klientovi (viz InputHints.

Label

Získá nebo nastaví popisný popisek aktivity.

ListenFor

Získá nebo nastaví seznam frází a odkazů, které řeč a jazykové systémy by měly naslouchat.

Locale

Získá nebo nastaví název národního prostředí BCP-47 pro obsah textového pole.

LocalTimestamp

Získá nebo nastaví datum a čas odeslání zprávy v místním čase vyjádřený ve formátu ISO-8601. Například 2016-09-23T13:07:49.4714686-07:00.

LocalTimezone

Získá nebo nastaví název časového pásma použitého k definování místního času pro zprávu vyjádřený ve formátu databáze IANA Time Zone. Například Amerika/Los_Angeles.

MembersAdded

Získá nebo nastaví kolekci členů přidaných do konverzace.

MembersRemoved

Získá nebo nastaví kolekci členů odebraných z konverzace.

Name

Získá nebo nastaví název operace přidružené k vyvolání nebo události aktivity.

Properties

Získá nebo nastaví vlastnosti, které nejsou jinak definovány typem Activity , ale mohou se objevit v serializovaném objektu REST JSON.

ReactionsAdded

Získá nebo nastaví kolekci reakcí přidaných do konverzace.

ReactionsRemoved

Získá nebo nastaví kolekci reakcí odebraných z konverzace.

Recipient

Získá nebo nastaví příjemce zprávy.

RelatesTo

Přijímá nebo nastavuje další ConversationReference konverzaci nebo aktivitu.

ReplyToId

Získá nebo nastaví ID zprávy, na kterou je tato zpráva odpovědí.

SemanticAction

Získá nebo nastaví volitelnou programovou akci, která tento požadavek doprovází.

ServiceUrl

Získá nebo nastaví adresu URL, která určuje koncový bod služby kanálu. Nastavte kanál.

Speak

Získá nebo nastaví text, který má mluvit.

SuggestedActions

Získá nebo nastaví navrhované akce pro aktivitu.

Summary

Získá nebo nastaví text, který se má zobrazit, pokud kanál nemůže vykreslit karty.

Text

Získá nebo nastaví textový obsah zprávy.

TextFormat

Získá nebo nastaví formát textových polí. Výchozí hodnota: markdown. Možné hodnoty jsou definovány jako TextFormatTypes.

TextHighlights

Získá nebo nastaví kolekci fragmentů textu, které se zvýrazní, když aktivita obsahuje hodnotu ReplyToId.

Timestamp

Získá nebo nastaví datum a čas odeslání zprávy ve formátu UTC vyjádřený ve formátu ISO-8601.

TopicName

Získá nebo nastaví aktualizovaný název tématu konverzace.

Type

Získá nebo nastaví typ aktivity. Mezi možné hodnoty patří: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'.

Value

Získá nebo nastaví hodnotu, která je přidružena k aktivitě.

ValueType

Získá nebo nastaví typ objektu hodnoty aktivity.

Metody

Name Description
ApplyConversationReference(ConversationReference, Boolean)

Aktualizuje tuto aktivitu o informace o doručení z existujícího ConversationReference.

AsCommandActivity()

Vrací tuto aktivitu ICommandActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsCommandResultActivity()

Vrací tuto aktivitu ICommandResultActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsContactRelationUpdateActivity()

Vrací tuto aktivitu IContactRelationUpdateActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsConversationUpdateActivity()

Vrací tuto aktivitu IConversationUpdateActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsEndOfConversationActivity()

Vrací tuto aktivitu IEndOfConversationActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsEventActivity()

Vrací tuto aktivitu IEventActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsHandoffActivity()

Vrací tuto aktivitu IHandoffActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsInstallationUpdateActivity()

Vrací tuto aktivitu IInstallationUpdateActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsInvokeActivity()

Vrací tuto aktivitu IInvokeActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsMessageActivity()

Vrací tuto aktivitu IMessageActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsMessageDeleteActivity()

Vrací tuto aktivitu IMessageDeleteActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsMessageReactionActivity()

Vrací tuto aktivitu IMessageReactionActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsMessageUpdateActivity()

Vrací tuto aktivitu IMessageUpdateActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsSuggestionActivity()

Vrací tuto aktivitu ISuggestionActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsTraceActivity()

Vrací tuto aktivitu ITraceActivity jako objekt; nebo null, pokud to není tento typ aktivity.

AsTypingActivity()

Vrací tuto aktivitu ITypingActivity jako objekt; nebo null, pokud to není tento typ aktivity.

CreateContactRelationUpdateActivity()

Vytvoří instanci třídy Activity jako IContactRelationUpdateActivity objektu.

CreateConversationUpdateActivity()

Vytvoří instanci třídy Activity jako IConversationUpdateActivity objektu.

CreateEndOfConversationActivity()

Vytvoří instanci třídy Activity jako IEndOfConversationActivity objektu.

CreateEventActivity()

Vytvoří instanci třídy Activity jako IEventActivity objektu.

CreateHandoffActivity()

Vytvoří instanci třídy Activity jako IHandoffActivity objektu.

CreateInvokeActivity()

Vytvoří instanci třídy Activity jako IInvokeActivity objektu.

CreateMessageActivity()

Vytvoří instanci třídy Activity jako IMessageActivity objektu.

CreateReply(String, String)

Vytvoří novou aktivitu zpráv jako odpověď na tuto aktivitu.

CreateTrace(String, Object, String, String)

Vytvoří novou aktivitu trasování na základě této aktivity.

CreateTraceActivity(String, String, Object, String)

Vytvoří instanci třídy Activity jako ITraceActivity objektu.

CreateTypingActivity()

Vytvoří instanci třídy Activity jako ITypingActivity objektu.

GetChannelData<TypeT>()

Získá data kanálu pro tuto aktivitu jako objekt silného typu.

GetConversationReference()

Vytváří na základě této aktivity ConversationReference .

GetMentions()

Vyřeší zmínky z entit této aktivity.

GetReplyConversationReference(ResourceResponse)

Vytvořte Konverzačníreference na základě informací o konverzaci této aktivity a resourceResponse od odeslání aktivity.

HasContent()

Určuje, jestli má tato aktivita obsah.

IsActivity(String)

Určuje, zda je tato aktivita typu zadané aktivity.

IsFromStreamingConnection()

Zjistěte, jestli byla aktivita odeslána prostřednictvím připojení Http/Https nebo Streamování. To lze určit pomocí vlastnosti ServiceUrl: (1) Všechny kanály, které odesílají zprávy přes http/https, nejsou streamované (2) Kanály, které odesílají zprávy přes streamování, mají serviceUrl, který nezačíná protokolem http/https.

TryGetChannelData<TypeT>(TypeT)

Získá data kanálu pro tuto aktivitu jako objekt silného typu. Vrácená hodnota určuje, jestli operace proběhla úspěšně.

Metody rozšíření

Name Description
GetLocale(IActivity)

Získá národní prostředí pro aktivitu.

MentionsId(IMessageActivity, String)

Je zde zmínka o ID v textové vlastnosti.

MentionsRecipient(IMessageActivity)

Je zde zmínka o Recipient.Id v textové vlastnosti.

RemoveMentionText(IMessageActivity, String)

Odeberte z vlastnosti Activity.Text veškerý text zmínky pro dané ID. Například vzhledem ke zprávě @echoBot Hi Bot se odstraní "@echoBot", takže zůstane "Hi Bot".

RemoveRecipientMention(IMessageActivity)

Odeberte text zmínky příjemce z vlastnosti Text. Používejte s opatrností, protože tato funkce mění text aktivity.

SetLocale(IActivity, String)

Nastaví národní prostředí pro aktivitu.

TeamsGetChannelId(IActivity)

Získá ID kanálu týmu z aktuální aktivity.

TeamsGetMeetingInfo(IActivity)

Získá TeamsMeetingInfo objekt z aktuální aktivity.

TeamsGetSelectedChannelId(IActivity)

Získá ID vybraného kanálu týmu z aktuální aktivity.

TeamsGetTeamInfo(IActivity)

Získá TeamsInfo objekt z aktuální aktivity.

TeamsGetTeamOnBehalfOf(IActivity)

Získá Teams OnBehalfOf seznam z aktuální aktivity.

TeamsNotifyUser(IActivity, Boolean, String)

Nakonfiguruje aktuální aktivitu tak, aby vygenerovala oznámení v teams.

TeamsNotifyUser(IActivity)

Nakonfiguruje aktuální aktivitu tak, aby vygenerovala oznámení v teams.

Platí pro