Class PaginatedChannelDefaultEpisodeResourceClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedChannelDefaultEpisodeResourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedChannelDefaultEpisodeResourceClient

The current PaginatedChannelDefaultEpisodeResourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedChannelDefaultEpisodeResourceClient ClearParameters()

Returns

PaginatedChannelDefaultEpisodeResourceClient

The current PaginatedChannelDefaultEpisodeResourceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedChannelDefaultEpisodeResourceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedChannelDefaultEpisodeResourceClient

The current PaginatedChannelDefaultEpisodeResourceClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedChannelDefaultEpisodeResourceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedChannelDefaultEpisodeResourceClient

The current PaginatedChannelDefaultEpisodeResourceClient instance.

PerPage(int)

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

public PaginatedChannelDefaultEpisodeResourceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedChannelDefaultEpisodeResourceClient

The current PaginatedChannelDefaultEpisodeResourceClient instance.

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.