Class OrganizationStatisticsClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the OrganizationStatistics resource.

public class OrganizationStatisticsClient : SingletonResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsResponse>

Inheritance

object

ResourceClient<OrganizationStatistics>

SingletonResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsResponse>

OrganizationStatisticsClient

Inherited Members

SingletonResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsResponse>.GetAsync(CancellationToken)

SingletonResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsResponse>.PatchAsync(OrganizationStatistics, CancellationToken)

SingletonResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsResponse>.PatchAsync(JsonApiDocument<OrganizationStatisticsResource>, CancellationToken)

SingletonResourceClient<OrganizationStatistics, OrganizationStatisticsResource, OrganizationStatisticsResponse>.DeleteAsync(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

OrganizationStatisticsClient(HttpClient, Uri)

Client for interacting with the OrganizationStatistics resource.

public OrganizationStatisticsClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public OrganizationStatisticsClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

OrganizationStatisticsClient

The current OrganizationStatisticsClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public OrganizationStatisticsClient ClearParameters()

Returns

OrganizationStatisticsClient

The current OrganizationStatisticsClient instance.

GetAsync(CancellationToken)

Fetches the OrganizationStatistics resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OrganizationStatisticsResponse>

A task representing the asynchronous operation, containing the OrganizationStatistics resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.