Class PaginatedOrganizationStatisticsClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

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>.AddCustomParameter(string, string)

ResourceClient<OrganizationStatistics>.ClearParameters()

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

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.