Activity 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
活动是 Bot Framework 3.0 协议的基本通信类型。
public class Activity : Microsoft.Bot.Schema.ICommandActivity, Microsoft.Bot.Schema.ICommandResultActivity, Microsoft.Bot.Schema.IContactRelationUpdateActivity, Microsoft.Bot.Schema.IConversationUpdateActivity, Microsoft.Bot.Schema.IEndOfConversationActivity, Microsoft.Bot.Schema.IEventActivity, Microsoft.Bot.Schema.IHandoffActivity, Microsoft.Bot.Schema.IInstallationUpdateActivity, Microsoft.Bot.Schema.IInvokeActivity, Microsoft.Bot.Schema.IMessageDeleteActivity, Microsoft.Bot.Schema.IMessageReactionActivity, Microsoft.Bot.Schema.IMessageUpdateActivity, Microsoft.Bot.Schema.ISuggestionActivity, Microsoft.Bot.Schema.ITraceActivity, Microsoft.Bot.Schema.ITypingActivitytype Activity = class
interface IActivity
interface IConversationUpdateActivity
interface IContactRelationUpdateActivity
interface IInstallationUpdateActivity
interface IMessageActivity
interface IMessageUpdateActivity
interface IMessageDeleteActivity
interface IMessageReactionActivity
interface ISuggestionActivity
interface ITypingActivity
interface IEndOfConversationActivity
interface IEventActivity
interface IInvokeActivity
interface ITraceActivity
interface IHandoffActivity
interface ICommandActivity
interface ICommandResultActivityPublic Class Activity
Implements ICommandActivity, ICommandResultActivity, IContactRelationUpdateActivity, IConversationUpdateActivity, IEndOfConversationActivity, IEventActivity, IHandoffActivity, IInstallationUpdateActivity, IInvokeActivity, IMessageDeleteActivity, IMessageReactionActivity, IMessageUpdateActivity, ISuggestionActivity, ITraceActivity, ITypingActivity- 继承
-
Activity
- 实现
-
IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity
注解
Activity 类包含单个、更具体的活动可以包含的所有属性。 它是超集类型。
构造函数
字段
| ContentType |
用于标识 Activity 媒体类型资源的 HTTP |
属性
| Action |
获取或设置一个字符串，该值指示是否已将 contactRelationUpdate 的收件人添加到发件人的联系人列表中或删除。 |
| AttachmentLayout |
获取或设置多个附件的布局提示。 默认值：列表。 可能的值由 AttachmentLayoutTypes定义。 |
| Attachments |
获取或设置活动的附件。 |
| CallerId |
获取或设置包含标识机器人调用方 IRI 的字符串。 此字段不打算通过网络传输，而是由机器人和客户端根据断言调用方标识（例如令牌）的可加密验证数据填充。 |
| ChannelData |
获取或设置特定于通道的内容。 |
| ChannelId |
获取或设置唯一标识通道的 ID。 由通道设置。 |
| Code |
获取或设置 endOfConversation 活动的代码，该代码指示会话结束的原因。 可能的值在 EndOfConversationCodes中定义。 |
| Conversation |
获取或设置活动所属的会话。 |
| DeliveryMode |
获取或设置一个传递提示，以向活动收件人的备用传递路径发出信号。 默认传递模式为“default”。 可能的值在 DeliveryModes中定义。 |
| Entities |
获取或设置消息中提到的实体。 |
| Expiration |
获取或设置应将活动视为“已过期”的时间，不应提供给收件人。 |
| From |
获取或设置邮件的发件人。 |
| HistoryDisclosed |
获取或设置一个值，该值指示是否披露通道的先前历史记录。 |
| Id |
获取或设置唯一标识通道上的活动的 ID。 |
| Importance |
获取或设置活动的重要性。 可能的值在 ActivityImportance中定义。 |
| InputHint |
获取或设置一个字符串，该值指示机器人在将消息传递到客户端后是接受、期望还是忽略用户输入（请参阅 InputHints。 |
| Label |
获取或设置活动的描述性标签。 |
| ListenFor |
获取或设置语音和语言启动系统应侦听的短语和引用的列表。 |
| Locale |
获取或设置文本字段内容的 BCP-47 区域设置名称。 |
| LocalTimestamp |
获取或设置以 ISO-8601 格式发送消息的日期和时间（ 以 ISO-8601 格式表示）。 例如，2016-09-23T13：07：49.4714686-07：00。 |
| LocalTimezone |
获取或设置用于为消息定义本地时间的时区的名称，以 IANA 时区数据库格式表示。 例如，美国/Los_Angeles。 |
| MembersAdded |
获取或设置添加到会话的成员集合。 |
| MembersRemoved |
获取或设置从会话中删除的成员集合。 |
| Name |
获取或设置与调用或事件活动关联的操作的名称。 |
| Properties |
获取或设置不是由 Activity 类型定义的但可能出现在序列化的 REST JSON 对象中的属性。 |
| ReactionsAdded |
获取或设置添加到聊天中的反应的集合。 |
| ReactionsRemoved |
获取或设置从会话中删除的反应集合。 |
| Recipient |
获取或设置邮件的收件人。 |
| RelatesTo |
获取或设置另一个会话或活动的 ConversationReference。 |
| ReplyToId |
获取或设置此消息作为答复的消息的 ID。 |
| SemanticAction |
获取或设置此请求随附的可选编程操作。 |
| ServiceUrl |
获取或设置指定通道的服务终结点的 URL。 由通道设置。 |
| Speak |
获取或设置要说出的文本。 |
| SuggestedActions |
获取或设置活动的建议操作。 |
| Summary |
获取或设置通道无法呈现卡片时要显示的文本。 |
| Text |
获取或设置消息的文本内容。 |
| TextFormat |
获取或设置文本字段的格式。 默认值：markdown。 可能的值由 TextFormatTypes定义。 |
| TextHighlights |
获取或设置活动包含 ReplyToId 值时要突出显示的文本片段的集合。 |
| Timestamp |
获取或设置以 ISO-8601 格式发送消息的日期和时间（采用 UTC 格式）。 |
| TopicName |
获取或设置会话的更新主题名称。 |
| Type |
获取或设置活动类型。 可能的值包括：“message”、“contactRelationUpdate”、“conversationUpdate”、“type”、“endOfConversation”、“event”、“invoke”、“deleteUserData”、“messageUpdate”、“messageDelete”、“installationUpdate”、“messageReaction”、“suggestion”、“trace”、“handoff”。 |
| Value |
获取或设置与活动关联的值。 |
| ValueType |
获取或设置活动值对象的类型。 |
方法
扩展方法
| TeamsGetChannelId(IActivity) |
从当前活动获取团队的频道 ID。 |
| TeamsGetMeetingInfo(IActivity) |
从当前活动获取 TeamsMeetingInfo 对象。 |
| TeamsGetSelectedChannelId(IActivity) |
从当前活动获取团队选择的频道 ID。 |
| TeamsGetTeamInfo(IActivity) |
从当前活动获取 TeamsInfo 对象。 |
| TeamsGetTeamOnBehalfOf(IActivity) |
从当前活动获取 Teams OnBehalfOf 列表。 |
| TeamsNotifyUser(IActivity, Boolean, String) |
配置当前活动以在 Teams 中生成通知。 |
| TeamsNotifyUser(IActivity) |
配置当前活动以在 Teams 中生成通知。 |
| MentionsId(IMessageActivity, String) |
文本属性中是否有 ID 的提及。 |
| MentionsRecipient(IMessageActivity) |
文本属性中是否有提及 Recipient.Id。 |
| RemoveMentionText(IMessageActivity, String) |
从 Activity.Text 属性中删除给定 ID 的任何提及文本。 例如，鉴于消息 @echoBot Hi Bot，这将删除“@echoBot”，留下“Hi Bot”。 |
| RemoveRecipientMention(IMessageActivity) |
从 Text 属性中删除收件人提及文本。 请谨慎使用，因为此函数正在更改活动上的文本。 |
| GetLocale(IActivity) |
获取活动的区域设置。 |
| SetLocale(IActivity, String) |
设置活动的区域设置。 |