Activity 类

  • 参考
包:
com.microsoft.bot.schema
Maven 项目:
com.microsoft.bot:bot-schema:4.14.3
  • java.lang.Object
    • com.microsoft.bot.schema.Activity

public class Activity

Activity 类包含单个更具体的活动可能包含的所有属性。 它是超集类型。

构造函数摘要

修饰符 构造函数 说明
protected Activity()

默认构造函数。
Activity(String withType)

构造指定类型的活动。

方法摘要

修饰符和类型 方法和描述
TypeT <TypeT>getChannelData(Class<TypeT> classType)

获取通道数据作为类型化结构。
ResultPair<TypeT> <TypeT>tryGetChannelData(Class<TypeT> clsType)

获取通道数据作为类型化结构。
final Activity applyConversationReference(ConversationReference reference)

使用现有 ConversationReference中的传出传递信息汇报此活动。
final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

使用现有 ConversationReference中的传递信息汇报此活动。
static Activity clone(Activity activity)

克隆活动。
static Activity createContactRelationUpdateActivity()

创建CONTACT_RELATION_UPDATE类型 Activity。
static Activity createConversationUpdateActivity()

创建CONVERSATION_UPDATE类型 Activity。
static Activity createEndOfConversationActivity()

创建END_OF_CONVERSATION类型的活动。
static Activity createEventActivity()

创建 EVENT 类型的活动。
static Activity createHandoffActivity()

创建 HANDOFF 类型 Activity。
static Activity createInvokeActivity()

创建 ACTIVITY 的 INVOKE 类型。
static Activity createMessageActivity()

创建 MESSAGE 类型 Activity。
Activity createReply()

创建新的消息活动作为对此活动的响应。
Activity createReply(String withText)

创建新的消息活动作为对此活动的响应。
Activity createReply(String withText, String withLocale)

创建新的消息活动作为对此活动的响应。
Activity createTrace(String withName)

创建 Activity 类的类型为 TRACE的实例。
Activity createTrace(String withName, Object withValue, String withValueType, String withLabel)

创建 Activity 类的类型为 TRACE的实例。
static Activity createTraceActivity(String withName)

创建 TRACE 类型活动。
static Activity createTraceActivity(String withName, String withValueType, Object withValue, String withLabel)

创建 TRACE 类型活动。
static Activity createTypingActivity()

创建 TYPE 类型 Activity。
java.lang.String getAction()

指示联系人关系更新的收件人是否已从发件人的联系人列表中添加或删除。
AttachmentLayoutTypes getAttachmentLayout()

多个附件的布局提示。
java.util.List<Attachment> getAttachments()

获取活动的附件。
java.lang.String getCallerId()

获取一个字符串，其中包含标识机器人调用方 IRI 的字符串。
java.lang.Object getChannelData()

获取特定于通道的内容。
java.lang.String getChannelId()

获取唯一标识通道的 ID。
EndOfConversationCodes getCode()

获取结束OfConversation 活动的代码，该代码指示会话结束的原因。
ConversationAccount getConversation()

标识活动所属的会话。
ConversationReference getConversationReference()

ConversationReference基于此活动创建 。
java.lang.String getDeliveryMode()

一个传递提示，向接收方指示活动的备用传递路径。
java.util.List<Entity> getEntities()

返回活动中实体的有效负载版本。
java.time.LocalDateTime getExpiration()

获取活动应被视为已过期且不应呈现给收件人的时间。
ChannelAccount getFrom()

标识消息的发件人。
boolean getHistoryDisclosed()

获取是否公开通道的先前历史记录。
java.lang.String getId()

返回唯一标识通道上的活动的 ID。
java.lang.String getImportance()

获取活动的重要性。
InputHints getInputHint()

指示在消息传递到客户端后，机器人是接受、期待还是忽略用户输入。
java.lang.String getLabel()

获取活动的描述性标签。
java.util.List<java.lang.String> getListenFor()

获取语音和语言启动系统应侦听的短语和引用的列表。
java.time.OffsetDateTime getLocalTimestamp()

获取消息的本地日期和时间，以 ISO-8601 格式表示。
java.lang.String getLocalTimezone()

获取消息的本地时区的名称，以 IANA 时区数据库格式表示。
java.lang.String getLocale()

文本字段内容的区域设置名称。
java.util.List<ChannelAccount> getMembersAdded()

