IMessageActivity 介面
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
交談中的訊息。
public interface IMessageActivity : Microsoft.Bot.Schema.IActivity
type IMessageActivity = interface
interface IActivity
Public Interface IMessageActivity
Implements IActivity
- 衍生
- 實作
屬性
AttachmentLayout |
取得或設定如何處理多個附件的提示:[list|carousel] Default:list。 |
Attachments |
取得或設定附件。 |
ChannelData |
取得或設定通道特定的承載。 (繼承來源 IActivity) |
ChannelId |
取得或設定與此活動相關聯的通道。 (繼承來源 IActivity) |
Conversation |
取得或設定與這個活動相關聯之交談的 Address。 (繼承來源 IActivity) |
DeliveryMode |
取得或設定提示,描述應如何傳遞此活動。 null 或 “default” = 預設傳遞 “notification” = 通知語意請參閱目前常數的 DeliveryModes。 |
Entities |
取得或設定 Entity 物件的集合,每個物件都包含有關此活動的元數據。 每個 Entity 對象都會輸入。 (繼承來源 IActivity) |
Expiration |
取得或設定 dateTime,讓活動過期為 ISO 8601 編碼的日期時間。 |
From |
取得或設定寄件者位址。 (繼承來源 IActivity) |
Id |
取得或設定活動的標識碼。 (繼承來源 IActivity) |
Importance |
取得或設定活動的重要性 有效值為 「low」、」normal“ 和 「high」。 默認值為 「normal.」。 |
InputHint |
取得或設定指出 Bot 是否接受、預期或忽略輸入。 |
Locale |
取得或設定 Text 欄位的語言代碼。 |
LocalTimestamp |
取得或設定訊息的本機日期和時間,以 ISO-8601 格式表示。 例如,2016-09-23T13:07:49.4714686-07:00。 (繼承來源 IActivity) |
Recipient |
取得或設定接收訊息的位址。 (繼承來源 IActivity) |
ReplyToId |
取得或設定此活動為回應的原始標識碼。 (繼承來源 IActivity) |
ServiceUrl |
取得或設定應該傳送此活動回應的服務 URL。 (繼承來源 IActivity) |
Speak |
取得或設定語音轉換文字的 SSML 標記。 |
SuggestedActions |
取得或設定 suggestedActions 可用來表示與鍵盤/quickReplies 等卡片互動的動作。 |
Summary |
取得或設定通道無法轉譯卡片時顯示的文字。 |
Text |
取得或設定訊息的內容。 |
TextFormat |
取得或設定文字欄位的格式 [plain|markdown] Default:markdown。 |
Timestamp |
取得或設定傳送此訊息時的時間戳(UTC)。 (繼承來源 IActivity) |
Type |
取得或設定活動類型。 (繼承來源 IActivity) |
Value |
取得或設定 CardAction 所提供的值。 |
方法
ApplyConversationReference(ConversationReference, Boolean) |
使用來自現有交談參考的傳遞資訊來更新活動。 (繼承來源 IActivity) |
AsContactRelationUpdateActivity() |
如果這是 contactRelationUpdate 活動,則傳回 IContactRelationUpdateActivity,否則傳回 null。 (繼承來源 IActivity) |
AsConversationUpdateActivity() |
如果這是 conversationUpdate 活動,則傳回 IConversationUpdateActivity,否則傳回 Null。 (繼承來源 IActivity) |
AsEndOfConversationActivity() |
如果這是對話結束活動,則傳回 IEndOfConversationActivity,否則傳回 null。 (繼承來源 IActivity) |
AsEventActivity() |
如果這是事件活動,則傳回 IEventActivity,否則傳回 null。 (繼承來源 IActivity) |
AsInstallationUpdateActivity() |
如果這是 installationUpdate 活動,則傳回 IInstallationUpdateActivity,否則傳回 Null。 (繼承來源 IActivity) |
AsInvokeActivity() |
如果這是叫用活動,則傳回 IInvokeActivity,否則傳回 null。 (繼承來源 IActivity) |
AsMessageActivity() |
如果這是訊息活動,則傳回 IMessageActivity,否則傳回 null。 (繼承來源 IActivity) |
AsMessageDeleteActivity() |
如果這是訊息刪除活動,則傳回 IMessageDeleteActivity,否則傳回 null。 (繼承來源 IActivity) |
AsMessageReactionActivity() |
如果這是訊息反應活動,則傳回 IMessageDeleteActivity,否則傳回 null。 (繼承來源 IActivity) |
AsMessageUpdateActivity() |
如果這是訊息更新活動,則傳回 IMessageUpdateActivity,否則傳回 null。 (繼承來源 IActivity) |
AsSuggestionActivity() |
如果這是建議活動,則傳回 IMessageDeleteActivity,否則傳回 null。 (繼承來源 IActivity) |
AsTypingActivity() |
如果這是輸入活動,則傳回 ITypingActivity,否則傳回 null。 (繼承來源 IActivity) |
GetChannelData<TypeT>() |
取得通道數據做為強型別物件。 (繼承來源 IActivity) |
GetConversationReference() |
從活動取得交談參考。 (繼承來源 IActivity) |
GetMentions() |
取得提及。 |
HasContent() |
如果此活動具有文字、附件或 channelData,則為 True。 |
TryGetChannelData<TypeT>(TypeT) |
嘗試取得 channeldata 做為強型別物件。 (繼承來源 IActivity) |
擴充方法
TeamsGetChannelId(IActivity) |
從目前活動取得Team的頻道標識碼。 |
TeamsGetMeetingInfo(IActivity) |
從目前活動取得TeamsMeetingInfo物件。 |
TeamsGetSelectedChannelId(IActivity) |
從目前活動取得小組選取的頻道標識碼。 |
TeamsGetTeamInfo(IActivity) |
從目前活動取得TeamsInfo物件。 |
TeamsGetTeamOnBehalfOf(IActivity) |
從目前活動取得Teams OnBehalfOf清單。 |
TeamsNotifyUser(IActivity, Boolean, String) |
設定目前的活動以在Teams內產生通知。 |
TeamsNotifyUser(IActivity) |
設定目前的活動以在Teams內產生通知。 |
MentionsId(IMessageActivity, String) |
Text 屬性中是否有標識碼的提及。 |
MentionsRecipient(IMessageActivity) |
Text 屬性中是否有提及 Recipient.Id。 |
RemoveMentionText(IMessageActivity, String) |
從 Activity.Text 屬性中移除指定識別碼的任何提及文字。 例如,假設訊息 @echoBot Hi Bot,這會移除 「@echoBot」,並保留 「Hi Bot」。 |
RemoveRecipientMention(IMessageActivity) |
從 Text 屬性移除收件者提及文字。 請小心使用,因為此函式正在改變活動上的文字。 |
GetLocale(IActivity) |
取得活動的地區設定。 |
SetLocale(IActivity, String) |
設定活動的地區設定。 |