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

ResourceClient<EpisodeStatistics>.ClearParameters()

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

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.

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.