Class PaginatedContributorClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Contributor collection resources.

public class PaginatedContributorClient : PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>

Inheritance

object

ResourceClient<Contributor>

PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>

PaginatedContributorClient

Inherited Members

PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>.PerPage(int)

PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>.Offset(int)

PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>.Filter(string)

PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>.PostAsync(Contributor, CancellationToken)

PaginatedResourceClient<Contributor, ContributorResource, ContributorCollectionResponse, ContributorResponse>.PostAsync(JsonApiDocument<ContributorResource>, CancellationToken)

ResourceClient<Contributor>.AddQueryParameter(string, string)

ResourceClient<Contributor>.ReplaceQueryParameter(string, string)

ResourceClient<Contributor>.AddCustomParameter(string, string)

ResourceClient<Contributor>.ClearParameters()

ResourceClient<Contributor>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Contributor>.Uri

ResourceClient<Contributor>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedContributorClient(HttpClient, Uri)

Client for interacting with Contributor collection resources.

public PaginatedContributorClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Contributor resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ContributorCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ContributorClient OrderByCreatedAt()

Returns

ContributorClient

OrderByCreatedAtDescending()

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

public ContributorClient OrderByCreatedAtDescending()

Returns

ContributorClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ContributorClient OrderByUpdatedAt()

Returns

ContributorClient

OrderByUpdatedAtDescending()

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

public ContributorClient OrderByUpdatedAtDescending()

Returns

ContributorClient

WithId(string)

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

public ContributorClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ContributorClient

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