Class PaginatedTeamPositionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with TeamPosition collection resources.

public class PaginatedTeamPositionClient : PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>

Inheritance

object

ResourceClient<TeamPosition>

PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>

PaginatedTeamPositionClient

Inherited Members

PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>.PerPage(int)

PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>.Offset(int)

PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>.Filter(string)

PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>.PostAsync(TeamPosition, CancellationToken)

PaginatedResourceClient<TeamPosition, TeamPositionResource, TeamPositionCollectionResponse, TeamPositionResponse>.PostAsync(JsonApiDocument<TeamPositionResource>, CancellationToken)

ResourceClient<TeamPosition>.AddQueryParameter(string, string)

ResourceClient<TeamPosition>.ReplaceQueryParameter(string, string)

ResourceClient<TeamPosition>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TeamPosition>.Uri

ResourceClient<TeamPosition>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedTeamPositionClient(HttpClient, Uri)

Client for interacting with TeamPosition collection resources.

public PaginatedTeamPositionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedTeamPositionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedTeamPositionClient

The current PaginatedTeamPositionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedTeamPositionClient ClearParameters()

Returns

PaginatedTeamPositionClient

The current PaginatedTeamPositionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedTeamPositionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedTeamPositionClient

The current PaginatedTeamPositionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of TeamPosition resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TeamPositionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeTags()

Include related Tags resources in the response.

public TeamPositionClient IncludeTags()

Returns

TeamPositionClient

IncludeTeam()

Include related Team resources in the response.

public TeamPositionClient IncludeTeam()

Returns

TeamPositionClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedTeamPositionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedTeamPositionClient

The current PaginatedTeamPositionClient instance.

OrderByName()

Sort response items by the Name attribute.

public TeamPositionClient OrderByName()

Returns

TeamPositionClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public TeamPositionClient OrderByNameDescending()

Returns

TeamPositionClient

PerPage(int)

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

public PaginatedTeamPositionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedTeamPositionClient

The current PaginatedTeamPositionClient instance.

WithId(string)

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

public TeamPositionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

TeamPositionClient

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