Method ReadPageAsync

Namespace

MailFathom.Application.Contacts

Assembly

MailFathom.Application.dll

ReadPageAsync(ContactQuery, CancellationToken)

Reads one bounded page of the book.

public Task<ContactPage> ReadPageAsync(ContactQuery query, CancellationToken cancellationToken)

Parameters

query ContactQuery

Which part of the book, how large a page, and where to continue from.

cancellationToken CancellationToken

Cancels the read.

Returns

Task<ContactPage>

The page, and the cursor the following one is asked with.

Remarks

The page is bounded by the query the caller composed, which is where the ceiling on how much of a person's correspondents leaves the database at once already lives.

Exceptions

ArgumentNullException

Thrown when query is null.

PrincipalNotAuthorizedException

Thrown when the read was reached by anything but a caller granted AdminAuditRead.