ChatMessageStore 类

定义

命名空间:

Windows.ApplicationModel.Chat

提供用于读取、管理和发送消息的方法和属性。 应用程序使用静态 ChatMessageManager 类获取对消息存储的访问权限。

public ref class ChatMessageStore sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ChatMessageStore final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ChatMessageStore

Public NotInheritable Class ChatMessageStore

继承

Object Platform::Object IInspectable ChatMessageStore

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)
应用功能	chat chatSystem smsSend

注解

通过调用 RequestStoreAsync 获取此类的实例。

版本历史记录

Windows 版本	SDK 版本	已添加值
1607	14393	GetMessageBySyncIdAsync

属性

ChangeTracker

获取消息存储的 ChatMessageChangeTracker 类 对象。 消息更改跟踪器允许应用程序监视对消息存储中消息的更改。

方法

DeleteMessageAsync(String)	从聊天消息存储中删除消息。
DownloadMessageAsync(String)	将标识符指定的消息下载到消息存储。
ForwardMessageAsync(String, IIterable<String>)	将指定的邮件异步转发给新收件人。
GetConversationAsync(String)	按 ID 异步获取 ChatConversation 。
GetConversationAsync(String, IIterable<String>)	使用指定的传输按 ID 异步获取 ChatConversation 。
GetConversationFromThreadingInfoAsync(ChatConversationThreadingInfo)	异步获取基于线程信息对象的会话。
GetConversationReader()	获取消息存储的新 或现有 ChatConversationReader 。
GetConversationReader(IIterable<String>)	使用指定的传输获取消息存储的新或现有 ChatConversationReader 。
GetMessageAsync(String)	从消息存储中检索由标识符指定的消息。
GetMessageByRemoteIdAsync(String, String)	按其远程 ID 获取消息。
GetMessageBySyncIdAsync(String)	按同步 ID 获取消息。
GetMessageReader()	获取 ChatMessageReader 类 对象，该对象提供消息存储中的消息集合。
GetMessageReader(TimeSpan)	获取 ChatMessageReader 类 对象，该对象提供消息存储中的消息集合。 消息集合仅限于提供的时间跨度。
GetSearchReader(ChatQueryOptions)	获取用于搜索消息的新 或现有 ChatSearchReader 。
GetUnseenCountAsync()	异步获取未读聊天消息数。
GetUnseenCountAsync(IIterable<String>)	使用指定的传输异步获取未读聊天消息的数量。
MarkAsSeenAsync()	以异步方式将所有传输消息标记为已看到。
MarkAsSeenAsync(IIterable<String>)	以异步方式将所有传输消息标记为已看到。
MarkMessageReadAsync(String)	将存储中的指定消息标记为已读。
RetrySendMessageAsync(String)	尝试从消息存储区发送指定消息的重试。
SaveMessageAsync(ChatMessage)	异步将消息保存到 ChatMessageStore。
SendMessageAsync(ChatMessage)	尝试发送聊天消息。 消息作为发送操作的一部分保存到消息存储中。
TryCancelDownloadMessageAsync(String)	异步尝试取消下载指定的消息。
TryCancelSendMessageAsync(String)	异步尝试取消发送指定消息。
ValidateMessage(ChatMessage)	检查聊天消息是否有效，并返回验证结果。

事件

MessageChanged	消息存储区中的消息发生更改时发生的事件。
StoreChanged	当 ChatMessageStore 中的某些内容发生更改时发生。