Class ArrangementSectionsClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ArrangementSections resource.

public class ArrangementSectionsClient : SingletonResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsResponse>

Inheritance

object

ResourceClient<ArrangementSections>

SingletonResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsResponse>

ArrangementSectionsClient

Inherited Members

SingletonResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsResponse>.PatchAsync(ArrangementSections, CancellationToken)

SingletonResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsResponse>.PatchAsync(JsonApiDocument<ArrangementSectionsResource>, CancellationToken)

SingletonResourceClient<ArrangementSections, ArrangementSectionsResource, ArrangementSectionsResponse>.DeleteAsync(CancellationToken)

ResourceClient<ArrangementSections>.AddQueryParameter(string, string)

ResourceClient<ArrangementSections>.ReplaceQueryParameter(string, string)

ResourceClient<ArrangementSections>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ArrangementSections>.Uri

ResourceClient<ArrangementSections>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ArrangementSectionsClient(HttpClient, Uri)

Client for interacting with the ArrangementSections resource.

public ArrangementSectionsClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ArrangementSectionsClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ArrangementSectionsClient

The current ArrangementSectionsClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ArrangementSectionsClient ClearParameters()

Returns

ArrangementSectionsClient

The current ArrangementSectionsClient instance.

GetAsync(CancellationToken)

Fetches the ArrangementSections resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ArrangementSectionsResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.