Class ResourceFolderClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ResourceFolder resource.

public class ResourceFolderClient : SingletonResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderResponse>

Inheritance

object

ResourceClient<ResourceFolder>

SingletonResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderResponse>

ResourceFolderClient

Inherited Members

SingletonResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderResponse>.PatchAsync(ResourceFolder, CancellationToken)

SingletonResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderResponse>.PatchAsync(JsonApiDocument<ResourceFolderResource>, CancellationToken)

SingletonResourceClient<ResourceFolder, ResourceFolderResource, ResourceFolderResponse>.DeleteAsync(CancellationToken)

ResourceClient<ResourceFolder>.AddQueryParameter(string, string)

ResourceClient<ResourceFolder>.ReplaceQueryParameter(string, string)

ResourceClient<ResourceFolder>.AddCustomParameter(string, string)

ResourceClient<ResourceFolder>.ClearParameters()

ResourceClient<ResourceFolder>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ResourceFolder>.Uri

ResourceClient<ResourceFolder>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ResourceFolderClient(HttpClient, Uri)

Client for interacting with the ResourceFolder resource.

public ResourceFolderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Resources

Associated Resources.

public PaginatedResourceClient Resources { get; }

Property Value

PaginatedResourceClient

Methods

DeleteAsync(CancellationToken)

Deletes the ResourceFolder 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 ResourceFolder resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceFolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeResources()

Include related Resources resources in the response.

public ResourceFolderClient IncludeResources()

Returns

ResourceFolderClient

PatchAsync(ResourceFolder, CancellationToken)

Updates an existing ResourceFolder resource asynchronously.

public Task<ResourceFolderResponse> PatchAsync(ResourceFolder resource, CancellationToken cancellationToken = default)

Parameters

resource ResourceFolder

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceFolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ResourceFolderResource>, CancellationToken)

Updates an existing ResourceFolder resource asynchronously.

public Task<ResourceFolderResponse> PatchAsync(JsonApiDocument<ResourceFolderResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ResourceFolderResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceFolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.