Method EraseAsync
- Namespace
- MailFathom.Application.Contacts
- Assembly
- MailFathom.Application.dll
EraseAsync(ContactId, CancellationToken)
Erases one person and everything the book derived from them.
public Task<ContactErasure> EraseAsync(ContactId contactId, CancellationToken cancellationToken)
Parameters
contactIdContactIdThe contact to erase.
cancellationTokenCancellationTokenCancels the erasure.
Returns
- Task<ContactErasure>
What the erasure removed, including a book that held no such contact.
Remarks
The data-subject erasure path, so it removes rather than marks and no origin gates it: somebody asking to be taken out of a contact book is not answered with which half of the book they happen to be in. That is also why a caller may erase a contact it could not have amended.
Exceptions
- PrincipalNotAuthorizedException
Thrown when the caller does not hold the writing grant.