获取添加到会话的成员的集合。
java.util.List<ChannelAccount> getMembersRemoved()

获取从对话中删除的成员的集合。
java.util.List<Mention> getMentions()

解析此活动的实体中的提及。
java.lang.String getName()

获取与调用或事件活动关联的操作的名称。
java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> getProperties()

保留对象中不是第一类属性的溢出属性。
java.util.List<MessageReaction> getReactionsAdded()

获取添加到会话中的反应的集合。
java.util.List<MessageReaction> getReactionsRemoved()

获取从会话中删除的反应集合。
ChannelAccount getRecipient()

标识邮件的收件人。
ConversationReference getRelatesTo()

对另一个对话或活动的引用。
ConversationReference getReplyConversationReference(ResourceResponse reply)

基于此活动的会话信息以及发送活动时的资源响应创建对话引用。
java.lang.String getReplyToId()

获取此消息作为回复的消息的 ID。
java.lang.String getServiceUrl()

设置指定通道的服务终结点的 URL。
java.lang.String getSpeak()

要朗读的文本。
SuggestedActions getSuggestedActions()

获取活动的建议操作。
java.lang.String getSummary()

获取通道无法呈现卡片时要显示的文本。
java.lang.String getText()

获取消息的文本内容。
TextFormatTypes getTextFormat()

文本字段的格式 Default：markdown。
java.util.List<TextHighlight> getTextHighlights()

获取要在活动包含 ReplyToId 值时突出显示的文本片段集合。
java.time.OffsetDateTime getTimestamp()

获取发送消息的日期和时间（UTC），以 ISO-8601 格式表示。
java.lang.String getTopicName()

获取会话的更新主题名称。
java.lang.String getType()

ActivityTypes获取活动的 。
java.lang.Object getValue()

获取与活动关联的值。
java.lang.String getValueType()

获取活动的值对象的类型。
boolean hasContent()

检查此 (消息) 活动是否包含内容。
protected boolean isActivity(String activityType)

如果 Activity 属于指定的活动类型，则为 True。
java.lang.Boolean isFromStreamingConnection()

确定活动是通过 Http/Https 连接还是流式处理发送的，这可以通过查看服务URL 属性来确定： (1) 通过 http/https 发送消息的所有通道都不流式传输 (2) 通过流式传输消息的通道具有不以 http/https 开头的服务URL。
boolean isTeamsActivity()

检查此行为是否来自 Microsoft 团队。
boolean isType(String compareTo)

如果 Activity 为指定类型，则返回的便捷方法。
java.lang.String removeMentionText(String withId)

从活动中删除给定 ID 的任何提及文本。Text 属性。
static java.lang.String removeMentionTextImmutable(Activity activity, String id)

从活动中删除提及。不修改活动的文本。
java.lang.String removeRecipientMention()

从 Text 属性中删除收件人提及文本。
static java.lang.String removeRecipientMentionImmutable(Activity activity)

删除收件人提及，但不修改活动。
void setAction(String withAction)

指示联系人关系更新的收件人是否已从发件人的联系人列表中添加或删除。
void setAttachment(Attachment withAttachment)

设置活动上的单个附件。
void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

设置多个附件的布局提示。
void setAttachments(List<Attachment> withAttachments)

将附件设置为 活动。
void setCallerId(String withCallerId)

设置标识机器人调用方 IRI。
void setChannelData(Object withChannelData)

设置特定于通道的内容。
void setChannelId(String withChannelId)

设置唯一标识通道的 ID。
void setCode(EndOfConversationCodes withCode)

为结束OfConversation 活动设置一个代码，该代码指示会话结束的原因。
void setConversation(ConversationAccount withConversation)

标识活动所属的会话。
void setDeliveryMode(String withDeliveryMode)

一个传递提示，向接收方指示活动的备用传递路径。
void setEntities(List<Entity> withEntities)

设置活动中实体的有效负载版本。
void setExpiration(LocalDateTime withExpiration)

设置活动应被视为已过期且不应呈现给收件人的时间。
void setFrom(ChannelAccount withFrom)

标识消息的发件人。
void setHistoryDisclosed(boolean withHistoryDisclosed)

设置是否公开通道的先前历史记录。
void setId(String withId)

设置唯一标识通道上活动的 ID。
void setImportance(String withImportance)

设置活动的重要性。
void setInputHint(InputHints withInputHint)

