Class ContributorClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Contributor resource.

public class ContributorClient : SingletonResourceClient<Contributor, ContributorResource, ContributorResponse>

Inheritance

object

ResourceClient<Contributor>

SingletonResourceClient<Contributor, ContributorResource, ContributorResponse>

ContributorClient

Inherited Members

SingletonResourceClient<Contributor, ContributorResource, ContributorResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Contributor, ContributorResource, ContributorResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Contributor, ContributorResource, ContributorResponse>.PatchAsync(Contributor, CancellationToken)

SingletonResourceClient<Contributor, ContributorResource, ContributorResponse>.PatchAsync(JsonApiDocument<ContributorResource>, CancellationToken)

SingletonResourceClient<Contributor, ContributorResource, ContributorResponse>.DeleteAsync(CancellationToken)

ResourceClient<Contributor>.AddQueryParameter(string, string)

ResourceClient<Contributor>.ReplaceQueryParameter(string, string)

ResourceClient<Contributor>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Contributor>.Uri

ResourceClient<Contributor>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ContributorClient(HttpClient, Uri)

Client for interacting with the Contributor resource.

public ContributorClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ContributorClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ContributorClient

The current ContributorClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ContributorClient ClearParameters()

Returns

ContributorClient

The current ContributorClient instance.

GetAsync(CancellationToken)

Fetches the Contributor resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ContributorResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.