IMessageActivity 接口
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
对话中的消息。
public interface IMessageActivity : Microsoft.Bot.Schema.IActivity
type IMessageActivity = interface
interface IActivity
Public Interface IMessageActivity
Implements IActivity
- 派生
- 实现
属性
AttachmentLayout |
获取或设置如何处理多个附件的提示:[list|carousel] Default:list。 |
Attachments |
获取或设置附件。 |
ChannelData |
获取或设置通道特定的有效负载。 (继承自 IActivity) |
ChannelId |
获取或设置与此活动关联的通道。 (继承自 IActivity) |
Conversation |
获取或设置此活动与之关联的会话的地址。 (继承自 IActivity) |
DeliveryMode |
获取或设置描述应如何传递此活动的提示。 null 或“default” = 默认传递“notification” = 通知语义请参阅当前常量的 DeliveryModes。 |
Entities |
获取或设置 Entity 对象的集合,每个对象都包含有关此活动的元数据。 键入每个 Entity 对象。 (继承自 IActivity) |
Expiration |
获取或设置 dateTime,以将活动过期为 ISO 8601 编码的日期时间。 |
From |
获取或设置发件人地址。 (继承自 IActivity) |
Id |
获取或设置活动的 iD。 (继承自 IActivity) |
Importance |
获取或设置活动有效值的重要性为“low”、“normal”和“high”。 默认值为“normal.”。 |
InputHint |
获取或设置指示机器人是接受、期望还是忽略输入。 |
Locale |
获取或设置 Text 字段的语言代码。 |
LocalTimestamp |
获取或设置以 ISO-8601 格式表示的消息的本地日期和时间。 例如,2016-09-23T13:07:49.4714686-07:00。 (继承自 IActivity) |
Recipient |
获取或设置接收消息的地址。 (继承自 IActivity) |
ReplyToId |
获取或设置此活动要响应的原始 ID。 (继承自 IActivity) |
ServiceUrl |
获取或设置应发送对此活动的响应的服务 URL。 (继承自 IActivity) |
Speak |
获取或设置语音标记(文本转语音的 SSML 标记)。 |
SuggestedActions |
获取或设置 suggestedActions 用于表示与键盘/quickReplies 等卡片交互的操作。 |
Summary |
获取或设置在通道无法呈现卡片时显示的文本。 |
Text |
获取或设置消息的内容。 |
TextFormat |
获取或设置文本字段的格式 [plain|markdown] Default:markdown。 |
Timestamp |
获取或设置发送此消息时的时间戳(UTC)。 (继承自 IActivity) |
Type |
获取或设置活动类型。 (继承自 IActivity) |
Value |
获取或设置与 CardAction 一起提供的值。 |
方法
ApplyConversationReference(ConversationReference, Boolean) |
使用现有聊天引用中的传递信息更新活动。 (继承自 IActivity) |
AsContactRelationUpdateActivity() |
如果这是 contactRelationUpdate 活动,则返回 IContactRelationUpdateActivity,否则返回 null。 (继承自 IActivity) |
AsConversationUpdateActivity() |
如果这是 conversationUpdate 活动,则返回 IConversationUpdateActivity,否则返回 null。 (继承自 IActivity) |
AsEndOfConversationActivity() |
如果这是会话结束活动,则返回 IEndOfConversationActivity,否则返回 null。 (继承自 IActivity) |
AsEventActivity() |
如果这是事件活动,则返回 IEventActivity;否则返回 null。 (继承自 IActivity) |
AsInstallationUpdateActivity() |
如果这是 installationUpdate 活动,则返回 IInstallationUpdateActivity,否则返回 null。 (继承自 IActivity) |
AsInvokeActivity() |
如果这是调用活动,则返回 IInvokeActivity;否则返回 null。 (继承自 IActivity) |
AsMessageActivity() |
如果这是消息活动,则返回 IMessageActivity,否则返回 null。 (继承自 IActivity) |
AsMessageDeleteActivity() |
如果这是消息删除活动,则返回 IMessageDeleteActivity,否则返回 null。 (继承自 IActivity) |
AsMessageReactionActivity() |
如果这是消息反应活动,则返回 IMessageDeleteActivity,否则返回 null。 (继承自 IActivity) |
AsMessageUpdateActivity() |
如果这是消息更新活动,则返回 IMessageUpdateActivity,否则返回 null。 (继承自 IActivity) |
AsSuggestionActivity() |
如果这是建议活动,则返回 IMessageDeleteActivity,否则返回 null。 (继承自 IActivity) |
AsTypingActivity() |
如果这是键入活动,则返回 ITypingActivity;否则返回 null。 (继承自 IActivity) |
GetChannelData<TypeT>() |
获取通道数据作为强类型对象。 (继承自 IActivity) |
GetConversationReference() |
从活动获取会话引用。 (继承自 IActivity) |
GetMentions() |
获取提及。 |
HasContent() |
如此 如果此活动具有文本、附件或 channelData。 |
TryGetChannelData<TypeT>(TypeT) |
尝试将 channeldata 作为强类型对象获取。 (继承自 IActivity) |
扩展方法
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) |
设置活动的区域设置。 |