指示在将消息传递到客户端后，机器人是接受、期望还是忽略用户输入。
void setLabel(String withLabel)

设置活动的描述性标签。
void setListenFor(List<String> withListenFor)

设置语音和语言启动系统应侦听的短语和引用列表。
void setLocalTimeZone(String withLocalTimezone)

设置消息的本地时区名称，以 IANA 时区数据库格式表示。
void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

包含以 ISO-8601 格式表示的消息的本地日期和时间。
void setLocale(String withLocale)

文本字段内容的区域设置名称。
void setMembersAdded(List<ChannelAccount> withMembersAdded)

设置添加到会话的成员集合。
void setMembersRemoved(List<ChannelAccount> withMembersRemoved)

设置从会话中删除的成员集合。
void setMentions(List<Mention> withMentions)

设置 Activity 中提及的有效负载版本。
void setName(String withName)

设置与调用或事件活动关联的操作的名称。
void setProperties(String key, JsonNode withValue)

保留对象中不属于第一类属性的溢出属性。
void setReactionsAdded(List<MessageReaction> withReactionsAdded)

设置添加到会话的反应集合。
void setReactionsRemoved(List<MessageReaction> withReactionsRemoved)

设置从对话中删除的反应集合。
void setRecipient(ChannelAccount withRecipient)

标识邮件的收件人。
void setRelatesTo(ConversationReference withRelatesTo)

对另一个会话或活动的引用。
void setReplyToId(String withReplyToId)

设置此消息作为答复的消息的 ID。
void setServiceUrl(String withServiceUrl)

设置指定通道的服务终结点的 URL。
void setSpeak(String withSpeak)

设置要朗讲的文本。
void setSuggestedActions(SuggestedActions withSuggestedActions)

活动的建议操作。
void setSummary(String withSummary)

设置在通道无法呈现卡片时要显示的文本。
void setText(String withText)

设置消息的文本内容。
void setTextFormat(TextFormatTypes withTextFormat)

文本字段的格式。
void setTextHighlights(List<TextHighlight> withTextHighlights)

设置当活动包含 ReplyToId 值时要突出显示的文本片段集合。
void setTimestamp(OffsetDateTime withTimestamp)

设置发送消息的日期和时间（UTC），以 ISO-8601 格式表示。
void setTopicName(String withTopicName)

设置会话的更新主题名称。
void setType(String withType)

ActivityTypes设置活动的 。
void setValue(Object withValue)

设置与活动关联的值。
void setValueType(String withValueType)

设置活动的值对象的类型。
TeamsChannelData teamsGetChannelData()

获取 Teams频道数据。
java.lang.String teamsGetChannelId()

获取表示通道的唯一标识符。
TeamsMeetingInfo teamsGetMeetingInfo()

从当前活动获取 Teams会议信息 对象。
java.lang.String teamsGetTeamId()

获取表示团队的唯一标识符。
TeamInfo teamsGetTeamInfo()

获取 Teams 团队信息数据。
void teamsNotifyUser()

将 Teams频道数据中的通知值设置为 true。
void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

在 Teams频道数据中设置会议通知。

方法继承自 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

构造函数详细信息

Activity

protected Activity()

默认构造函数。 通常，这不会使用，因为通常需要 ActivityType。

Activity

public Activity(String withType)

构造指定类型的活动。

Parameters:

withType - 活动类型。

方法详细信息

<TypeT>getChannelData

public TypeT getChannelData(Class classType)

获取 channelData 作为类型化结构。

Parameters:

classType - 要使用的 TypeT 类

Returns:

typed Object 或默认 (TypeT)

Throws:

com.fasterxml.jackson.core.JsonProcessingException - 如果通道数据无法转换为 TypeT。

<TypeT>tryGetChannelData

public ResultPair tryGetChannelData(Class clsType)

获取 channelData 作为类型化结构。

Parameters:

clsType - 要使用的 TypeT 类

Returns:

ChannelData 作为 TypeT

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference)

使用现有 ConversationReference中的传出传递信息汇报此活动。

Parameters:

reference - 现有会话引用。

Returns:

此活动，使用传递信息进行了更新。

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

使用现有 ConversationReference中的传递信息汇报此活动。 调用 #getConversationReference 传入活动以获取对话引用，然后使用该引用更新传出活动的正确传递信息。

Parameters:

reference - 现有会话引用。
isIncoming - 如果为 true，请将活动视为传入活动，其中机器人是接收者;否则为 false。

