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

ResourceClient<MediaSchedule>.ClearParameters()

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

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.

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.