Class PaginatedSpeakerClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Speaker collection resources.

public class PaginatedSpeakerClient : PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>

Inheritance

object

ResourceClient<Speaker>

PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>

PaginatedSpeakerClient

Inherited Members

PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>.PerPage(int)

PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>.Offset(int)

PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>.Filter(string)

PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>.PostAsync(Speaker, CancellationToken)

PaginatedResourceClient<Speaker, SpeakerResource, SpeakerCollectionResponse, SpeakerResponse>.PostAsync(JsonApiDocument<SpeakerResource>, CancellationToken)

ResourceClient<Speaker>.AddQueryParameter(string, string)

ResourceClient<Speaker>.ReplaceQueryParameter(string, string)

ResourceClient<Speaker>.AddCustomParameter(string, string)

ResourceClient<Speaker>.ClearParameters()

ResourceClient<Speaker>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Speaker>.Uri

ResourceClient<Speaker>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSpeakerClient(HttpClient, Uri)

Client for interacting with Speaker collection resources.

public PaginatedSpeakerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Speaker resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakerCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByFirstName()

Sort response items by the FirstName attribute.

public SpeakerClient OrderByFirstName()

Returns

SpeakerClient

OrderByFirstNameDescending()

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

public SpeakerClient OrderByFirstNameDescending()

Returns

SpeakerClient

WithId(string)

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

public SpeakerClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SpeakerClient

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