Class PaginatedTeamLeaderClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with TeamLeader collection resources.

public class PaginatedTeamLeaderClient : PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>

Inheritance

object

ResourceClient<TeamLeader>

PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>

PaginatedTeamLeaderClient

Inherited Members

PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>.PerPage(int)

PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>.Offset(int)

PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>.Filter(string)

PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>.PostAsync(TeamLeader, CancellationToken)

PaginatedResourceClient<TeamLeader, TeamLeaderResource, TeamLeaderCollectionResponse, TeamLeaderResponse>.PostAsync(JsonApiDocument<TeamLeaderResource>, CancellationToken)

ResourceClient<TeamLeader>.AddQueryParameter(string, string)

ResourceClient<TeamLeader>.ReplaceQueryParameter(string, string)

ResourceClient<TeamLeader>.AddCustomParameter(string, string)

ResourceClient<TeamLeader>.ClearParameters()

ResourceClient<TeamLeader>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TeamLeader>.Uri

ResourceClient<TeamLeader>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedTeamLeaderClient(HttpClient, Uri)

Client for interacting with TeamLeader collection resources.

public PaginatedTeamLeaderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of TeamLeader resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TeamLeaderCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePeople()

Include related People resources in the response.

public TeamLeaderClient IncludePeople()

Returns

TeamLeaderClient

IncludeTeam()

Include related Team resources in the response.

public TeamLeaderClient IncludeTeam()

Returns

TeamLeaderClient

OrderByFirstName()

Sort response items by the FirstName attribute.

public TeamLeaderClient OrderByFirstName()

Returns

TeamLeaderClient

OrderByFirstNameDescending()

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

public TeamLeaderClient OrderByFirstNameDescending()

Returns

TeamLeaderClient

OrderByLastName()

Sort response items by the LastName attribute.

public TeamLeaderClient OrderByLastName()

Returns

TeamLeaderClient

OrderByLastNameDescending()

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

public TeamLeaderClient OrderByLastNameDescending()

Returns

TeamLeaderClient

WithId(string)

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

public TeamLeaderClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

TeamLeaderClient

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