ChatSyncManager
ChatSyncManager
ChatSyncManager
ChatSyncManager
Class
Definition
Manages the syncing of chat messages.
public : sealed class ChatSyncManager : IChatSyncManagerpublic sealed class ChatSyncManager : IChatSyncManagerPublic NotInheritable Class ChatSyncManager Implements IChatSyncManager// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
This class is retrieved by calling RequestSyncManagerAsync.
Properties
Configuration Configuration Configuration Configuration
The configuration properties of the sync manager.
public : ChatSyncConfiguration Configuration { get; }public ChatSyncConfiguration Configuration { get; }Public ReadOnly Property Configuration As ChatSyncConfiguration// You can use this property in JavaScript.
Gets the configuration properties of the sync manager.
Methods
AssociateAccountAsync(WebAccount) AssociateAccountAsync(WebAccount) AssociateAccountAsync(WebAccount) AssociateAccountAsync(WebAccount)
Sets the WebAccount, which will be used by the sync manager to sync messages.
public : IAsyncAction AssociateAccountAsync(WebAccount webAccount)public IAsyncAction AssociateAccountAsync(WebAccount webAccount)Public Function AssociateAccountAsync(webAccount As WebAccount) As IAsyncAction// You can use this method in JavaScript.
- webAccount
- WebAccount WebAccount WebAccount WebAccount
The web account.
An asynchronous action that doesn't return anything.
IsAccountAssociated(WebAccount) IsAccountAssociated(WebAccount) IsAccountAssociated(WebAccount) IsAccountAssociated(WebAccount)
Checks if a specific WebAccount is the account used by the sync manager to sync messages.
public : PlatForm::Boolean IsAccountAssociated(WebAccount webAccount)public bool IsAccountAssociated(WebAccount webAccount)Public Function IsAccountAssociated(webAccount As WebAccount) As bool// You can use this method in JavaScript.
- webAccount
- WebAccount WebAccount WebAccount WebAccount
The web account.
True if the WebAccount is the account used by the sync manager to sync message, false otherwise.
SetConfigurationAsync(ChatSyncConfiguration) SetConfigurationAsync(ChatSyncConfiguration) SetConfigurationAsync(ChatSyncConfiguration) SetConfigurationAsync(ChatSyncConfiguration)
Sets the configuration properties of the sync manager.
public : IAsyncAction SetConfigurationAsync(ChatSyncConfiguration configuration)public IAsyncAction SetConfigurationAsync(ChatSyncConfiguration configuration)Public Function SetConfigurationAsync(configuration As ChatSyncConfiguration) As IAsyncAction// You can use this method in JavaScript.
- configuration
- ChatSyncConfiguration ChatSyncConfiguration ChatSyncConfiguration ChatSyncConfiguration
The configuration.
An asynchronous action that doesn't return anything.
StartSync() StartSync() StartSync() StartSync()
Starts a new sync operation without waiting for the sync to finish.
public : void StartSync()public void StartSync()Public Function StartSync() As void// You can use this method in JavaScript.
UnassociateAccountAsync() UnassociateAccountAsync() UnassociateAccountAsync() UnassociateAccountAsync()
Clears the account information and stops the sync manager from syncing messages. This will trigger a message deletion operation.
public : IAsyncAction UnassociateAccountAsync()public IAsyncAction UnassociateAccountAsync()Public Function UnassociateAccountAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous action that doesn't return anything.