ContactDataProviderConnection ContactDataProviderConnection ContactDataProviderConnection ContactDataProviderConnection Class

Definition

Represents a connection to a data provider client.

public : sealed class ContactDataProviderConnection : IContactDataProviderConnection
public sealed class ContactDataProviderConnection : IContactDataProviderConnection
Public NotInheritable Class ContactDataProviderConnection Implements IContactDataProviderConnection
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
contactsSystem

Remarks

Use the instance of this class provided by the Connection property of the ContactDataProviderTriggerDetails object passed to your background task on activation.

Methods

Start() Start() Start() Start()

Call this method to indicate that all event handlers have been set and the data provider is ready to start handling requests.

public : void Start()
public void Start()
Public Function Start() As void
contactDataProviderConnection.start();
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
contactsSystem

Events

CreateOrUpdateContactRequested CreateOrUpdateContactRequested CreateOrUpdateContactRequested CreateOrUpdateContactRequested

Raised when the client app attempts to create or update a contact.

public : event TypedEventHandler CreateOrUpdateContactRequested<ContactDataProviderConnection, ContactListCreateOrUpdateContactRequestEventArgs>
public event TypedEventHandler CreateOrUpdateContactRequested<ContactDataProviderConnection, ContactListCreateOrUpdateContactRequestEventArgs>
Public Event TypedEventHandler CreateOrUpdateContactRequested( Of ( Of ContactDataProviderConnection ), ( Of ContactListCreateOrUpdateContactRequestEventArgs ))
function onCreateOrUpdateContactRequested(eventArgs){/* Your code */}


contactDataProviderConnection.addEventListener("createOrUpdateContactRequested", onCreateOrUpdateContactRequested);
contactDataProviderConnection.removeEventListener("createOrUpdateContactRequested", onCreateOrUpdateContactRequested);
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)
Capabilities
contactsSystem

DeleteContactRequested DeleteContactRequested DeleteContactRequested DeleteContactRequested

Raised when the client app attempts to delete a contact.

public : event TypedEventHandler DeleteContactRequested<ContactDataProviderConnection, ContactListDeleteContactRequestEventArgs>
public event TypedEventHandler DeleteContactRequested<ContactDataProviderConnection, ContactListDeleteContactRequestEventArgs>
Public Event TypedEventHandler DeleteContactRequested( Of ( Of ContactDataProviderConnection ), ( Of ContactListDeleteContactRequestEventArgs ))
function onDeleteContactRequested(eventArgs){/* Your code */}


contactDataProviderConnection.addEventListener("deleteContactRequested", onDeleteContactRequested);
contactDataProviderConnection.removeEventListener("deleteContactRequested", onDeleteContactRequested);
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)
Capabilities
contactsSystem

ServerSearchReadBatchRequested ServerSearchReadBatchRequested ServerSearchReadBatchRequested ServerSearchReadBatchRequested

Occurs when the contact data client has requested a batch of server-side search results.

public : event TypedEventHandler ServerSearchReadBatchRequested<ContactDataProviderConnection, ContactListServerSearchReadBatchRequestEventArgs>
public event TypedEventHandler ServerSearchReadBatchRequested<ContactDataProviderConnection, ContactListServerSearchReadBatchRequestEventArgs>
Public Event TypedEventHandler ServerSearchReadBatchRequested( Of ( Of ContactDataProviderConnection ), ( Of ContactListServerSearchReadBatchRequestEventArgs ))
function onServerSearchReadBatchRequested(eventArgs){/* Your code */}


contactDataProviderConnection.addEventListener("serverSearchReadBatchRequested", onServerSearchReadBatchRequested);
contactDataProviderConnection.removeEventListener("serverSearchReadBatchRequested", onServerSearchReadBatchRequested);
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
contactsSystem

SyncRequested SyncRequested SyncRequested SyncRequested

Occurs when the contact data client has requested to sync a contact list with the server..

public : event TypedEventHandler SyncRequested<ContactDataProviderConnection, ContactListSyncManagerSyncRequestEventArgs>
public event TypedEventHandler SyncRequested<ContactDataProviderConnection, ContactListSyncManagerSyncRequestEventArgs>
Public Event TypedEventHandler SyncRequested( Of ( Of ContactDataProviderConnection ), ( Of ContactListSyncManagerSyncRequestEventArgs ))
function onSyncRequested(eventArgs){/* Your code */}


contactDataProviderConnection.addEventListener("syncRequested", onSyncRequested);
contactDataProviderConnection.removeEventListener("syncRequested", onSyncRequested);
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
contactsSystem