ContactList Class

Definition

Namespace:

Windows.ApplicationModel.Contacts

Represents a list of Contact objects.

public ref class ContactList sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ContactList final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ContactList

Public NotInheritable Class ContactList

Inheritance

Object Platform::Object IInspectable ContactList

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities	contactsSystem

Remarks

Call ContactStore.CreateContactListAsync to create a new instance of this class.

Version history

Windows version	SDK version	Value added
1607	14393	RegisterSyncManagerAsync
1607	14393	SyncConstraints
1709	16299	GetChangeTracker
1709	16299	LimitedWriteOperations

Properties

ChangeTracker	Gets the app's ContactChangeTracker for this ContactList.
DisplayName	Gets or sets the name of the ContactList, suitable for display in the user interface.
Id	Gets the locally unique identifier for this ContactList.
IsHidden	Gets or sets a Boolean value that indicates whether the ContactList is hidden in the user interface.
LimitedWriteOperations	Gets an object that provides operations that an app can perform on a contact list that it has not created.
OtherAppReadAccess	Gets or sets a value indicating the read access level to this ContactList for other apps on the system.
OtherAppWriteAccess	Gets or sets a value that indicates the write access level to this ContactList for other apps on the system.
SourceDisplayName	Gets the name of the source of the ContactList, suitable for display in the user interface.
SupportsServerSearch	Gets or sets a Boolean value that indicates whether you can search the remote server with this ContactList.
SyncConstraints	Gets the ContactListSyncConstraints which indicates the maximum amount of contact list data that can be synchronized.
SyncManager	Gets the ContactListSyncManager used to communicate with the server.
UserDataAccountId	Gets a string that represents the ID of the user data account for this ContactList.

Methods

DeleteAsync()	Asynchronously deletes this ContactList, including all Contact objects in the ContactStore.
DeleteContactAsync(Contact)	Asynchronously deletes and individual Contact from this ContactList and the ContactStore.
GetChangeTracker(String)	Gets a ContactChangeTracker that provides functionality for monitoring changes to Contact objects in the ContactList.
GetContactAsync(String)	Asynchronously retrieves the specified Contact object from the ContactList.
GetContactFromRemoteIdAsync(String)	Asynchronously gets the Contact identified by the specified RemoteId.
GetContactReader()	Gets a ContactReader object associated with this ContactList.
GetContactReader(ContactQueryOptions)	Gets a ContactReader object associated with this ContactList and using the specified ContactQueryOptions.
GetMeContactAsync()	Asynchronously gets the Contact object that represents the current user.
RegisterSyncManagerAsync()	Adds a SyncManager to the ContactList.
SaveAsync()	Asynchronously saves this ContactList.
SaveContactAsync(Contact)	Asynchronously saves the specified Contact to the ContactStore.

Events

ContactChanged

Occurs when a Contact in this ContactList has been changed.