Class PaginatedOrganizationStatisticsClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with OrganizationStatistics collection resources.

public class PaginatedOrganizationStatisticsClient : PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>

Inheritance

object

ResourceClient<OrganizationStatistics>

PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>

PaginatedOrganizationStatisticsClient

Inherited Members

PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>.PerPage(int)

PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>.Offset(int)

PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>.Filter(string)

PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>.PostAsync(OrganizationStatistics, CancellationToken)

PaginatedResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsCollectionResponse, OrganizationStatisticsResponse>.PostAsync(JsonApiDocument<OrganizationStatisticsResource>, CancellationToken)

ResourceClient<OrganizationStatistics>.AddQueryParameter(string, string)

ResourceClient<OrganizationStatistics>.ReplaceQueryParameter(string, string)

ResourceClient<OrganizationStatistics>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<OrganizationStatistics>.Uri

ResourceClient<OrganizationStatistics>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedOrganizationStatisticsClient(HttpClient, Uri)

Client for interacting with OrganizationStatistics collection resources.

public PaginatedOrganizationStatisticsClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedOrganizationStatisticsClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedOrganizationStatisticsClient

The current PaginatedOrganizationStatisticsClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedOrganizationStatisticsClient ClearParameters()

Returns

PaginatedOrganizationStatisticsClient

The current PaginatedOrganizationStatisticsClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedOrganizationStatisticsClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedOrganizationStatisticsClient

The current PaginatedOrganizationStatisticsClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of OrganizationStatistics resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OrganizationStatisticsCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedOrganizationStatisticsClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedOrganizationStatisticsClient

The current PaginatedOrganizationStatisticsClient instance.

PerPage(int)

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

public PaginatedOrganizationStatisticsClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedOrganizationStatisticsClient

The current PaginatedOrganizationStatisticsClient instance.