Returns:

此活动，使用传递信息进行了更新。

clone

public static Activity clone(Activity activity)

克隆活动。

Parameters:

activity - 要克隆的活动。

Returns:

新的克隆活动

createContactRelationUpdateActivity

public static Activity createContactRelationUpdateActivity()

创建CONTACT_RELATION_UPDATE类型 Activity。

Returns:

联系人关系更新类型活动。

createConversationUpdateActivity

public static Activity createConversationUpdateActivity()

创建CONVERSATION_UPDATE类型 Activity。

Returns:

会话更新类型活动。

createEndOfConversationActivity

public static Activity createEndOfConversationActivity()

创建END_OF_CONVERSATION类型的活动。

Returns:

会话活动的新结束。

createEventActivity

public static Activity createEventActivity()

创建 EVENT 类型的活动。

Returns:

新事件活动。

createHandoffActivity

public static Activity createHandoffActivity()

创建 HANDOFF 类型 Activity。

Returns:

新的移交活动。

createInvokeActivity

public static Activity createInvokeActivity()

创建 ACTIVITY 的 INVOKE 类型。

Returns:

新的调用活动。

createMessageActivity

public static Activity createMessageActivity()

创建 MESSAGE 类型 Activity。

Returns:

消息“活动类型”。

createReply

public Activity createReply()

创建新的消息活动作为对此活动的响应。

Returns:

新消息活动。

createReply

public Activity createReply(String withText)

创建新的消息活动作为对此活动的响应。 此重载使用此活动的区域设置。

Parameters:

withText - 回复的文本。

Returns:

新消息活动。

createReply

public Activity createReply(String withText, String withLocale)

创建新的消息活动作为对此活动的响应。

Parameters:

withText - 回复的文本。
withLocale - 文本的语言代码。

Returns:

新消息活动。

createTrace

public Activity createTrace(String withName)

创建 Activity 类的类型为 TRACE的实例。

Parameters:

withName - 要创建的跟踪操作的名称。

Returns:

新的跟踪活动。

createTrace

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

创建 Activity 类的类型为 TRACE的实例。

Parameters:

withName - 要创建的跟踪操作的名称。
withValue - 可选，此跟踪操作的内容。
withValueType - 可选，为 withValue 格式的标识符。 默认值是 withValue 的类型的名称。
withLabel - 可选，此跟踪操作的描述性标签。

Returns:

新的跟踪活动。

createTraceActivity

public static Activity createTraceActivity(String withName)

创建 TRACE 类型活动。

Parameters:

withName - 操作的名称

Returns:

跟踪类型活动。

createTraceActivity

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

创建 TRACE 类型活动。

Parameters:

withName - 操作的名称
withValueType - valueType（如果有助于标识值架构 (默认值为 value）。GetType () 。名称)
withValue - 此跟踪操作的内容。
withLabel - 此跟踪操作的描述性标签。

Returns:

跟踪类型活动。

createTypingActivity

public static Activity createTypingActivity()

创建 TYPE 类型 Activity。

Returns:

新的键入活动。

getAction

public String getAction()

指示是否已在发件人的联系人列表中添加或删除 contactRelationUpdate 的收件人。

Returns:

收件人操作。

getAttachmentLayout

public AttachmentLayoutTypes getAttachmentLayout()

多个附件的布局提示。

Returns:

附件类型。

getAttachments

public List getAttachments()

获取活动的附件。

Returns:

的列表 Attachment。

getCallerId

public String getCallerId()

获取一个字符串，其中包含标识机器人调用方 IRI 的字符串。 此字段不旨在通过网络传输，而是由机器人和客户端根据断言调用方标识的、可通过密码方式验证的数据（例如令牌）填充。

Returns:

调用方 IRI。

getChannelData

public Object getChannelData()

获取特定于通道的内容。

Returns:

信道特定的数据。

getChannelId

public String getChannelId()

获取唯一标识通道的 ID。 由通道设置。

Returns:

通道 ID。

getCode

public EndOfConversationCodes getCode()

获取指示会话结束原因的 endOfConversation 活动的代码。

Returns:

endOfConversation 代码。

getConversation

public ConversationAccount getConversation()

标识活动所属的会话。

Returns:

getConversationReference

public ConversationReference getConversationReference()

ConversationReference基于此活动创建 。

Returns:

