Class FolderPathClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FolderPath resource.

public class FolderPathClient : SingletonResourceClient<FolderPath, FolderPathResource, FolderPathResponse>

Inheritance

object

ResourceClient<FolderPath>

SingletonResourceClient<FolderPath, FolderPathResource, FolderPathResponse>

FolderPathClient

Inherited Members

SingletonResourceClient<FolderPath, FolderPathResource, FolderPathResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FolderPath, FolderPathResource, FolderPathResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FolderPath, FolderPathResource, FolderPathResponse>.PatchAsync(FolderPath, CancellationToken)

SingletonResourceClient<FolderPath, FolderPathResource, FolderPathResponse>.PatchAsync(JsonApiDocument<FolderPathResource>, CancellationToken)

SingletonResourceClient<FolderPath, FolderPathResource, FolderPathResponse>.DeleteAsync(CancellationToken)

ResourceClient<FolderPath>.AddQueryParameter(string, string)

ResourceClient<FolderPath>.ReplaceQueryParameter(string, string)

ResourceClient<FolderPath>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FolderPath>.Uri

ResourceClient<FolderPath>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FolderPathClient(HttpClient, Uri)

Client for interacting with the FolderPath resource.

public FolderPathClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FolderPathClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FolderPathClient

The current FolderPathClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FolderPathClient ClearParameters()

Returns

FolderPathClient

The current FolderPathClient instance.

GetAsync(CancellationToken)

Fetches the FolderPath resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FolderPathResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.