Class PaginatedChannelDefaultEpisodeResourceClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ChannelDefaultEpisodeResource collection resources.

public class PaginatedChannelDefaultEpisodeResourceClient : PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>

Inheritance

object

ResourceClient<ChannelDefaultEpisodeResource>

PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>

PaginatedChannelDefaultEpisodeResourceClient

Inherited Members

PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>.PerPage(int)

PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>.Offset(int)

PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>.Filter(string)

PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>.PostAsync(ChannelDefaultEpisodeResource, CancellationToken)

PaginatedResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceCollectionResponse, ChannelDefaultEpisodeResourceResponse>.PostAsync(JsonApiDocument<ChannelDefaultEpisodeResourceResource>, CancellationToken)

ResourceClient<ChannelDefaultEpisodeResource>.AddQueryParameter(string, string)

ResourceClient<ChannelDefaultEpisodeResource>.ReplaceQueryParameter(string, string)

ResourceClient<ChannelDefaultEpisodeResource>.AddCustomParameter(string, string)

ResourceClient<ChannelDefaultEpisodeResource>.ClearParameters()

ResourceClient<ChannelDefaultEpisodeResource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ChannelDefaultEpisodeResource>.Uri

ResourceClient<ChannelDefaultEpisodeResource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedChannelDefaultEpisodeResourceClient(HttpClient, Uri)

Client for interacting with ChannelDefaultEpisodeResource collection resources.

public PaginatedChannelDefaultEpisodeResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ChannelDefaultEpisodeResource resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultEpisodeResourceCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ChannelDefaultEpisodeResourceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ChannelDefaultEpisodeResourceClient

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