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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedTeamLeaderClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedTeamLeaderClient

The current PaginatedTeamLeaderClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedTeamLeaderClient ClearParameters()

Returns

PaginatedTeamLeaderClient

The current PaginatedTeamLeaderClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedTeamLeaderClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedTeamLeaderClient

The current PaginatedTeamLeaderClient instance.

Remarks

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedTeamLeaderClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedTeamLeaderClient

The current PaginatedTeamLeaderClient instance.

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

PerPage(int)

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

public PaginatedTeamLeaderClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedTeamLeaderClient

The current PaginatedTeamLeaderClient instance.

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.