Class ContainingResourceClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ContainingResource resource.

public class ContainingResourceClient : SingletonResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceResponse>

Inheritance

object

ResourceClient<ContainingResource>

SingletonResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceResponse>

ContainingResourceClient

Inherited Members

SingletonResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceResponse>.PatchAsync(ContainingResource, CancellationToken)

SingletonResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceResponse>.PatchAsync(JsonApiDocument<ContainingResourceResource>, CancellationToken)

SingletonResourceClient<ContainingResource, ContainingResourceResource, ContainingResourceResponse>.DeleteAsync(CancellationToken)

ResourceClient<ContainingResource>.AddQueryParameter(string, string)

ResourceClient<ContainingResource>.ReplaceQueryParameter(string, string)

ResourceClient<ContainingResource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ContainingResource>.Uri

ResourceClient<ContainingResource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ContainingResourceClient(HttpClient, Uri)

Client for interacting with the ContainingResource resource.

public ContainingResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ContainingResourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ContainingResourceClient

The current ContainingResourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ContainingResourceClient ClearParameters()

Returns

ContainingResourceClient

The current ContainingResourceClient instance.

GetAsync(CancellationToken)

Fetches the ContainingResource resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ContainingResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.