Class ResourceClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Resource resource.

public class ResourceClient : SingletonResourceClient<Resource, ResourceResource, ResourceResponse>

Inheritance

object

ResourceClient<Resource>

SingletonResourceClient<Resource, ResourceResource, ResourceResponse>

ResourceClient

Inherited Members

SingletonResourceClient<Resource, ResourceResource, ResourceResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Resource, ResourceResource, ResourceResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Resource, ResourceResource, ResourceResponse>.PatchAsync(Resource, CancellationToken)

SingletonResourceClient<Resource, ResourceResource, ResourceResponse>.PatchAsync(JsonApiDocument<ResourceResource>, CancellationToken)

SingletonResourceClient<Resource, ResourceResource, ResourceResponse>.DeleteAsync(CancellationToken)

ResourceClient<Resource>.AddQueryParameter(string, string)

ResourceClient<Resource>.ReplaceQueryParameter(string, string)

ResourceClient<Resource>.AddCustomParameter(string, string)

ResourceClient<Resource>.ClearParameters()

ResourceClient<Resource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Resource>.Uri

ResourceClient<Resource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ResourceClient(HttpClient, Uri)

Client for interacting with the Resource resource.

public ResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Conflicts

Associated Conflicts.

public PaginatedConflictClient Conflicts { get; }

Property Value

PaginatedConflictClient

EventResourceRequests

Associated EventResourceRequests.

public PaginatedEventResourceRequestClient EventResourceRequests { get; }

Property Value

PaginatedEventResourceRequestClient

RequiredApprovals

Associated RequiredApprovals.

public PaginatedRequiredApprovalClient RequiredApprovals { get; }

Property Value

PaginatedRequiredApprovalClient

ResourceApprovalGroups

Associated ResourceApprovalGroups.

public PaginatedResourceApprovalGroupClient ResourceApprovalGroups { get; }

Property Value

PaginatedResourceApprovalGroupClient

ResourceBookings

Associated ResourceBookings.

public PaginatedResourceBookingClient ResourceBookings { get; }

Property Value

PaginatedResourceBookingClient

ResourceFolder

Associated ResourceFolder.

public ResourceFolderClient ResourceFolder { get; }

Property Value

ResourceFolderClient

ResourceQuestions

Associated ResourceQuestions.

public PaginatedResourceQuestionClient ResourceQuestions { get; }

Property Value

PaginatedResourceQuestionClient

RoomSetups

Associated RoomSetups.

public PaginatedRoomSetupClient RoomSetups { get; }

Property Value

PaginatedRoomSetupClient

Methods

DeleteAsync(CancellationToken)

Deletes the Resource resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Resource resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeResourceApprovalGroups()

Include related ResourceApprovalGroups resources in the response.

public ResourceClient IncludeResourceApprovalGroups()

Returns

ResourceClient

IncludeResourceFolder()

Include related ResourceFolder resources in the response.

public ResourceClient IncludeResourceFolder()

Returns

ResourceClient

IncludeResourceQuestions()

Include related ResourceQuestions resources in the response.

public ResourceClient IncludeResourceQuestions()

Returns

ResourceClient

IncludeRoomSetups()

Include related RoomSetups resources in the response.

public ResourceClient IncludeRoomSetups()

Returns

ResourceClient

PatchAsync(Resource, CancellationToken)

Updates an existing Resource resource asynchronously.

public Task<ResourceResponse> PatchAsync(Resource resource, CancellationToken cancellationToken = default)

Parameters

resource Resource

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceResponse>

A task representing the asynchronous operation, containing the updated Resource resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ResourceResource>, CancellationToken)

Updates an existing Resource resource asynchronously.

public Task<ResourceResponse> PatchAsync(JsonApiDocument<ResourceResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ResourceResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceResponse>

A task representing the asynchronous operation, containing the updated Resource resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.