包含此活动的会话的会话引用。

getDeliveryMode

public String getDeliveryMode()

一个传递提示，向接收方指示活动的备用传递路径。

默认传递模式为“default\”。 请参阅 DeliveryModes。

Returns:

传递模式提示。

getEntities

public List getEntities()

返回活动中实体的有效负载版本。 实体在字段数上可能会有所不同。 类 Entity 保存 中的 getProperties()其他字段。 若要转换为其他实体类型，请使用 <T>getAs(Class<T> classType)。

Returns:

的列表 Entity。

getExpiration

public LocalDateTime getExpiration()

获取活动应被视为已过期且不应呈现给收件人的时间。

Returns:

活动过期时间。

getFrom

public ChannelAccount getFrom()

标识消息的发件人。

Returns:

ChannelAccount发送方的 。

getHistoryDisclosed

public boolean getHistoryDisclosed()

获取是否公开通道的先前历史记录。

Returns:

如果公开历史记录，则为 True。

getId

public String getId()

返回唯一标识通道上的活动的 ID。

Returns:

活动 ID。

getImportance

public String getImportance()

获取活动的重要性。

Returns:

活动重要性。

getInputHint

public InputHints getInputHint()

指示在消息传递到客户端后，机器人是接受、期待还是忽略用户输入。

Returns:

活动的输入提示。

getLabel

public String getLabel()

获取活动的描述性标签。

Returns:

活动标签。

getListenFor

public List getListenFor()

获取语音和语言启动系统应侦听的短语和引用的列表。

Returns:

要侦听的短语列表。

getLocalTimestamp

public OffsetDateTime getLocalTimestamp()

获取消息的本地日期和时间，以 ISO-8601 格式表示。 例如，2016-09-23T13：07：49.4714686-07：00。

Returns:

活动的本地时间戳。

getLocalTimezone

public String getLocalTimezone()

获取消息的本地时区的名称，以 IANA 时区数据库格式表示。 例如 America/Los_Angeles。

Returns:

本地时区。

getLocale

public String getLocale()

文本字段内容的区域设置名称。 区域设置名称是与语言关联的 ISO 639 双字母或三字母区域性代码和与国家或地区关联的 ISO 3166 双字母子区域性代码的组合。

区域设置名称还可以对应于有效的 BCP-47 语言标记。

Returns:

内容区域设置。

getMembersAdded

public List getMembersAdded()

获取添加到会话的成员的集合。

Returns:

ChannelAccount已添加成员的列表。

getMembersRemoved

public List getMembersRemoved()

获取从对话中删除的成员的集合。

Returns:

ChannelAccount已删除成员的列表。

getMentions

public List getMentions()

解析此活动的实体中的提及。 此方法在 类上 Activity 定义，但仅用于消息活动，其中活动 Activity#type 设置为 MESSAGE。

Returns:

提及的数组;或空数组（如果未找到）。

getName

public String getName()

获取与调用或事件活动关联的操作的名称。

Returns:

活动名称。

getProperties

public Map getProperties()

保留对象中不是第一类属性的溢出属性。 这允许扩展性，同时维护 对象。

Returns:

其他属性的映射。

getReactionsAdded

public List getReactionsAdded()

获取添加到会话中的反应的集合。

Returns:

的列表 MessageReaction。

getReactionsRemoved

public List getReactionsRemoved()

获取从会话中删除的反应集合。

Returns:

的列表 MessageReaction。

getRecipient

public ChannelAccount getRecipient()

标识邮件的收件人。

Returns:

ChannelAccount收件人的 。

getRelatesTo

public ConversationReference getRelatesTo()

对另一个对话或活动的引用。

Returns:

会话引用。

getReplyConversationReference

public ConversationReference getReplyConversationReference(ResourceResponse reply)

基于此活动的会话信息以及发送活动的 ResourceResponse 创建 ConversationReference。

Parameters:

reply - 从 sendActivity 返回的 ResourceResponse。

Returns:

可存储并稍后用于删除或更新活动的 ConversationReference。

getReplyToId

public String getReplyToId()

获取此消息作为回复的消息的 ID。

Returns:

对 ID 的答复。

getServiceUrl

public String getServiceUrl()

设置指定通道的服务终结点的 URL。 由通道设置。

Returns:

服务 URL。

getSpeak

public String getSpeak()

要朗读的文本。

Returns:

要说话的 SSML 文本。

