Class PaginatedJobStatusClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with JobStatus collection resources.

public class PaginatedJobStatusClient : PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>

Inheritance

object

ResourceClient<JobStatus>

PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>

PaginatedJobStatusClient

Inherited Members

PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>.PerPage(int)

PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>.Offset(int)

PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>.Filter(string)

PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>.PostAsync(JobStatus, CancellationToken)

PaginatedResourceClient<JobStatus, JobStatusResource, JobStatusCollectionResponse, JobStatusResponse>.PostAsync(JsonApiDocument<JobStatusResource>, 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

PaginatedJobStatusClient(HttpClient, Uri)

Client for interacting with JobStatus collection resources.

public PaginatedJobStatusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of JobStatus resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<JobStatusCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of JobStatus resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

Creates a new instance of a JobStatus client for a specific resource ID.

public JobStatusClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

JobStatusClient

A new instance of the resource client for the specified resource ID.