Class PaginatedNeededPositionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with NeededPosition collection resources.

public class PaginatedNeededPositionClient : PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>

Inheritance

object

ResourceClient<NeededPosition>

PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>

PaginatedNeededPositionClient

Inherited Members

PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>.PerPage(int)

PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>.Offset(int)

PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>.Filter(string)

PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>.PostAsync(NeededPosition, CancellationToken)

PaginatedResourceClient<NeededPosition, NeededPositionResource, NeededPositionCollectionResponse, NeededPositionResponse>.PostAsync(JsonApiDocument<NeededPositionResource>, CancellationToken)

ResourceClient<NeededPosition>.AddQueryParameter(string, string)

ResourceClient<NeededPosition>.ReplaceQueryParameter(string, string)

ResourceClient<NeededPosition>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NeededPosition>.Uri

ResourceClient<NeededPosition>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNeededPositionClient(HttpClient, Uri)

Client for interacting with NeededPosition collection resources.

public PaginatedNeededPositionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedNeededPositionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedNeededPositionClient

The current PaginatedNeededPositionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedNeededPositionClient ClearParameters()

Returns

PaginatedNeededPositionClient

The current PaginatedNeededPositionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedNeededPositionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedNeededPositionClient

The current PaginatedNeededPositionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of NeededPosition resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NeededPositionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeTeam()

Include related Team resources in the response.

public NeededPositionClient IncludeTeam()

Returns

NeededPositionClient

IncludeTime()

Include related Time resources in the response.

public NeededPositionClient IncludeTime()

Returns

NeededPositionClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedNeededPositionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedNeededPositionClient

The current PaginatedNeededPositionClient instance.

PerPage(int)

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

public PaginatedNeededPositionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedNeededPositionClient

The current PaginatedNeededPositionClient instance.

PostAsync(NeededPosition, CancellationToken)

Creates a new NeededPosition resource asynchronously.

public Task<NeededPositionResponse> PostAsync(NeededPosition resource, CancellationToken cancellationToken = default)

Parameters

resource NeededPosition

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NeededPositionResponse>

A task representing the asynchronous operation, containing the created NeededPosition resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<NeededPositionResource>, CancellationToken)

Creates a new NeededPosition resource asynchronously.

public Task<NeededPositionResponse> PostAsync(JsonApiDocument<NeededPositionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NeededPositionResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NeededPositionResponse>

A task representing the asynchronous operation, containing the created NeededPosition resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public NeededPositionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NeededPositionClient

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