Activity 類別
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
活動是 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.ITypingActivitytype 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 ICommandResultActivityPublic Class Activity
Implements ICommandActivity, ICommandResultActivity, IContactRelationUpdateActivity, IConversationUpdateActivity, IEndOfConversationActivity, IEventActivity, IHandoffActivity, IInstallationUpdateActivity, IInvokeActivity, IMessageDeleteActivity, IMessageReactionActivity, IMessageUpdateActivity, ISuggestionActivity, ITraceActivity, ITypingActivity- 繼承
-
Activity
- 實作
-
IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity
備註
Activity 類別包含個別、更特定活動可包含的所有屬性。 它是超集類型。
建構函式
欄位
| 名稱 | Description |
|---|---|
| ContentType |
HTTP |
屬性
| 名稱 | Description |
|---|---|
| Action |
取得或設定字串，指出是否已將 contactRelationUpdate 的收件者新增至寄件人的聯繫人清單或從清單中移除。 |
| AttachmentLayout |
取得或設定多個附件的配置提示。 預設值：清單。 可能的值由 定義 AttachmentLayoutTypes。 |
| Attachments |
取得或設定活動的附件。 |
| CallerId |
取得或設定字串，其中包含識別 Bot 呼叫端的 IRI。 此欄位並非要透過網路傳輸，而是由 Bot 和用戶端根據可密碼編譯驗證的數據填入，該數據會判斷呼叫端的身分識別（例如令牌）。 |
| ChannelData |
取得或設定通道特定內容。 |
| ChannelId |
取得或設定可唯一識別通道的標識碼。 由通道設定。 |
| Code |
取得或設定 endOfConversation 活動的程式代碼，指出對話結束的原因。 可能的值定義於 EndOfConversationCodes。 |
| Conversation |
取得或設定活動所屬的交談。 |
| DeliveryMode |
取得或設定傳遞提示，以向活動的收件者替代傳遞路徑發出訊號。 默認傳遞模式為 「default」。。 可能的值定義於 DeliveryModes。 |
| Entities |
取得或設定訊息中所提及的實體。 |
| Expiration |
取得或設定活動應該視為「已過期」的時間，且不應呈現給收件者。 |
| From |
取得或設定訊息的寄件者。 |
| HistoryDisclosed |
取得或設定值，指出通道的先前歷程記錄是否公開。 |
| Id |
取得或設定可唯一識別通道上活動的標識碼。 |
| Importance |
取得或設定活動的重要性。 可能的值定義於 ActivityImportance。 |
| InputHint |
會接收或設定一個字串，指示你的機器人在訊息送達客戶端後，是否接受、期待或忽略使用者輸入（參見 InputHints。 |
| Label |
取得或設定活動的描述性標籤。 |
| ListenFor |
取得或設定語音和語言準備系統應該接聽的片語和參考清單。 |
| Locale |
取得或設定文字欄位內容的BCP-47地區設定名稱。 |
| LocalTimestamp |
取得或設定傳送訊息的日期和時間，以 ISO-8601 格式表示。 例如，2016-09-23T13：07：49.4714686-07：00。 |
| LocalTimezone |
取得或設定用來定義訊息當地時間的時區名稱，以 IANA 時區資料庫格式表示。 例如，美國/Los_Angeles。 |
| MembersAdded |
取得或設定加入至交談的成員集合。 |
| MembersRemoved |
取得或設定從交談中移除的成員集合。 |
| Name |
取得或設定與叫用或事件活動相關聯的作業名稱。 |
| Properties |
取得或設定那些類型未 Activity 定義但可能出現在序列化 REST JSON 物件中的屬性。 |
| ReactionsAdded |
取得或設定加入至交談的反應集合。 |
| ReactionsRemoved |
取得或設定從交談中移除之回應的集合。 |
| Recipient |
取得或設定郵件的收件者。 |
| RelatesTo |
接到或設定 ConversationReference 另一個對話或活動。 |
| ReplyToId |
取得或設定這個訊息為回復之訊息的標識碼。 |
| SemanticAction |
取得或設定此要求隨附的選擇性程序設計動作。 |
| ServiceUrl |
取得或設定指定通道服務端點的 URL。 由通道設定。 |
| Speak |
取得或設定要說出的文字。 |
| SuggestedActions |
取得或設定活動的建議動作。 |
| Summary |
取得或設定通道無法轉譯卡片時要顯示的文字。 |
| Text |
取得或設定訊息的文字內容。 |
| TextFormat |
取得或設定文字欄位的格式。 默認值：Markdown。 可能的值由 定義 TextFormatTypes。 |
| TextHighlights |
取得或設定活動包含 ReplyToId 值時要反白顯示的文字片段集合。 |
| Timestamp |
取得或設定以 ISO-8601 格式表示訊息的日期和時間。 |
| TopicName |
取得或設定交談的更新主題名稱。 |
| Type |
取得或設定活動類型。 可能的值包括：'message'、'contactRelationUpdate'、'conversationUpdate'、'typing'、'endOfConversation'、'event'、'invoke'、'deleteUserData'、'messageUpdate'、'messageDelete'、'installationUpdate'、'messageReaction'、'suggestion'、'trace'、'handoff'。 |
| Value |
取得或設定與活動相關聯的值。 |
| ValueType |
取得或設定活動值物件的型別。 |
方法
擴充方法
| 名稱 | Description |
|---|---|
| GetLocale(IActivity) |
取得活動的地區設定。 |
| MentionsId(IMessageActivity, String) |
Text 屬性中是否有標識碼的提及。 |
| MentionsRecipient(IMessageActivity) |
Text 屬性中是否有提及 Recipient.Id。 |
| RemoveMentionText(IMessageActivity, String) |
從 Activity.Text 屬性中移除指定識別碼的任何提及文字。 例如，當訊息顯示 @echoBot Hi Bot 時，這會移除「@echoBot」，只留下「Hi Bot」。 |
| RemoveRecipientMention(IMessageActivity) |
從 Text 屬性移除收件者提及文字。 請小心使用，因為此函式正在改變活動上的文字。 |
| SetLocale(IActivity, String) |
設定活動的地區設定。 |
| TeamsGetChannelId(IActivity) |
從目前活動取得Team的頻道標識碼。 |
| TeamsGetMeetingInfo(IActivity) |
從目前活動取得TeamsMeetingInfo物件。 |
| TeamsGetSelectedChannelId(IActivity) |
從目前活動取得小組選取的頻道標識碼。 |
| TeamsGetTeamInfo(IActivity) |
從目前活動取得TeamsInfo物件。 |
| TeamsGetTeamOnBehalfOf(IActivity) |
從目前活動取得Teams OnBehalfOf清單。 |
| TeamsNotifyUser(IActivity, Boolean, String) |
設定目前的活動以在Teams內產生通知。 |
| TeamsNotifyUser(IActivity) |
設定目前的活動以在Teams內產生通知。 |