Interface IContactFieldResource

Namespace

Mailtrap.ContactFields

Assembly

Mailtrap.Abstractions.dll

Represents Contact Field resource.

public interface IContactFieldResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Deletes a contact field, represented by the current resource instance.

Task Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task

Nothing is returned upon successful deletion.

Remarks

After deletion of the contact field, represented by the current resource instance, it will no longer be available.
Thus any further operations on it will result in an error.

GetDetails(CancellationToken)

Gets details of the contact field, represented by the current resource instance.

Task<ContactField> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<ContactField>

Requested contact field details.

Update(UpdateContactFieldRequest, CancellationToken)

Updates the contact field, represented by the current resource instance, with details specified by request.

Task<ContactField> Update(UpdateContactFieldRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateContactFieldRequest

Contact field details for update.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<ContactField>

Updated contact field details.