Class PaginatedJobStatusClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedJobStatusClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedJobStatusClient

The current PaginatedJobStatusClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedJobStatusClient ClearParameters()

Returns

PaginatedJobStatusClient

The current PaginatedJobStatusClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedJobStatusClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedJobStatusClient

The current PaginatedJobStatusClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedJobStatusClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedJobStatusClient

The current PaginatedJobStatusClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedJobStatusClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedJobStatusClient

The current PaginatedJobStatusClient instance.

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.