Class PaginatedSpeakershipClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Speakership collection resources.

public class PaginatedSpeakershipClient : PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>

Inheritance

object

ResourceClient<Speakership>

PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>

PaginatedSpeakershipClient

Inherited Members

PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>.PerPage(int)

PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>.Offset(int)

PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>.Filter(string)

PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>.PostAsync(Speakership, CancellationToken)

PaginatedResourceClient<Speakership, SpeakershipResource, SpeakershipCollectionResponse, SpeakershipResponse>.PostAsync(JsonApiDocument<SpeakershipResource>, CancellationToken)

ResourceClient<Speakership>.AddQueryParameter(string, string)

ResourceClient<Speakership>.ReplaceQueryParameter(string, string)

ResourceClient<Speakership>.AddCustomParameter(string, string)

ResourceClient<Speakership>.ClearParameters()

ResourceClient<Speakership>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Speakership>.Uri

ResourceClient<Speakership>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSpeakershipClient(HttpClient, Uri)

Client for interacting with Speakership collection resources.

public PaginatedSpeakershipClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Speakership resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakershipCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeSpeaker()

Include related Speaker resources in the response.

public SpeakershipClient IncludeSpeaker()

Returns

SpeakershipClient

PostAsync(Speakership, CancellationToken)

Creates a new Speakership resource asynchronously.

public Task<SpeakershipResponse> PostAsync(Speakership resource, CancellationToken cancellationToken = default)

Parameters

resource Speakership

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakershipResponse>

A task representing the asynchronous operation, containing the created Speakership resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<SpeakershipResource>, CancellationToken)

Creates a new Speakership resource asynchronously.

public Task<SpeakershipResponse> PostAsync(JsonApiDocument<SpeakershipResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SpeakershipResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakershipResponse>

A task representing the asynchronous operation, containing the created Speakership resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public SpeakershipClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SpeakershipClient

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