Activity 類別

protected Activity()

默認建構函式。 一般而言，這不會作為通常必要的 ActivityType 使用。

public Activity(String withType)

建構指定型別的活動。

參數:

public TypeT getChannelData(Class classType)

取得 channelData 做為具類型的結構。

參數:

傳回:

擲回:

public ResultPair tryGetChannelData(Class clsType)

取得 channelData 做為具類型的結構。

參數:

傳回:

public final Activity applyConversationReference(ConversationReference reference)

使用來自現有 ConversationReference的傳出傳遞資訊來更新此活動。

參數:

傳回:

public final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

使用現有 ConversationReference的傳遞資訊更新此活動。 在傳入活動上呼叫 #getConversationReference，以取得交談參考，您接著可以使用正確的傳遞資訊來更新傳出活動。

參數:

傳回:

public static Activity clone(Activity activity)

複製活動。

參數:

傳回:

public static Activity createContactRelationUpdateActivity()

建立CONTACT_RELATION_UPDATE類型Activity。

傳回:

public static Activity createConversationUpdateActivity()

建立CONVERSATION_UPDATE類型 Activity。

傳回:

public static Activity createEndOfConversationActivity()

建立活動END_OF_CONVERSATION類型。

傳回:

public static Activity createEventActivity()

建立 Activity 的 EVENT 類型。

傳回:

public static Activity createHandoffActivity()

建立 HANDOFF 類型活動。

傳回:

public static Activity createInvokeActivity()

建立 Activity 的 INVOKE 類型。

傳回:

public static Activity createMessageActivity()

建立 MESSAGE 類型活動。

傳回:

public Activity createReply()

建立新的訊息活動作為此活動的回應。

傳回:

public Activity createReply(String withText)

建立新的訊息活動作為此活動的回應。 此多載會使用此活動的地區設定。

參數:

傳回:

public Activity createReply(String withText, String withLocale)

建立新的訊息活動作為此活動的回應。

參數:

傳回:

public Activity createTrace(String withName)

建立 Activity 類別的實體做為 類型 TRACE。

參數:

傳回:

public Activity createTrace(String withName, Object withValue, String withValueType, String withLabel)

建立 Activity 類別的實體做為 類型 TRACE。

參數:

傳回:

public static Activity createTraceActivity(String withName)

建立 TRACE 類型活動。

參數:

傳回:

public static Activity createTraceActivity(String withName, String withValueType, Object withValue, String withLabel)

建立 TRACE 類型活動。

參數:

傳回:

public static Activity createTypingActivity()

建立 TYPE 類型活動。

傳回:

public String getAction()

指出是否已從寄件人的聯繫人清單中新增或移除 contactRelationUpdate 的收件者。

傳回:

public AttachmentLayoutTypes getAttachmentLayout()

多個附件的配置提示。

傳回:

public List getAttachments()

取得活動的附件。

傳回:

public String getCallerId()

取得字串，其中包含識別 Bot 呼叫端的 IRI。 此欄位並非要透過網路傳輸，而是由 Bot 和用戶端根據可密碼編譯驗證的數據填入，該數據會判斷呼叫端的身分識別（例如令牌）。

傳回:

public Object getChannelData()

取得通道特定內容。

傳回:

public String getChannelId()

取得可唯一識別通道的標識碼。 由通道設定。

傳回:

public EndOfConversationCodes getCode()

取得 endOfConversation 活動的程式代碼，指出對話結束的原因。

傳回:

public ConversationAccount getConversation()

識別活動所屬的交談。

傳回:

public ConversationReference getConversationReference()

根據此活動建立 ConversationReference。

傳回:

public String getDeliveryMode()

傳送提示，以向收件者發出活動替代傳遞路徑的訊號。

默認傳遞模式為\“default\”。 請參閱 DeliveryModes。

傳回:

public List getEntities()

