Class PaginatedEpisodeStatisticsClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EpisodeStatistics collection resources.

public class PaginatedEpisodeStatisticsClient : PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>

Inheritance

object

ResourceClient<EpisodeStatistics>

PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>

PaginatedEpisodeStatisticsClient

Inherited Members

PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>.PerPage(int)

PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>.Offset(int)

PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>.Filter(string)

PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>.PostAsync(EpisodeStatistics, CancellationToken)

PaginatedResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsCollectionResponse, EpisodeStatisticsResponse>.PostAsync(JsonApiDocument<EpisodeStatisticsResource>, CancellationToken)

ResourceClient<EpisodeStatistics>.AddQueryParameter(string, string)

ResourceClient<EpisodeStatistics>.ReplaceQueryParameter(string, string)

ResourceClient<EpisodeStatistics>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EpisodeStatistics>.Uri

ResourceClient<EpisodeStatistics>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEpisodeStatisticsClient(HttpClient, Uri)

Client for interacting with EpisodeStatistics collection resources.

public PaginatedEpisodeStatisticsClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEpisodeStatisticsClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEpisodeStatisticsClient

The current PaginatedEpisodeStatisticsClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEpisodeStatisticsClient ClearParameters()

Returns

PaginatedEpisodeStatisticsClient

The current PaginatedEpisodeStatisticsClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEpisodeStatisticsClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEpisodeStatisticsClient

The current PaginatedEpisodeStatisticsClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EpisodeStatistics resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeStatisticsCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEpisodeStatisticsClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEpisodeStatisticsClient

The current PaginatedEpisodeStatisticsClient instance.

PerPage(int)

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

public PaginatedEpisodeStatisticsClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEpisodeStatisticsClient

The current PaginatedEpisodeStatisticsClient instance.

WithId(string)

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

public EpisodeStatisticsClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EpisodeStatisticsClient

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