ContactListSyncManager ContactListSyncManager ContactListSyncManager ContactListSyncManager Class

Definition

Provides functionality for syncing contact information with the server.

public : sealed class ContactListSyncManager : IContactListSyncManager, IContactListSyncManager2
public sealed class ContactListSyncManager : IContactListSyncManager, IContactListSyncManager2
Public NotInheritable Class ContactListSyncManager Implements IContactListSyncManager, IContactListSyncManager2
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
contactsSystem

Properties

LastAttemptedSyncTime LastAttemptedSyncTime LastAttemptedSyncTime LastAttemptedSyncTime

Gets or sets the last time a sync was attempted with the server.

public : DateTime LastAttemptedSyncTime { get; set; }
public DateTimeOffset LastAttemptedSyncTime { get; set; }
Public ReadWrite Property LastAttemptedSyncTime As DateTimeOffset
var dateTimeOffset = contactListSyncManager.lastAttemptedSyncTime;
contactListSyncManager.lastAttemptedSyncTime = dateTimeOffset;
Value
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The last time a sync was attempted with the server.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
contactsSystem

LastSuccessfulSyncTime LastSuccessfulSyncTime LastSuccessfulSyncTime LastSuccessfulSyncTime

Gets or sets the last time the ContactList was successfully synced with the server.

public : DateTime LastSuccessfulSyncTime { get; set; }
public DateTimeOffset LastSuccessfulSyncTime { get; set; }
Public ReadWrite Property LastSuccessfulSyncTime As DateTimeOffset
var dateTimeOffset = contactListSyncManager.lastSuccessfulSyncTime;
contactListSyncManager.lastSuccessfulSyncTime = dateTimeOffset;
Value
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The last time the ContactList was successfully synced with the server.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
contactsSystem

Status Status Status Status

Gets or sets the ContactListSyncStatus.

public : ContactListSyncStatus Status { get; set; }
public ContactListSyncStatus Status { get; set; }
Public ReadWrite Property Status As ContactListSyncStatus
var contactListSyncStatus = contactListSyncManager.status;
contactListSyncManager.status = contactListSyncStatus;
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
contactsSystem

Methods

SyncAsync() SyncAsync() SyncAsync() SyncAsync()

Asynchronously attempts to sync with the contacts server.

public : IAsyncOperation<Platform::Boolean> SyncAsync()
public IAsyncOperation<bool> SyncAsync()
Public Function SyncAsync() As IAsyncOperation( Of bool )
Windows.ApplicationModel.Contacts.ContactListSyncManager.syncAsync().done( /* Your success and error handlers */ );
Returns

A Boolean value indicating if the sync was successful.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
contactsSystem

Events

SyncStatusChanged SyncStatusChanged SyncStatusChanged SyncStatusChanged

Occurs when the sync status with the server has changed.

public : event TypedEventHandler SyncStatusChanged<ContactListSyncManager, object>
public event TypedEventHandler SyncStatusChanged<ContactListSyncManager, object>
Public Event TypedEventHandler SyncStatusChanged( Of ( Of ContactListSyncManager ), ( Of object ))
function onSyncStatusChanged(eventArgs){/* Your code */}


contactListSyncManager.addEventListener("syncStatusChanged", onSyncStatusChanged);
contactListSyncManager.removeEventListener("syncStatusChanged", onSyncStatusChanged);
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
contactsSystem