getSuggestedActions

public SuggestedActions getSuggestedActions()

获取活动的建议操作。

Returns:

活动的 SuggestedActions。

getSummary

public String getSummary()

获取通道无法呈现卡片时要显示的文本。

Returns:

摘要文本。

getText

public String getText()

获取消息的文本内容。

Returns:

文本内容。

getTextFormat

public TextFormatTypes getTextFormat()

文本字段的格式 Default：markdown。 可能的值包括：“markdown”、“plain”、“xml”。

Returns:

TextFormatTypes 类型。

getTextHighlights

public List getTextHighlights()

获取要在活动包含 ReplyToId 值时突出显示的文本片段集合。

Returns:

TextHighlight 的列表。

getTimestamp

public OffsetDateTime getTimestamp()

获取发送消息的日期和时间（UTC），以 ISO-8601 格式表示。

Returns:

活动的 UTC 时间戳。

getTopicName

public String getTopicName()

获取会话的更新主题名称。

Returns:

主题名称。

getType

public String getType()

ActivityTypes获取活动的 。

Returns:

活动类型。

getValue

public Object getValue()

获取与活动关联的值。

Returns:

活动值。

getValueType

public String getValueType()

获取活动的值对象的类型。

Returns:

值类型。

hasContent

public boolean hasContent()

检查此 (消息) 活动是否包含内容。

Returns:

如果此消息有任何要发送的内容，则返回 true。 否则为 False。

isActivity

protected boolean isActivity(String activityType)

如果 Activity 属于指定的活动类型，则为 True。

Parameters:

activityType - 要比较的类型。

Returns:

如果活动属于特定类型，则为 true。

isFromStreamingConnection

public Boolean isFromStreamingConnection()

确定活动是通过 Http/Https 连接还是流式处理发送的，这可以通过查看 ServiceUrl 属性来确定： (1) 通过 http/https 发送消息的所有通道都不流式传输 (2) 通过流式传输消息的通道具有不以 http/https 开头的 ServiceUrl。

Returns:

如果活动源自流式连接，则为 True。

isTeamsActivity

public boolean isTeamsActivity()

检查此行为是否来自 Microsoft 团队。

Returns:

如果活动来自 Microsoft 团队，则为 true。

isType

public boolean isType(String compareTo)

如果 Activity 为指定类型，则返回的便捷方法。

Parameters:

compareTo - 要比较的类型。

Returns:

如果 Activity 属于指定类型，则为 True。

removeMentionText

public String removeMentionText(String withId)

从 Activity.Text 属性中删除给定 ID 的任何提及文本。 例如，给定消息“@echoBot Hi Bot”，这将删除“@echoBot”，并保留“Hi Bot”。 通常，这将用于删除目标收件人的提及文本， (机器人通常) ，但可以为每个成员调用它。 例如：turnContext.Activity.RemoveMentionText (turnContext.Activity.Recipient.Id) ;提及 Activity.Entity 的格式取决于通道。 但在所有情况下，我们希望 Mention.Text 包含用户出现在 Activity.Text 中的确切文本。 例如，Teams 使用用户名，而 Slack 使用 @username。 预期文本位于 Activity.Text 中，此方法将从 Activity.Text 中删除该值。

Parameters:

withId - 要匹配的提及 ID。

Returns:

new Activity.Text 属性值。

removeMentionTextImmutable

public static String removeMentionTextImmutable(Activity activity, String id)

从 Activity.Text 中删除提及，而不修改 Activity。

Parameters:

activity - 要删除其提及文本的活动。
id - 收件人的 ID。

Returns:

已删除提及的 Activity.Text。

removeRecipientMention

public String removeRecipientMention()

从 Text 属性中删除收件人提及文本。 请谨慎使用，因为此函数会更改 Activity 上的文本。

Returns:

新增功能。文本属性值。

removeRecipientMentionImmutable

public static String removeRecipientMentionImmutable(Activity activity)

删除收件人提及，但不修改活动。

Parameters:

activity - 要从中删除提及的活动。

Returns:

已删除提及的 Activity.Text。

setAction

public void setAction(String withAction)

指示是否已在发件人的联系人列表中添加或删除 contactRelationUpdate 的收件人。

Parameters:

withAction - 收件人操作。

setAttachment

public void setAttachment(Attachment withAttachment)

设置活动上的单个附件。

Parameters:

