Class JobStatusClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the JobStatus resource.

public class JobStatusClient : SingletonResourceClient<JobStatus, JobStatusResource, JobStatusResponse>

Inheritance

object

ResourceClient<JobStatus>

SingletonResourceClient<JobStatus, JobStatusResource, JobStatusResponse>

JobStatusClient

Inherited Members

SingletonResourceClient<JobStatus, JobStatusResource, JobStatusResponse>.GetAsync(CancellationToken)

SingletonResourceClient<JobStatus, JobStatusResource, JobStatusResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<JobStatus, JobStatusResource, JobStatusResponse>.PatchAsync(JobStatus, CancellationToken)

SingletonResourceClient<JobStatus, JobStatusResource, JobStatusResponse>.PatchAsync(JsonApiDocument<JobStatusResource>, CancellationToken)

SingletonResourceClient<JobStatus, JobStatusResource, JobStatusResponse>.DeleteAsync(CancellationToken)

ResourceClient<JobStatus>.AddQueryParameter(string, string)

ResourceClient<JobStatus>.ReplaceQueryParameter(string, string)

ResourceClient<JobStatus>.AddCustomParameter(string, string)

ResourceClient<JobStatus>.ClearParameters()

ResourceClient<JobStatus>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<JobStatus>.Uri

ResourceClient<JobStatus>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

JobStatusClient(HttpClient, Uri)

Client for interacting with the JobStatus resource.

public JobStatusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the JobStatus resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<JobStatusResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.