ChatMessageStore ChatMessageStore ChatMessageStore ChatMessageStore ChatMessageStore Class

Definition

Provides the methods and properties to read, manage and send messages. An application gets access to the message store using the static ChatMessageManager class.

public : sealed class ChatMessageStore
struct winrt::Windows::ApplicationModel::Chat::ChatMessageStore
public sealed class ChatMessageStore
Public NotInheritable Class ChatMessageStore
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
chat smsSend chatSystem

Remarks

Obtain an instance of this class by calling RequestStoreAsync.

Version history

Windows version SDK version Value added
1607 14393 GetMessageBySyncIdAsync

Properties

ChangeTracker ChangeTracker ChangeTracker ChangeTracker ChangeTracker

Gets a ChatMessageChangeTracker class object for the message store. A message change tracker allows an application to monitor changes to messages in the message store.

Methods

DeleteMessageAsync(String) DeleteMessageAsync(String) DeleteMessageAsync(String) DeleteMessageAsync(String) DeleteMessageAsync(String)

Deletes a message from the chat message store.

DownloadMessageAsync(String) DownloadMessageAsync(String) DownloadMessageAsync(String) DownloadMessageAsync(String) DownloadMessageAsync(String)

Downloads a message specified by the identifier to the message store.

ForwardMessageAsync(String, IIterable<String>) ForwardMessageAsync(String, IIterable<String>) ForwardMessageAsync(String, IIterable<String>) ForwardMessageAsync(String, IIterable<String>) ForwardMessageAsync(String, IIterable<String>)

Asynchronously forwards the specified message to new recipients.

GetConversationAsync(String) GetConversationAsync(String) GetConversationAsync(String) GetConversationAsync(String) GetConversationAsync(String)

Asynchronously gets a ChatConversation by ID.

GetConversationAsync(String, IIterable<String>) GetConversationAsync(String, IIterable<String>) GetConversationAsync(String, IIterable<String>) GetConversationAsync(String, IIterable<String>) GetConversationAsync(String, IIterable<String>)

Asynchronously gets a ChatConversation by ID using the specified transports.

GetConversationFromThreadingInfoAsync(ChatConversationThreadingInfo) GetConversationFromThreadingInfoAsync(ChatConversationThreadingInfo) GetConversationFromThreadingInfoAsync(ChatConversationThreadingInfo) GetConversationFromThreadingInfoAsync(ChatConversationThreadingInfo) GetConversationFromThreadingInfoAsync(ChatConversationThreadingInfo)

Asynchronously gets a conversation based on a threading info object.

GetConversationReader() GetConversationReader() GetConversationReader() GetConversationReader() GetConversationReader()

Gets a new or existing ChatConversationReader for the message store.

GetConversationReader(IIterable<String>) GetConversationReader(IIterable<String>) GetConversationReader(IIterable<String>) GetConversationReader(IIterable<String>) GetConversationReader(IIterable<String>)

Gets a new or existing ChatConversationReader for the message store using the specified transports.

GetMessageAsync(String) GetMessageAsync(String) GetMessageAsync(String) GetMessageAsync(String) GetMessageAsync(String)

Retrieves a message specified by an identifier from the message store.

GetMessageByRemoteIdAsync(String, String) GetMessageByRemoteIdAsync(String, String) GetMessageByRemoteIdAsync(String, String) GetMessageByRemoteIdAsync(String, String) GetMessageByRemoteIdAsync(String, String)

Gets a message by its remote ID.

GetMessageBySyncIdAsync(String) GetMessageBySyncIdAsync(String) GetMessageBySyncIdAsync(String) GetMessageBySyncIdAsync(String) GetMessageBySyncIdAsync(String)

Gets a message by the sync ID.

GetMessageReader() GetMessageReader() GetMessageReader() GetMessageReader() GetMessageReader()

Gets a ChatMessageReader class object which provides a message collection from the message store.

GetMessageReader(TimeSpan) GetMessageReader(TimeSpan) GetMessageReader(TimeSpan) GetMessageReader(TimeSpan) GetMessageReader(TimeSpan)

Gets a ChatMessageReader class object which provides a message collection from the message store. The collection of messages is limited to the time span provided.

GetSearchReader(ChatQueryOptions) GetSearchReader(ChatQueryOptions) GetSearchReader(ChatQueryOptions) GetSearchReader(ChatQueryOptions) GetSearchReader(ChatQueryOptions)

Gets a new or existing ChatSearchReader to be used to search for messages.

GetUnseenCountAsync() GetUnseenCountAsync() GetUnseenCountAsync() GetUnseenCountAsync() GetUnseenCountAsync()

Asynchronously gets the number of unread chat messages.

GetUnseenCountAsync(IIterable<String>) GetUnseenCountAsync(IIterable<String>) GetUnseenCountAsync(IIterable<String>) GetUnseenCountAsync(IIterable<String>) GetUnseenCountAsync(IIterable<String>)

Asynchronously gets the number of unread chat messages using the specified transports.

MarkAsSeenAsync() MarkAsSeenAsync() MarkAsSeenAsync() MarkAsSeenAsync() MarkAsSeenAsync()

Asynchronously marks all transport messages as seen.

MarkAsSeenAsync(IIterable<String>) MarkAsSeenAsync(IIterable<String>) MarkAsSeenAsync(IIterable<String>) MarkAsSeenAsync(IIterable<String>) MarkAsSeenAsync(IIterable<String>)

Asynchronously marks all transport messages as seen.

MarkMessageReadAsync(String) MarkMessageReadAsync(String) MarkMessageReadAsync(String) MarkMessageReadAsync(String) MarkMessageReadAsync(String)

Marks a specified message in the store as already read.

RetrySendMessageAsync(String) RetrySendMessageAsync(String) RetrySendMessageAsync(String) RetrySendMessageAsync(String) RetrySendMessageAsync(String)

Attempts a retry of sending a specified message from the message store.

SaveMessageAsync(ChatMessage) SaveMessageAsync(ChatMessage) SaveMessageAsync(ChatMessage) SaveMessageAsync(ChatMessage) SaveMessageAsync(ChatMessage)

Asynchronously saves a message to the ChatMessageStore.

SendMessageAsync(ChatMessage) SendMessageAsync(ChatMessage) SendMessageAsync(ChatMessage) SendMessageAsync(ChatMessage) SendMessageAsync(ChatMessage)

Attempts to send a chat message. The message is saved to the message store as part of the send operation.

TryCancelDownloadMessageAsync(String) TryCancelDownloadMessageAsync(String) TryCancelDownloadMessageAsync(String) TryCancelDownloadMessageAsync(String) TryCancelDownloadMessageAsync(String)

Asynchronously attempts to cancel downloading the specified message.

TryCancelSendMessageAsync(String) TryCancelSendMessageAsync(String) TryCancelSendMessageAsync(String) TryCancelSendMessageAsync(String) TryCancelSendMessageAsync(String)

Asynchronously attempts to cancel sending the specified message.

ValidateMessage(ChatMessage) ValidateMessage(ChatMessage) ValidateMessage(ChatMessage) ValidateMessage(ChatMessage) ValidateMessage(ChatMessage)

Checks if a chat message is valid and returns the validation result.

Events

MessageChanged MessageChanged MessageChanged MessageChanged MessageChanged

An event that occurs when a message in the message store is changed.

StoreChanged StoreChanged StoreChanged StoreChanged StoreChanged

Occurs when something in the ChatMessageStore has changed.