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