Class ResourceApprovalGroupClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ResourceApprovalGroup resource.

public class ResourceApprovalGroupClient : SingletonResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupResponse>

Inheritance

object

ResourceClient<ResourceApprovalGroup>

SingletonResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupResponse>

ResourceApprovalGroupClient

Inherited Members

SingletonResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupResponse>.PatchAsync(ResourceApprovalGroup, CancellationToken)

SingletonResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupResponse>.PatchAsync(JsonApiDocument<ResourceApprovalGroupResource>, CancellationToken)

SingletonResourceClient<ResourceApprovalGroup, ResourceApprovalGroupResource, ResourceApprovalGroupResponse>.DeleteAsync(CancellationToken)

ResourceClient<ResourceApprovalGroup>.AddQueryParameter(string, string)

ResourceClient<ResourceApprovalGroup>.ReplaceQueryParameter(string, string)

ResourceClient<ResourceApprovalGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ResourceApprovalGroup>.Uri

ResourceClient<ResourceApprovalGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ResourceApprovalGroupClient(HttpClient, Uri)

Client for interacting with the ResourceApprovalGroup resource.

public ResourceApprovalGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

EventResourceRequests

Associated EventResourceRequests.

public PaginatedEventResourceRequestClient EventResourceRequests { get; }

Property Value

PaginatedEventResourceRequestClient

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

RequiredApprovals

Associated RequiredApprovals.

public PaginatedRequiredApprovalClient RequiredApprovals { get; }

Property Value

PaginatedRequiredApprovalClient

Resources

Associated Resources.

public PaginatedResourceClient Resources { get; }

Property Value

PaginatedResourceClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ResourceApprovalGroupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ResourceApprovalGroupClient

The current ResourceApprovalGroupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ResourceApprovalGroupClient ClearParameters()

Returns

ResourceApprovalGroupClient

The current ResourceApprovalGroupClient instance.

GetAsync(CancellationToken)

Fetches the ResourceApprovalGroup resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceApprovalGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePeople()

Include related People resources in the response.

public ResourceApprovalGroupClient IncludePeople()

Returns

ResourceApprovalGroupClient

IncludeResources()

Include related Resources resources in the response.

public ResourceApprovalGroupClient IncludeResources()

Returns

ResourceApprovalGroupClient