withAttachment - Attachment 对象。

setAttachmentLayout

public void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

设置多个附件的布局提示。

Parameters:

withAttachmentLayout - 附件类型。

setAttachments

public void setAttachments(List withAttachments)

将附件设置为 活动。

Parameters:

withAttachments - 的列表 Attachment。

setCallerId

public void setCallerId(String withCallerId)

设置标识机器人调用方 IRI。 此字段不旨在通过网络传输，而是由机器人和客户端根据断言调用方标识的、可通过密码方式验证的数据（例如令牌）填充。

Parameters:

withCallerId - 来电显示。

setChannelData

public void setChannelData(Object withChannelData)

设置特定于通道的内容。

Parameters:

withChannelData - 作为 JsonNode 的通道特定数据。

setChannelId

public void setChannelId(String withChannelId)

设置唯一标识通道的 ID。 由通道设置。

Parameters:

withChannelId - 通道 ID。

setCode

public void setCode(EndOfConversationCodes withCode)

为 endOfConversation 活动设置一个代码，该代码指示会话结束的原因。

Parameters:

withCode - endOfConversation 代码。

setConversation

public void setConversation(ConversationAccount withConversation)

标识活动所属的会话。

Parameters:

withConversation - ConversationAccount。

setDeliveryMode

public void setDeliveryMode(String withDeliveryMode)

一个传递提示，向接收方指示活动的备用传递路径。

默认传递模式为“default\”。

Parameters:

withDeliveryMode - 传递模式提示。

setEntities

public void setEntities(List withEntities)

设置活动中实体的有效负载版本。

Parameters:

withEntities - 有效负载实体。

setExpiration

public void setExpiration(LocalDateTime withExpiration)

设置活动应被视为已过期且不应呈现给收件人的时间。

Parameters:

withExpiration - 活动过期时间。

setFrom

public void setFrom(ChannelAccount withFrom)

标识消息的发件人。

Parameters:

withFrom - ChannelAccount发送方的 。

setHistoryDisclosed

public void setHistoryDisclosed(boolean withHistoryDisclosed)

设置是否公开通道的先前历史记录。

Parameters:

withHistoryDisclosed - 如果公开历史记录，则为 True。

setId

public void setId(String withId)

设置唯一标识通道上活动的 ID。

Parameters:

withId - 活动 ID。

setImportance

public void setImportance(String withImportance)

设置活动的重要性。

Parameters:

withImportance - 活动重要性。

setInputHint

public void setInputHint(InputHints withInputHint)

指示在将消息传递到客户端后，机器人是接受、期望还是忽略用户输入。

Parameters:

withInputHint - 活动的输入提示。

setLabel

public void setLabel(String withLabel)

设置活动的描述性标签。

Parameters:

withLabel - 活动标签。

setListenFor

public void setListenFor(List withListenFor)

设置语音和语言启动系统应侦听的短语和引用列表。

Parameters:

withListenFor - 要侦听的短语列表。

setLocalTimeZone

public void setLocalTimeZone(String withLocalTimezone)

设置消息的本地时区名称，以 IANA 时区数据库格式表示。 例如 America/Los_Angeles。

Parameters:

withLocalTimezone - 本地时区。

setLocalTimestamp

public void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

包含以 ISO-8601 格式表示的消息的本地日期和时间。 例如，2016-09-23T13：07：49.4714686-07：00。

Parameters:

withLocalTimestamp - 活动的本地时间戳。

setLocale

public void setLocale(String withLocale)

文本字段内容的区域设置名称。 区域设置名称是与语言关联的 ISO 639 双字母或三字母区域性代码以及与国家或地区关联的 ISO 3166 双字母子区域性代码的组合。

区域设置名称也可以对应于有效的 BCP-47 语言标记。

Parameters:

withLocale - 内容区域设置。

setMembersAdded

public void setMembersAdded(List withMembersAdded)

设置添加到会话的成员集合。

Parameters:

withMembersAdded - ChannelAccount已添加成员的列表。

setMembersRemoved

public void setMembersRemoved(List withMembersRemoved)

设置从会话中删除的成员集合。

Parameters:

withMembersRemoved - ChannelAccount已删除成员的列表。

setMentions

public void setMentions(List withMentions)

设置 Activity 中提及的有效负载版本。

Parameters:

withMentions - 有效负载实体。

setName

public void setName(String withName)

设置与调用或事件活动关联的操作的名称。

