ContactListServerSearchReadBatchRequest ContactListServerSearchReadBatchRequest ContactListServerSearchReadBatchRequest ContactListServerSearchReadBatchRequest Class

Definition

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

public : sealed class ContactListServerSearchReadBatchRequest : IContactListServerSearchReadBatchRequestpublic sealed class ContactListServerSearchReadBatchRequest : IContactListServerSearchReadBatchRequestPublic NotInheritable Class ContactListServerSearchReadBatchRequest Implements IContactListServerSearchReadBatchRequest// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

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

Properties

ContactListId ContactListId ContactListId ContactListId

Gets the contact list ID of the contact list to be searched.

public : PlatForm::String ContactListId { get; }public string ContactListId { get; }Public ReadOnly Property ContactListId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

A contact list ID.

Options Options Options Options

Gets the search options to be applied in this search.

public : ContactQueryOptions Options { get; }public ContactQueryOptions Options { get; }Public ReadOnly Property Options As ContactQueryOptions// You can use this property in JavaScript.

SessionId SessionId SessionId SessionId

Gets the search session ID of this batch read request.

public : PlatForm::String SessionId { get; }public string SessionId { get; }Public ReadOnly Property SessionId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

A search session ID.

SuggestedBatchSize SuggestedBatchSize SuggestedBatchSize SuggestedBatchSize

Gets the suggested batch size for the server-side search batch read.

public : unsigned int SuggestedBatchSize { get; }public uint SuggestedBatchSize { get; }Public ReadOnly Property SuggestedBatchSize As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The suggested number of contacts in a batch.

Methods

ReportCompletedAsync() ReportCompletedAsync() ReportCompletedAsync() ReportCompletedAsync()

Informs the client app that the request was processed successfully.

public : IAsyncAction ReportCompletedAsync()public IAsyncAction ReportCompletedAsync()Public Function ReportCompletedAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

An asynchronous batch read request operation.

ReportFailedAsync(ContactBatchStatus) ReportFailedAsync(ContactBatchStatus) ReportFailedAsync(ContactBatchStatus) ReportFailedAsync(ContactBatchStatus)

Informs the client that the request was not processed successfully.

public : IAsyncAction ReportFailedAsync(ContactBatchStatus batchStatus)public IAsyncAction ReportFailedAsync(ContactBatchStatus batchStatus)Public Function ReportFailedAsync(batchStatus As ContactBatchStatus) As IAsyncAction// You can use this method in JavaScript.
Parameters
batchStatus
ContactBatchStatus ContactBatchStatus ContactBatchStatus ContactBatchStatus

A ContactBatchStatus value describing the reason for the failure.

Returns

An asynchronous batch read request operation.

SaveContactAsync(Contact) SaveContactAsync(Contact) SaveContactAsync(Contact) 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.

public : IAsyncAction SaveContactAsync(Contact contact)public IAsyncAction SaveContactAsync(Contact contact)Public Function SaveContactAsync(contact As Contact) As IAsyncAction// You can use this method in JavaScript.
Parameters
contact
Contact Contact Contact Contact

A Contact that meets the search criteria.

Returns

An asynchronous contact save operation.