ChatMessageReader
ChatMessageReader
ChatMessageReader
ChatMessageReader
Class
Definition
Provides methods for reading messages from the message store.
public : sealed class ChatMessageReader : IChatMessageReader, IChatMessageReader2public sealed class ChatMessageReader : IChatMessageReader, IChatMessageReader2Public NotInheritable Class ChatMessageReader Implements IChatMessageReader, IChatMessageReader2// You can use this class in JavaScript.
- 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 |
blockedChatMessages
|
Methods
ReadBatchAsync() ReadBatchAsync() ReadBatchAsync() ReadBatchAsync()
Returns a batch list of chat messages from the message store.
public : IAsyncOperation<IVectorView<ChatMessage>> ReadBatchAsync()public IAsyncOperation<IReadOnlyList<ChatMessage>> ReadBatchAsync()Public Function ReadBatchAsync() As IAsyncOperation( Of IReadOnlyListChatMessage )// You can use this method in JavaScript.
Returns
IAsyncOperation<IVectorView<ChatMessage>>
IAsyncOperation<IReadOnlyList<ChatMessage>>
IAsyncOperation<IReadOnlyList<ChatMessage>>
IAsyncOperation<IReadOnlyList<ChatMessage>>
An asynchronous operation that returns a list of chat messages upon successful completion.
Additional features and 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 |
blockedChatMessages
|
Remarks
This method returns an IReadOnlyList of ChatMessage class objects. The method is invoked as an IAsyncOperation as shown in the following example:
IReadOnlyList<ChatMessage> msgList = await messageStore.GetMessageReader.ReadBatchAsync();
- See Also
ReadBatchAsync(Int32) ReadBatchAsync(Int32) ReadBatchAsync(Int32) ReadBatchAsync(Int32)
Returns a batch list of chat messages from the message store limited to the specified size.
public : IAsyncOperation<IVectorView<ChatMessage>> ReadBatchAsync(int count)public IAsyncOperation<IReadOnlyList<ChatMessage>> ReadBatchAsync(Int32 count)Public Function ReadBatchAsync(count As Int32) As IAsyncOperation( Of IReadOnlyListChatMessage )// You can use this method in JavaScript.
Parameters
- count
- int Int32 Int32 Int32
The size of the batch to read.
Returns
IAsyncOperation<IVectorView<ChatMessage>>
IAsyncOperation<IReadOnlyList<ChatMessage>>
IAsyncOperation<IReadOnlyList<ChatMessage>>
IAsyncOperation<IReadOnlyList<ChatMessage>>
An asynchronous operation that returns a list of chat messages upon successful completion.
Additional features and 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 |
blockedChatMessages
|
- See Also