Activity 类
- java.lang.Object
- com.microsoft.bot.schema.Activity
public class Activity
Activity 类包含单个、更具体的活动可以包含的所有属性。 它是超集类型。
构造函数摘要
方法摘要
| 修饰符和类型 |
方法和描述 |
|
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类型活动。
|
|
static
Activity
|
createConversationUpdateActivity()
创建CONVERSATION_UPDATE类型活动。
|
|
static
Activity
|
createEndOfConversationActivity()
创建END_OF_CONVERSATION类型的活动。
|
|
static
Activity
|
createEventActivity()
创建 Activity 的 EVENT 类型。
|
|
static
Activity
|
createHandoffActivity()
创建 HANDOFF 类型活动。
|
|
static
Activity
|
createInvokeActivity()
创建 ACTIVITY 的 INVOKE 类型。
|
|
static
Activity
|
createMessageActivity()
创建 MESSAGE 类型活动。
|
|
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 类型活动。
|
|
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()
文本字段的格式默认值:markdown。
|
|
java.util.List<TextHighlight>
|
getTextHighlights()
获取当活动包含 ReplyToId 值时要突出显示的文本片段的集合。
|
|
java.time.OffsetDateTime
|
getTimestamp()
获取以 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 是指定的活动类型。
|
|
java.lang.Boolean
|
isFromStreamingConnection()
确定是否通过 Http/Https 连接或流式传输发送了活动,这可以通过查看服务URL 属性来确定:(1) 通过 http/https 发送消息的所有通道都不是流式传输(2)通道,通过流式传输发送消息的服务URL,而该通道不以 http/https 开头。
|
|
boolean
|
isTeamsActivity()
检查此行为是否来自 Microsoft 团队。
|
|
boolean
|
isType(String compareTo)
如果活动的类型为指定类型,则返回的便利方法。
|
|
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)
设置活动中提及的有效负载版本。
|
|
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)
设置以 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()
从当前活动获取 TeamsMeetingInfo 对象。
|
|
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)
构造指定类型的活动。
参数:
withType
- 活动类型。
方法详细信息
<TypeT>getChannelData
public TypeT getChannelData(Class classType)
以类型化结构的形式获取 channelData。
参数:
classType
- 要使用的 TypeT 类
返回:
typed 对象或默认值(TypeT)
引发:
com.fasterxml.jackson.core.JsonProcessingException
- 如果通道数据无法转换为 TypeT。
<TypeT>tryGetChannelData
public ResultPair tryGetChannelData(Class clsType)
以类型化结构的形式获取 channelData。
参数:
clsType
- 要使用的 TypeT 类
返回:
ChannelData 作为 TypeT
applyConversationReference
public final Activity applyConversationReference(ConversationReference reference)
使用来自现有 ConversationReference的传出传递信息更新此活动。
参数:
reference
- 现有对话引用。
返回:
此活动使用传递信息进行更新。
applyConversationReference
public final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)
使用现有 ConversationReference中的传递信息更新此活动。 调用传入活动的 #getConversationReference 以获取对话引用,然后可以使用该引用使用正确的传递信息更新传出活动。
参数:
reference
- 现有对话引用。
isIncoming
- 将活动视为传入活动,其中机器人是接收者;否则为 false。
返回:
此活动使用传递信息进行更新。
clone
public static Activity clone(Activity activity)
克隆活动。
参数:
activity
- 要克隆的活动。
返回:
新的克隆活动
createContactRelationUpdateActivity
public static Activity createContactRelationUpdateActivity()
创建CONTACT_RELATION_UPDATE类型活动。
返回:
联系人关系更新类型活动。
createConversationUpdateActivity
public static Activity createConversationUpdateActivity()
创建CONVERSATION_UPDATE类型活动。
返回:
会话更新类型活动。
createEndOfConversationActivity
public static Activity createEndOfConversationActivity()
创建END_OF_CONVERSATION类型的活动。
返回:
对话活动的新结束。
createEventActivity
public static Activity createEventActivity()
创建 Activity 的 EVENT 类型。
返回:
新事件活动。
createHandoffActivity
public static Activity createHandoffActivity()
创建 HANDOFF 类型活动。
返回:
新的移交活动。
createInvokeActivity
public static Activity createInvokeActivity()
创建 ACTIVITY 的 INVOKE 类型。
返回:
新的调用活动。
createMessageActivity
public static Activity createMessageActivity()
创建 MESSAGE 类型活动。
返回:
消息活动类型。
createReply
public Activity createReply()
创建一个新消息活动作为对此活动的响应。
返回:
新消息活动。
createReply
public Activity createReply(String withText)
创建一个新消息活动作为对此活动的响应。 此重载使用此活动的区域设置。
参数:
withText
- 答复的文本。
返回:
新消息活动。
createReply
public Activity createReply(String withText, String withLocale)
创建一个新消息活动作为对此活动的响应。
参数:
withText
- 答复的文本。
withLocale
- 文本的语言代码。
返回:
新消息活动。
createTrace
public Activity createTrace(String withName)
将 Activity 类的实例创建为类型 TRACE。
参数:
withName
- 要创建的跟踪作的名称。
返回:
新的跟踪活动。
createTrace
public Activity createTrace(String withName, Object withValue, String withValueType, String withLabel)
将 Activity 类的实例创建为类型 TRACE。
参数:
withName
- 要创建的跟踪作的名称。
withValue
- 可选,此跟踪作的内容。
withValueType
- 可选,用于 withValue 格式的标识符。
默认值为 withValue 的类型的名称。
withLabel
- 可选,此跟踪作的描述性标签。
返回:
新的跟踪活动。
createTraceActivity
public static Activity createTraceActivity(String withName)
创建 TRACE 类型活动。
参数:
withName
- 作的名称
返回:
跟踪类型活动。
createTraceActivity
public static Activity createTraceActivity(String withName, String withValueType, Object withValue, String withLabel)
创建 TRACE 类型活动。
参数:
withName
- 作的名称
withValueType
- valueType 如果有助于标识值架构(默认值为值)。GetType()。名称)
withValue
- 此跟踪作的内容。
withLabel
- 此跟踪作的描述性标签。
返回:
跟踪类型活动。
createTypingActivity
public static Activity createTypingActivity()
创建 TYPE 类型活动。
返回:
新的键入活动。
getAction
public String getAction()
指示是否已从发件人的联系人列表中添加或删除 contactRelationUpdate 的收件人。
返回:
收件人作。
getAttachmentLayout
public AttachmentLayoutTypes getAttachmentLayout()
多个附件的布局提示。
返回:
附件类型。
getAttachments
public List getAttachments()
获取活动的附件。
返回:
getCallerId
public String getCallerId()
获取包含标识机器人调用方 IRI 的字符串。 此字段不打算通过网络传输,而是由机器人和客户端根据断言调用方标识(例如令牌)的可加密验证数据填充。
返回:
调用方 IRI。
getChannelData
public Object getChannelData()
获取特定于通道的内容。
返回:
通道特定数据。
getChannelId
public String getChannelId()
获取唯一标识通道的 ID。 由通道设置。
返回:
通道 ID。
getCode
public EndOfConversationCodes getCode()
获取 endOfConversation 活动的代码,该代码指示会话结束的原因。
返回:
endOfConversation 代码。
getConversation
public ConversationAccount getConversation()
标识活动所属的会话。
返回:
getConversationReference
public ConversationReference getConversationReference()
基于此活动创建 ConversationReference。
返回:
包含此活动的会话的对话引用。
getDeliveryMode
public String getDeliveryMode()
用于向收件人发出活动备用传递路径的信号的传递提示。
默认传递模式为“default\”。 请参阅 DeliveryModes。
返回:
传递模式提示。
getExpiration
public LocalDateTime getExpiration()
获取活动应被视为过期的时间,不应向收件人显示。
返回:
活动过期时间。
getFrom
public ChannelAccount getFrom()
标识邮件的发件人。
返回:
getHistoryDisclosed
public boolean getHistoryDisclosed()
获取通道的先前历史记录是否被披露。
返回:
如此 如果披露了历史记录。
getId
public String getId()
返回唯一标识通道上的活动的 ID。
返回:
活动 ID。
getImportance
public String getImportance()
获取活动的重要性。
返回:
活动重要性。
getInputHint
public InputHints getInputHint()
指示将消息传递到客户端后机器人是接受、期望还是忽略用户输入。
返回:
活动的输入提示。
getLabel
public String getLabel()
获取活动的描述性标签。
返回:
活动标签。
getListenFor
public List getListenFor()
获取语音和语言启动系统应侦听的短语和引用的列表。
返回:
要侦听的短语列表。
getLocalTimestamp
public OffsetDateTime getLocalTimestamp()
获取以 ISO-8601 格式表示的消息的本地日期和时间。 例如,2016-09-23T13:07:49.4714686-07:00。
返回:
活动的本地时间戳。
getLocalTimezone
public String getLocalTimezone()
获取以 IANA 时区数据库格式表示的消息的本地时区的名称。 例如,美国/Los_Angeles。
返回:
本地时区。
getLocale
public String getLocale()
文本字段内容的区域设置名称。 区域设置名称是与语言关联的 ISO 639 双字母或三字母区域性代码和与国家或地区关联的 ISO 3166 双字母子文化代码的组合。
区域设置名称还可以对应于有效的 BCP-47 语言标记。
返回:
内容区域设置。
getMembersAdded
public List getMembersAdded()
获取添加到会话的成员的集合。
返回:
getMembersRemoved
public List getMembersRemoved()
获取从会话中删除的成员集合。
返回:
getMentions
public List getMentions()
解析此活动的实体中的提及。 此方法在 Activity 类上定义,但仅用于消息活动,其中活动 Activity#type 设置为 MESSAGE。
返回:
提及数组;如果找不到空数组,则为空数组。
getName
public String getName()
获取与调用或事件活动关联的作的名称。
返回:
活动名称。
getProperties
public Map getProperties()
保留不属于对象中的第一类属性的溢出属性。 这允许在维护对象时实现扩展性。
返回:
其他属性的映射。
getReactionsAdded
public List getReactionsAdded()
获取添加到聊天中的反应的集合。
返回:
getReactionsRemoved
public List getReactionsRemoved()
获取从会话中删除的反应的集合。
返回:
getRecipient
public ChannelAccount getRecipient()
标识邮件的收件人。
返回:
getRelatesTo
public ConversationReference getRelatesTo()
对另一个对话或活动的引用。
返回:
对话引用。
getReplyConversationReference
public ConversationReference getReplyConversationReference(ResourceResponse reply)
基于此活动的对话信息和 ResourceResponse 发送活动来创建 ConversationReference。
参数:
reply
- 从 sendActivity 返回的 ResourceResponse。
返回:
可以存储和用于删除或更新活动的 ConversationReference。
getReplyToId
public String getReplyToId()
获取此消息是答复的消息的 ID。
返回:
对 ID 的答复。
getServiceUrl
public String getServiceUrl()
设置指定通道的服务终结点的 URL。 由通道设置。
返回:
服务 URL。
getSpeak
public String getSpeak()
要说的文本。
返回:
要说的 SSML 文本。
getSuggestedActions
public SuggestedActions getSuggestedActions()
获取活动的建议作。
返回:
活动的 SuggestedActions。
getSummary
public String getSummary()
获取在通道无法呈现卡片时要显示的文本。
返回:
摘要文本。
getText
public String getText()
获取消息的文本内容。
返回:
文本内容。
getTextFormat
public TextFormatTypes getTextFormat()
文本字段的格式默认值:markdown。 可能的值包括:“markdown”、“plain”、“xml”。
返回:
TextFormatTypes 类型。
getTextHighlights
public List getTextHighlights()
获取活动包含 ReplyToId 值时要突出显示的文本片段的集合。
返回:
getTimestamp
public OffsetDateTime getTimestamp()
获取以 ISO-8601 格式表示的消息的日期和时间。
返回:
活动的 UTC 时间戳。
getTopicName
public String getTopicName()
获取会话的更新主题名称。
返回:
主题名称。
getValue
public Object getValue()
获取与活动关联的值。
返回:
活动值。
getValueType
public String getValueType()
获取活动值对象的类型。
返回:
值类型。
hasContent
public boolean hasContent()
检查此(消息)活动是否包含内容。
返回:
如果此消息有任何要发送的内容,则返回 true。 否则为 False。
isActivity
protected boolean isActivity(String activityType)
如此 如果 Activity 是指定的活动类型。
参数:
activityType
- 要比较的类型。
返回:
如果活动是特定类型,则为 true。
isFromStreamingConnection
public Boolean isFromStreamingConnection()
确定是否通过 Http/Https 连接或流式传输发送了活动,这可以通过查看 ServiceUrl 属性来确定:(1) 通过 http/https 发送消息的所有通道不是通过流式处理发送消息的通道(2) 通道具有不以 http/https 开头的 ServiceUrl。
返回:
如此 如果活动源自流式处理连接。
isTeamsActivity
public boolean isTeamsActivity()
检查此行为是否来自 Microsoft 团队。
返回:
如果活动来自 Microsoft 团队,则为 true。
isType
public boolean isType(String compareTo)
如果活动的类型为指定类型,则返回的便利方法。
参数:
compareTo
- 要比较的类型。
返回:
如此 如果 Activity 为指定类型。
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 中删除该值。
参数:
withId
- 要匹配的提及 ID。
返回:
new Activity.Text 属性值。
removeMentionTextImmutable
public static String removeMentionTextImmutable(Activity activity, String id)
从 Activity.Text 中删除提及,而无需修改活动。
参数:
activity
- 要删除其上提及文本的活动。
id
- 收件人的 ID。
返回:
删除了提及的 Activity.Text。
removeRecipientMention
public String removeRecipientMention()
从 Text 属性中删除收件人提及文本。 请谨慎使用,因为此函数正在更改活动上的文本。
返回:
新增功能。文本属性值。
removeRecipientMentionImmutable
public static String removeRecipientMentionImmutable(Activity activity)
删除收件人提及而不修改活动。
参数:
activity
- 要从中删除提及的活动。
返回:
已删除提及的 Activity.Text。
setAction
public void setAction(String withAction)
指示是否已从发件人的联系人列表中添加或删除 contactRelationUpdate 的收件人。
参数:
withAction
- 收件人作。
setAttachment
public void setAttachment(Attachment withAttachment)
设置活动上的单个附件。
参数:
withAttachment
- Attachment 对象。
setAttachmentLayout
public void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)
设置多个附件的布局提示。
参数:
withAttachmentLayout
- 附件类型。
setAttachments
public void setAttachments(List withAttachments)
设置活动的附件。
参数:
setCallerId
public void setCallerId(String withCallerId)
设置标识机器人调用者的 IRI。 此字段不打算通过网络传输,而是由机器人和客户端根据断言调用方标识(例如令牌)的可加密验证数据填充。
参数:
withCallerId
- 调用方 ID。
setChannelData
public void setChannelData(Object withChannelData)
设置通道特定的内容。
参数:
withChannelData
- 以 JsonNode 的形式通道特定数据。
setChannelId
public void setChannelId(String withChannelId)
设置唯一标识通道的 ID。 由通道设置。
参数:
withChannelId
- 通道 ID。
setCode
public void setCode(EndOfConversationCodes withCode)
设置 endOfConversation 活动的代码,该代码指示会话结束的原因。
参数:
withCode
- endOfConversation 代码。
setConversation
public void setConversation(ConversationAccount withConversation)
标识活动所属的会话。
参数:
setDeliveryMode
public void setDeliveryMode(String withDeliveryMode)
用于向收件人发出活动备用传递路径的信号的传递提示。
默认传递模式为“default\”。
参数:
withDeliveryMode
- 传递模式提示。
setEntities
public void setEntities(List withEntities)
设置活动中实体的有效负载版本。
参数:
withEntities
- 有效负载实体。
setExpiration
public void setExpiration(LocalDateTime withExpiration)
设置应将活动视为过期的时间,不应提供给收件人。
参数:
withExpiration
- 活动过期时间。
setFrom
public void setFrom(ChannelAccount withFrom)
标识邮件的发件人。
参数:
setHistoryDisclosed
public void setHistoryDisclosed(boolean withHistoryDisclosed)
设置通道的先前历史记录是否被披露。
参数:
withHistoryDisclosed
- 如此 如果披露了历史记录。
setId
public void setId(String withId)
设置唯一标识通道上的活动的 ID。
参数:
withId
- 活动 ID。
setImportance
public void setImportance(String withImportance)
设置活动的重要性。
参数:
withImportance
- 活动重要性。
setInputHint
public void setInputHint(InputHints withInputHint)
指示将消息传递到客户端后机器人是接受、期望还是忽略用户输入。
参数:
withInputHint
- 活动的输入提示。
setLabel
public void setLabel(String withLabel)
设置活动的描述性标签。
参数:
withLabel
- 活动标签。
setListenFor
public void setListenFor(List withListenFor)
设置语音和语言启动系统应侦听的短语和引用列表。
参数:
withListenFor
- 要侦听的短语列表。
setLocalTimeZone
public void setLocalTimeZone(String withLocalTimezone)
设置消息的本地时区的名称,以 IANA 时区数据库格式表示。 例如,美国/Los_Angeles。
参数:
withLocalTimezone
- 本地时区。
setLocalTimestamp
public void setLocalTimestamp(OffsetDateTime withLocalTimestamp)
包含以 ISO-8601 格式表示的消息的本地日期和时间。 例如,2016-09-23T13:07:49.4714686-07:00。
参数:
withLocalTimestamp
- 活动的本地时间戳。
setLocale
public void setLocale(String withLocale)
文本字段内容的区域设置名称。 区域设置名称是与语言关联的 ISO 639 双字母或三字母区域性代码和与国家或地区关联的 ISO 3166 双字母子文化代码的组合。
区域设置名称还可以对应于有效的 BCP-47 语言标记。
参数:
withLocale
- 内容区域设置。
setMembersAdded
public void setMembersAdded(List withMembersAdded)
设置添加到会话的成员集合。
参数:
setMembersRemoved
public void setMembersRemoved(List withMembersRemoved)
设置从会话中删除的成员集合。
参数:
setMentions
public void setMentions(List withMentions)
设置活动中提及的有效负载版本。
参数:
withMentions
- 有效负载实体。
setName
public void setName(String withName)
设置与调用或事件活动关联的作的名称。
参数:
withName
- 活动名称。
setProperties
public void setProperties(String key, JsonNode withValue)
保留不属于对象中的第一类属性的溢出属性。 这允许在维护对象时实现扩展性。
参数:
key
- 要设置的属性的键。
withValue
- 属性的值。
setReactionsAdded
public void setReactionsAdded(List withReactionsAdded)
设置添加到对话中的反应的集合。
参数:
setReactionsRemoved
public void setReactionsRemoved(List withReactionsRemoved)
设置从对话中删除的反应集合。
参数:
setRecipient
public void setRecipient(ChannelAccount withRecipient)
标识邮件的收件人。
参数:
setRelatesTo
public void setRelatesTo(ConversationReference withRelatesTo)
对另一个对话或活动的引用。
参数:
withRelatesTo
- 对话引用。
setReplyToId
public void setReplyToId(String withReplyToId)
设置此邮件作为答复的消息的 ID。
参数:
withReplyToId
- 对 ID 的答复。
setServiceUrl
public void setServiceUrl(String withServiceUrl)
设置指定通道的服务终结点的 URL。 由通道设置。
参数:
withServiceUrl
- 活动的服务 URL。
setSpeak
public void setSpeak(String withSpeak)
设置要朗讲的文本。
参数:
withSpeak
- 要说的 SSML 文本。
setSuggestedActions
public void setSuggestedActions(SuggestedActions withSuggestedActions)
活动的建议作。
参数:
withSuggestedActions
- 活动的 SuggestedActions。
setSummary
public void setSummary(String withSummary)
设置在通道无法呈现卡片时要显示的文本。
参数:
withSummary
- 摘要文本。
setText
public void setText(String withText)
设置消息的文本内容。
参数:
withText
- 文本内容。
setTextFormat
public void setTextFormat(TextFormatTypes withTextFormat)
文本字段的格式。
参数:
withTextFormat
- TextFormatTypes 类型。
setTextHighlights
public void setTextHighlights(List withTextHighlights)
设置活动包含 ReplyToId 值时要突出显示的文本片段集合。
参数:
setTimestamp
public void setTimestamp(OffsetDateTime withTimestamp)
设置以 ISO-8601 格式表示的消息发送的日期和时间。
参数:
withTimestamp
- 活动的 UTC 时间戳。
setTopicName
public void setTopicName(String withTopicName)
设置会话的更新主题名称。
参数:
withTopicName
- 主题名称。
setType
public void setType(String withType)
设置活动的 ActivityTypes。
参数:
withType
- 活动的类型。
setValue
public void setValue(Object withValue)
设置与活动关联的值。
参数:
withValue
- 活动值。
setValueType
public void setValueType(String withValueType)
设置活动值对象的类型。
参数:
withValueType
- 活动值的类型。
teamsGetChannelData
public TeamsChannelData teamsGetChannelData()
获取 TeamsChannelData。
返回:
TeamsChannelData
teamsGetChannelId
public String teamsGetChannelId()
获取表示通道的唯一标识符。
返回:
如果这是具有有效数据的 Teams 活动,则表示通道的唯一标识符。
teamsGetMeetingInfo
public TeamsMeetingInfo teamsGetMeetingInfo()
从当前活动获取 TeamsMeetingInfo 对象。
返回:
当前活动的团队会议或 null。
teamsGetTeamId
public String teamsGetTeamId()
获取表示团队的唯一标识符。
返回:
如果这是具有有效数据的 Teams 活动,则表示团队的唯一标识符。
teamsGetTeamInfo
public TeamInfo teamsGetTeamInfo()
获取 Teams TeamInfo 数据。
返回:
如果这是具有有效数据的 Teams 活动,则为 TeamInfo 对象。
teamsNotifyUser
public void teamsNotifyUser()
将 TeamsChannelData 中的通知值设置为 true。
teamsNotifyUser
public void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)
设置 TeamsChannelData 中会议通知。
参数:
alertInMeeting
- 如此 如果这是会议警报。
externalResourceUrl
- 外部资源 URL。
适用于