Class FolderClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Folder resource.

public class FolderClient : SingletonResourceClient<Folder, FolderResource, FolderResponse>

Inheritance

object

ResourceClient<Folder>

SingletonResourceClient<Folder, FolderResource, FolderResponse>

FolderClient

Inherited Members

SingletonResourceClient<Folder, FolderResource, FolderResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Folder, FolderResource, FolderResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Folder, FolderResource, FolderResponse>.PatchAsync(Folder, CancellationToken)

SingletonResourceClient<Folder, FolderResource, FolderResponse>.PatchAsync(JsonApiDocument<FolderResource>, CancellationToken)

SingletonResourceClient<Folder, FolderResource, FolderResponse>.DeleteAsync(CancellationToken)

ResourceClient<Folder>.AddQueryParameter(string, string)

ResourceClient<Folder>.ReplaceQueryParameter(string, string)

ResourceClient<Folder>.AddCustomParameter(string, string)

ResourceClient<Folder>.ClearParameters()

ResourceClient<Folder>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Folder>.Uri

ResourceClient<Folder>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FolderClient(HttpClient, Uri)

Client for interacting with the Folder resource.

public FolderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Folders

Associated Folders.

public PaginatedFolderClient Folders { get; }

Property Value

PaginatedFolderClient

ServiceTypes

Associated ServiceTypes.

public PaginatedServiceTypeClient ServiceTypes { get; }

Property Value

PaginatedServiceTypeClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeServiceTypes()

Include related ServiceTypes resources in the response.

public FolderClient IncludeServiceTypes()

Returns

FolderClient

PatchAsync(Folder, CancellationToken)

Updates an existing Folder resource asynchronously.

public Task<FolderResponse> PatchAsync(Folder resource, CancellationToken cancellationToken = default)

Parameters

resource Folder

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<FolderResource>, CancellationToken)

Updates an existing Folder resource asynchronously.

public Task<FolderResponse> PatchAsync(JsonApiDocument<FolderResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FolderResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.