傳回活動中實體的承載版本。 實體在欄位數目上可能會有所不同。 Entity 類別會保留 getProperties()中的其他欄位。 若要轉換成其他實體類型，請使用 <T>getAs(Class<T> classType)。

傳回:

public LocalDateTime getExpiration()

取得活動應視為過期的時間，且不應向收件者呈現。

傳回:

public ChannelAccount getFrom()

識別訊息的寄件者。

傳回:

public boolean getHistoryDisclosed()

取得通道先前的歷程記錄是否公開。

傳回:

public String getId()

傳回可唯一識別通道上活動的標識碼。

傳回:

public String getImportance()

取得活動的重要性。

傳回:

public InputHints getInputHint()

指出您的 Bot 是否在訊息傳遞至客戶端之後接受、預期或忽略使用者輸入。

傳回:

public String getLabel()

取得活動的描述性標籤。

傳回:

public List getListenFor()

取得語音和語言準備系統應該接聽的片語和參考清單。

傳回:

public OffsetDateTime getLocalTimestamp()

取得訊息的本機日期和時間，以 ISO-8601 格式表示。 例如，2016-09-23T13：07：49.4714686-07：00。

傳回:

public String getLocalTimezone()

取得訊息的當地時區名稱，以 IANA 時區資料庫格式表示。 例如，美國/Los_Angeles。

傳回:

public String getLocale()

文字欄位內容的地區設定名稱。 地區設定名稱是與語言相關聯的 ISO 639 兩個或三個字母文化特性代碼和與國家或地區相關聯的 ISO 3166 雙字母子文化特性代碼的組合。

地區設定名稱也可以對應至有效的BCP-47語言標記。

傳回:

public List getMembersAdded()

取得加入至交談的成員集合。

傳回:

public List getMembersRemoved()

取得從交談中移除的成員集合。

傳回:

public List getMentions()

從此活動的實體解析提及。 這個方法定義在 Activity 類別上，但只適用於訊息活動，其中活動 Activity#type 設定為 MESSAGE。

傳回:

public String getName()

取得與叫用或事件活動相關聯的作業名稱。

傳回:

public Map getProperties()

保留物件中不是第一類屬性的溢位屬性。 這可在維護 對象時允許擴充性。

傳回:

public List getReactionsAdded()

取得加入至交談之回應的集合。

傳回:

public List getReactionsRemoved()

取得從交談中移除之回應的集合。

傳回:

public ChannelAccount getRecipient()

識別郵件的收件者。

傳回:

public ConversationReference getRelatesTo()

另一個交談或活動的參考。

傳回:

public ConversationReference getReplyConversationReference(ResourceResponse reply)

根據此活動的交談資訊和 ResourceResponse 傳送活動，建立 ConversationReference。

參數:

傳回:

public String getReplyToId()

取得此訊息為回復之訊息的標識碼。

傳回:

public String getServiceUrl()

設定指定通道服務端點的 URL。 由通道設定。

傳回:

public String getSpeak()

要說話的文字。

傳回:

public SuggestedActions getSuggestedActions()

取得活動的建議動作。

傳回:

public String getSummary()

取得通道無法轉譯卡片時要顯示的文字。

傳回:

public String getText()

取得訊息的文字內容。

傳回:

public TextFormatTypes getTextFormat()

文字欄位格式 Default：markdown。 可能的值包括：『markdown』、『plain』、『xml』。

傳回:

public List getTextHighlights()

取得活動包含 ReplyToId 值時要反白顯示的文字片段集合。

傳回:

public OffsetDateTime getTimestamp()

取得以 ISO-8601 格式表示訊息的日期和時間。

傳回:

public String getTopicName()

取得交談的更新主題名稱。

傳回:

public String getType()

取得活動的 ActivityTypes。

傳回:

public Object getValue()

取得與活動相關聯的值。

傳回:

public String getValueType()

取得活動值物件的型別。

傳回:

public boolean hasContent()

