Class AttachmentTypeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AttachmentType resource.

public class AttachmentTypeClient : SingletonResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeResponse>

Inheritance

object

ResourceClient<AttachmentType>

SingletonResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeResponse>

AttachmentTypeClient

Inherited Members

SingletonResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeResponse>.PatchAsync(AttachmentType, CancellationToken)

SingletonResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeResponse>.PatchAsync(JsonApiDocument<AttachmentTypeResource>, CancellationToken)

SingletonResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeResponse>.DeleteAsync(CancellationToken)

ResourceClient<AttachmentType>.AddQueryParameter(string, string)

ResourceClient<AttachmentType>.ReplaceQueryParameter(string, string)

ResourceClient<AttachmentType>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AttachmentType>.Uri

ResourceClient<AttachmentType>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AttachmentTypeClient(HttpClient, Uri)

Client for interacting with the AttachmentType resource.

public AttachmentTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AttachmentTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AttachmentTypeClient

The current AttachmentTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AttachmentTypeClient ClearParameters()

Returns

AttachmentTypeClient

The current AttachmentTypeClient instance.

GetAsync(CancellationToken)

Fetches the AttachmentType resource asynchronously.

public Task<AttachmentTypeResponse> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentTypeResponse>

A task representing the asynchronous operation, containing the AttachmentType resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.