Class PaginatedContributorClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedContributorClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedContributorClient

The current PaginatedContributorClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedContributorClient ClearParameters()

Returns

PaginatedContributorClient

The current PaginatedContributorClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedContributorClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedContributorClient

The current PaginatedContributorClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedContributorClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedContributorClient

The current PaginatedContributorClient instance.

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

PerPage(int)

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

public PaginatedContributorClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedContributorClient

The current PaginatedContributorClient instance.

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.