檢查此 （訊息） 活動是否有內容。

傳回:

protected boolean isActivity(String activityType)

如果 Activity 是指定的活動類型，則為 True。

參數:

傳回:

public Boolean isFromStreamingConnection()

判斷活動是否透過 Http/Https 連線或串流傳送。這可藉由查看 ServiceUrl 屬性來判斷：（1） 透過 HTTP/https 傳送訊息的所有通道都不會透過串流傳送訊息的通道 （2） 透過串流傳送訊息的通道具有不是以 HTTP/HTTPs 開頭的 ServiceUrl。

傳回:

public boolean isTeamsActivity()

檢查此動作是否來自 Microsoft 小組。

傳回:

public boolean isType(String compareTo)

如果 Activity 是指定的型別，則傳回的便利方法。

參數:

傳回:

public String removeMentionText(String withId)

從 Activity.Text 屬性中移除指定識別碼的任何提及文字。 例如，假設訊息 「@echoBot Hi Bot」，這會移除 「@echoBot」，並保留 「Hi Bot」。 通常，這會用來移除目標收件者（Bot 通常）的提及文字，不過可以針對每個成員呼叫它。 例如：turnContext.Activity.RemoveMentionText（turnContext.Activity.Recipient.Id）：提及 Activity.Entity 的格式取決於通道。 但在所有情況下，我們預期 Mention.Text 會包含使用者在 Activity.Text 中顯示的確切文字。 例如，Teams 會使用使用者名稱，而 slack 則使用 @username。 預期文字在 Activity.Text 中，且此方法會從 Activity.Text 中移除該值。

參數:

傳回:

public static String removeMentionTextImmutable(Activity activity, String id)

從 Activity.Text 中移除提及，而不需修改 Activity。

參數:

傳回:

public String removeRecipientMention()

從 Text 屬性移除收件者提及文字。 請小心使用，因為此函式正在改變活動上的文字。

傳回:

public static String removeRecipientMentionImmutable(Activity activity)

拿掉收件者提及而不修改活動。

參數:

傳回:

public void setAction(String withAction)

指出是否已從寄件人的聯繫人清單中新增或移除 contactRelationUpdate 的收件者。

參數:

public void setAttachment(Attachment withAttachment)

設定活動上的單一附件。

參數:

public void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

設定多個附件的配置提示。

參數:

public void setAttachments(List withAttachments)

將附件設定為 Activity。

參數:

public void setCallerId(String withCallerId)

設定識別 Bot 呼叫端的 IRI。 此欄位並非要透過網路傳輸，而是由 Bot 和用戶端根據可密碼編譯驗證的數據填入，該數據會判斷呼叫端的身分識別（例如令牌）。

參數:

public void setChannelData(Object withChannelData)

設定通道特定內容。

參數:

public void setChannelId(String withChannelId)

設定可唯一識別通道的標識碼。 由通道設定。

參數:

public void setCode(EndOfConversationCodes withCode)

設定 endOfConversation 活動的程式代碼，指出對話結束的原因。

參數:

public void setConversation(ConversationAccount withConversation)

識別活動所屬的交談。

參數:

public void setDeliveryMode(String withDeliveryMode)

傳送提示，以向收件者發出活動替代傳遞路徑的訊號。

默認傳遞模式為\“default\”。

參數:

public void setEntities(List withEntities)

設定活動中實體的承載版本。

參數:

public void setExpiration(LocalDateTime withExpiration)

設定活動應視為過期的時間，且不應呈現給收件者。

參數:

public void setFrom(ChannelAccount withFrom)

識別訊息的寄件者。

參數:

public void setHistoryDisclosed(boolean withHistoryDisclosed)

設定通道的先前歷程記錄是否公開。

參數:

public void setId(String withId)

設定可唯一識別通道上活動的標識碼。

參數:

public void setImportance(String withImportance)

設定活動的重要性。

參數:

public void setInputHint(InputHints withInputHint)

