Class PaginatedMediaScheduleClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with MediaSchedule collection resources.

public class PaginatedMediaScheduleClient : PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>

Inheritance

object

ResourceClient<MediaSchedule>

PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>

PaginatedMediaScheduleClient

Inherited Members

PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>.PerPage(int)

PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>.Offset(int)

PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>.Filter(string)

PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>.PostAsync(MediaSchedule, CancellationToken)

PaginatedResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleCollectionResponse, MediaScheduleResponse>.PostAsync(JsonApiDocument<MediaScheduleResource>, CancellationToken)

ResourceClient<MediaSchedule>.AddQueryParameter(string, string)

ResourceClient<MediaSchedule>.ReplaceQueryParameter(string, string)

ResourceClient<MediaSchedule>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<MediaSchedule>.Uri

ResourceClient<MediaSchedule>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedMediaScheduleClient(HttpClient, Uri)

Client for interacting with MediaSchedule collection resources.

public PaginatedMediaScheduleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedMediaScheduleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedMediaScheduleClient

The current PaginatedMediaScheduleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedMediaScheduleClient ClearParameters()

Returns

PaginatedMediaScheduleClient

The current PaginatedMediaScheduleClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedMediaScheduleClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedMediaScheduleClient

The current PaginatedMediaScheduleClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of MediaSchedule resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MediaScheduleCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedMediaScheduleClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedMediaScheduleClient

The current PaginatedMediaScheduleClient instance.

PerPage(int)

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

public PaginatedMediaScheduleClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedMediaScheduleClient

The current PaginatedMediaScheduleClient instance.

WithId(string)

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

public MediaScheduleClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

MediaScheduleClient

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