ContactListServerSearchReadBatchRequest Class

Reference

Definition

Namespace:: Windows.ApplicationModel.Contacts.DataProvider

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Details of a request to read a batch of server-side search results.

public ref class ContactListServerSearchReadBatchRequest sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ContactListServerSearchReadBatchRequest final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ContactListServerSearchReadBatchRequest

Public NotInheritable Class ContactListServerSearchReadBatchRequest

Inheritance: Object Platform::Object IInspectable ContactListServerSearchReadBatchRequest

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v3.0)
App capabilities	contactsSystem

Remarks

Used in your ServerSearchReadBatchRequested event handler. Use the instance of this class that's returned by the ContactListServerSearchReadBatchRequestEventArgs.Request property.

Properties

ContactListId	Gets the contact list ID of the contact list to be searched.
Options	Gets the search options to be applied in this search.
SessionId	Gets the search session ID of this batch read request.
SuggestedBatchSize	Gets the suggested batch size for the server-side search batch read.

Methods

ReportCompletedAsync()

Informs the client app that the request was processed successfully.

ReportFailedAsync(ContactBatchStatus)

Informs the client that the request was not processed successfully.

SaveContactAsync(Contact)

Asynchronously saves a contact that meets server-side search criteria.

When a server-side search is requested, the data provider performs the search, calls SaveContactAsync on each contact found, and then calls ReportCompletedAsync.

Applies to

Share via