Parameters:

withName - 活动名称。

setProperties

public void setProperties(String key, JsonNode withValue)

保留对象中不属于第一类属性的溢出属性。 这允许扩展性，同时维护 对象。

Parameters:

key - 要设置的属性的键。
withValue - 属性的值。

setReactionsAdded

public void setReactionsAdded(List withReactionsAdded)

设置添加到会话的反应集合。

Parameters:

withReactionsAdded - 的列表 MessageReaction。

setReactionsRemoved

public void setReactionsRemoved(List withReactionsRemoved)

设置从对话中删除的反应集合。

Parameters:

withReactionsRemoved - 的列表 MessageReaction。

setRecipient

public void setRecipient(ChannelAccount withRecipient)

标识邮件的收件人。

Parameters:

withRecipient - ChannelAccount收件人的 。

setRelatesTo

public void setRelatesTo(ConversationReference withRelatesTo)

对另一个会话或活动的引用。

Parameters:

withRelatesTo - 会话引用。

setReplyToId

public void setReplyToId(String withReplyToId)

设置此消息作为答复的消息的 ID。

Parameters:

withReplyToId - 对 ID 的回复。

setServiceUrl

public void setServiceUrl(String withServiceUrl)

设置指定通道的服务终结点的 URL。 由通道设置。

Parameters:

withServiceUrl - 活动的服务 URL。

setSpeak

public void setSpeak(String withSpeak)

设置要朗讲的文本。

Parameters:

withSpeak - 要说的 SSML 文本。

setSuggestedActions

public void setSuggestedActions(SuggestedActions withSuggestedActions)

活动的建议操作。

Parameters:

withSuggestedActions - 活动的 SuggestedActions。

setSummary

public void setSummary(String withSummary)

设置在通道无法呈现卡片时要显示的文本。

Parameters:

withSummary - 摘要文本。

setText

public void setText(String withText)

设置消息的文本内容。

Parameters:

withText - 文本内容。

setTextFormat

public void setTextFormat(TextFormatTypes withTextFormat)

文本字段的格式。

Parameters:

withTextFormat - TextFormatTypes 类型。

setTextHighlights

public void setTextHighlights(List withTextHighlights)

设置当活动包含 ReplyToId 值时要突出显示的文本片段集合。

Parameters:

withTextHighlights - TextHighlight 的列表。

setTimestamp

public void setTimestamp(OffsetDateTime withTimestamp)

设置发送消息的日期和时间（UTC），以 ISO-8601 格式表示。

Parameters:

withTimestamp - 活动的 UTC 时间戳。

setTopicName

public void setTopicName(String withTopicName)

设置会话的更新主题名称。

Parameters:

withTopicName - 主题名称。

setType

public void setType(String withType)

ActivityTypes设置活动的 。

Parameters:

withType - Activity 的类型。

setValue

public void setValue(Object withValue)

设置与活动关联的值。

Parameters:

withValue - Activity 值。

setValueType

public void setValueType(String withValueType)

设置活动的值对象的类型。

Parameters:

withValueType - Activity 值的类型。

teamsGetChannelData

public TeamsChannelData teamsGetChannelData()

获取 TeamsChannelData。

Returns:

TeamsChannelData

teamsGetChannelId

public String teamsGetChannelId()

获取表示通道的唯一标识符。

Returns:

如果这是具有有效数据的 Teams 活动，则为表示频道的唯一标识符。

teamsGetMeetingInfo

public TeamsMeetingInfo teamsGetMeetingInfo()

从当前活动获取 TeamsMeetingInfo 对象。

Returns:

当前活动的团队会议，或 null。

teamsGetTeamId

public String teamsGetTeamId()

获取表示团队的唯一标识符。

Returns:

如果这是具有有效数据的 Teams 活动，则为表示团队的唯一标识符。

teamsGetTeamInfo

public TeamInfo teamsGetTeamInfo()

获取 Teams TeamInfo 数据。

Returns:

如果这是具有有效数据的 Teams 活动，则 TeamInfo 对象。

teamsNotifyUser

public void teamsNotifyUser()

将 TeamsChannelData 中的通知值设置为 true。

teamsNotifyUser

public void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

在 TeamsChannelData 中设置会议的通知。

Parameters:

alertInMeeting - 如果这是会议警报，则为 True。
externalResourceUrl - 外部资源 URL。

适用于