Class RequiredApprovalClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the RequiredApproval resource.

public class RequiredApprovalClient : SingletonResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalResponse>

Inheritance

object

ResourceClient<RequiredApproval>

SingletonResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalResponse>

RequiredApprovalClient

Inherited Members

SingletonResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalResponse>.GetAsync(CancellationToken)

SingletonResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalResponse>.PatchAsync(RequiredApproval, CancellationToken)

SingletonResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalResponse>.PatchAsync(JsonApiDocument<RequiredApprovalResource>, CancellationToken)

SingletonResourceClient<RequiredApproval, RequiredApprovalResource, RequiredApprovalResponse>.DeleteAsync(CancellationToken)

ResourceClient<RequiredApproval>.AddQueryParameter(string, string)

ResourceClient<RequiredApproval>.ReplaceQueryParameter(string, string)

ResourceClient<RequiredApproval>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RequiredApproval>.Uri

ResourceClient<RequiredApproval>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RequiredApprovalClient(HttpClient, Uri)

Client for interacting with the RequiredApproval resource.

public RequiredApprovalClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Resource

Associated Resource.

public ResourceClient Resource { get; }

Property Value

ResourceClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public RequiredApprovalClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

RequiredApprovalClient

The current RequiredApprovalClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public RequiredApprovalClient ClearParameters()

Returns

RequiredApprovalClient

The current RequiredApprovalClient instance.

GetAsync(CancellationToken)

Fetches the RequiredApproval resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RequiredApprovalResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeResource()

Include related Resource resources in the response.

public RequiredApprovalClient IncludeResource()

Returns

RequiredApprovalClient