Class PaginatedSongbookStatusClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SongbookStatus collection resources.

public class PaginatedSongbookStatusClient : PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>

Inheritance

object

ResourceClient<SongbookStatus>

PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>

PaginatedSongbookStatusClient

Inherited Members

PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>.PerPage(int)

PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>.Offset(int)

PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>.Filter(string)

PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>.PostAsync(SongbookStatus, CancellationToken)

PaginatedResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusCollectionResponse, SongbookStatusResponse>.PostAsync(JsonApiDocument<SongbookStatusResource>, CancellationToken)

ResourceClient<SongbookStatus>.AddQueryParameter(string, string)

ResourceClient<SongbookStatus>.ReplaceQueryParameter(string, string)

ResourceClient<SongbookStatus>.AddCustomParameter(string, string)

ResourceClient<SongbookStatus>.ClearParameters()

ResourceClient<SongbookStatus>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SongbookStatus>.Uri

ResourceClient<SongbookStatus>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSongbookStatusClient(HttpClient, Uri)

Client for interacting with SongbookStatus collection resources.

public PaginatedSongbookStatusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of SongbookStatus resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SongbookStatusCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public SongbookStatusClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SongbookStatusClient

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