Class PaginatedTeamPositionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_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>.AddCustomParameter(string, string)

ResourceClient<TeamPosition>.ClearParameters()

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

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

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

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.