Class PaginatedSongScheduleClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SongSchedule collection resources.

public class PaginatedSongScheduleClient : PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>

Inheritance

object

ResourceClient<SongSchedule>

PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>

PaginatedSongScheduleClient

Inherited Members

PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>.PerPage(int)

PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>.Offset(int)

PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>.Filter(string)

PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>.PostAsync(SongSchedule, CancellationToken)

PaginatedResourceClient<SongSchedule, SongScheduleResource, SongScheduleCollectionResponse, SongScheduleResponse>.PostAsync(JsonApiDocument<SongScheduleResource>, CancellationToken)

ResourceClient<SongSchedule>.AddQueryParameter(string, string)

ResourceClient<SongSchedule>.ReplaceQueryParameter(string, string)

ResourceClient<SongSchedule>.AddCustomParameter(string, string)

ResourceClient<SongSchedule>.ClearParameters()

ResourceClient<SongSchedule>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SongSchedule>.Uri

ResourceClient<SongSchedule>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSongScheduleClient(HttpClient, Uri)

Client for interacting with SongSchedule collection resources.

public PaginatedSongScheduleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of SongSchedule resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SongScheduleCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByPlanSortDate()

Sort response items by the PlanSortDate attribute.

public SongScheduleClient OrderByPlanSortDate()

Returns

SongScheduleClient

OrderByPlanSortDateDescending()

Sort response items by the PlanSortDate attribute. Use reverse order.

public SongScheduleClient OrderByPlanSortDateDescending()

Returns

SongScheduleClient

WithId(string)

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

public SongScheduleClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SongScheduleClient

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