指出您的 Bot 是否在訊息傳遞至客戶端之後接受、預期或忽略使用者輸入。

參數:

public void setLabel(String withLabel)

設定活動的描述性標籤。

參數:

public void setListenFor(List withListenFor)

設定語音和語言準備系統應該接聽的片語和參考清單。

參數:

public void setLocalTimeZone(String withLocalTimezone)

設定訊息的當地時區名稱，以 IANA 時區資料庫格式表示。 例如，美國/Los_Angeles。

參數:

public void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

包含訊息的本機日期和時間，以 ISO-8601 格式表示。 例如，2016-09-23T13：07：49.4714686-07：00。

參數:

public void setLocale(String withLocale)

文字欄位內容的地區設定名稱。 地區設定名稱是與語言相關聯的 ISO 639 兩個或三個字母文化特性代碼和與國家或地區相關聯的 ISO 3166 雙字母子文化特性代碼的組合。

地區設定名稱也可以對應至有效的BCP-47語言標記。

參數:

public void setMembersAdded(List withMembersAdded)

設定加入至交談的成員集合。

參數:

public void setMembersRemoved(List withMembersRemoved)

設定從交談中移除的成員集合。

參數:

public void setMentions(List withMentions)

設定活動中提及的承載版本。

參數:

public void setName(String withName)

設定與叫用或事件活動相關聯的作業名稱。

參數:

public void setProperties(String key, JsonNode withValue)

保留物件中不是第一類屬性的溢位屬性。 這可在維護 對象時允許擴充性。

參數:

public void setReactionsAdded(List withReactionsAdded)

設定新增至交談的反應集合。

參數:

public void setReactionsRemoved(List withReactionsRemoved)

設定從交談中移除之回應的集合。

參數:

public void setRecipient(ChannelAccount withRecipient)

識別郵件的收件者。

參數:

public void setRelatesTo(ConversationReference withRelatesTo)

另一個交談或活動的參考。

參數:

public void setReplyToId(String withReplyToId)

設定此訊息為回復之訊息的標識碼。

參數:

public void setServiceUrl(String withServiceUrl)

設定指定通道服務端點的 URL。 由通道設定。

參數:

public void setSpeak(String withSpeak)

設定要說出的文字。

參數:

public void setSuggestedActions(SuggestedActions withSuggestedActions)

活動的建議動作。

參數:

public void setSummary(String withSummary)

設定通道無法轉譯卡片時顯示的文字。

參數:

public void setText(String withText)

設定訊息的文字內容。

參數:

public void setTextFormat(TextFormatTypes withTextFormat)

文字欄位格式。

參數:

public void setTextHighlights(List withTextHighlights)

設定活動包含 ReplyToId 值時要反白顯示的文字片段集合。

參數:

public void setTimestamp(OffsetDateTime withTimestamp)

以 ISO-8601 格式來設定訊息傳送的日期和時間。

參數:

public void setTopicName(String withTopicName)

設定交談的更新主題名稱。

參數:

public void setType(String withType)

設定活動的 ActivityTypes。

參數:

public void setValue(Object withValue)

設定與活動相關聯的值。

參數:

public void setValueType(String withValueType)

設定活動值物件的型別。

參數:

public TeamsChannelData teamsGetChannelData()

取得 TeamsChannelData。

傳回:

public String teamsGetChannelId()

取得代表通道的唯一標識碼。

傳回:

public TeamsMeetingInfo teamsGetMeetingInfo()

從目前活動取得TeamsMeetingInfo物件。

傳回:

public String teamsGetTeamId()

取得代表小組的唯一標識符。

傳回:

public TeamInfo teamsGetTeamInfo()

取得 Teams TeamInfo 數據。

傳回:

public void teamsNotifyUser()

將 TeamsChannelData 中的通知值設定為 true。

public void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

在 TeamsChannelData 中設定會議的通知。

參數: