Class ScheduledPersonClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ScheduledPerson resource.

public class ScheduledPersonClient : SingletonResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonResponse>

Inheritance

object

ResourceClient<ScheduledPerson>

SingletonResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonResponse>

ScheduledPersonClient

Inherited Members

SingletonResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonResponse>.PatchAsync(ScheduledPerson, CancellationToken)

SingletonResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonResponse>.PatchAsync(JsonApiDocument<ScheduledPersonResource>, CancellationToken)

SingletonResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<ScheduledPerson>.AddQueryParameter(string, string)

ResourceClient<ScheduledPerson>.ReplaceQueryParameter(string, string)

ResourceClient<ScheduledPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ScheduledPerson>.Uri

ResourceClient<ScheduledPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ScheduledPersonClient(HttpClient, Uri)

Client for interacting with the ScheduledPerson resource.

public ScheduledPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ScheduledPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ScheduledPersonClient

The current ScheduledPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ScheduledPersonClient ClearParameters()

Returns

ScheduledPersonClient

The current ScheduledPersonClient instance.

GetAsync(CancellationToken)

Fetches the ScheduledPerson resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ScheduledPersonResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.