Class SeriesClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Series resource.

public class SeriesClient : SingletonResourceClient<Series, SeriesResource, SeriesResponse>

Inheritance

object

ResourceClient<Series>

SingletonResourceClient<Series, SeriesResource, SeriesResponse>

SeriesClient

Inherited Members

SingletonResourceClient<Series, SeriesResource, SeriesResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Series, SeriesResource, SeriesResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Series, SeriesResource, SeriesResponse>.PatchAsync(Series, CancellationToken)

SingletonResourceClient<Series, SeriesResource, SeriesResponse>.PatchAsync(JsonApiDocument<SeriesResource>, CancellationToken)

SingletonResourceClient<Series, SeriesResource, SeriesResponse>.DeleteAsync(CancellationToken)

ResourceClient<Series>.AddQueryParameter(string, string)

ResourceClient<Series>.ReplaceQueryParameter(string, string)

ResourceClient<Series>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Series>.Uri

ResourceClient<Series>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SeriesClient(HttpClient, Uri)

Client for interacting with the Series resource.

public SeriesClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Channel

Associated Channel.

public ChannelClient Channel { get; }

Property Value

ChannelClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SeriesClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SeriesClient

The current SeriesClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SeriesClient ClearParameters()

Returns

SeriesClient

The current SeriesClient instance.

DeleteAsync(CancellationToken)

Deletes the Series resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Series resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SeriesResponse>

A task representing the asynchronous operation, containing the Series resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeChannel()

Include related Channel resources in the response.

public SeriesClient IncludeChannel()

Returns

SeriesClient

PatchAsync(Series, CancellationToken)

Updates an existing Series resource asynchronously.

public Task<SeriesResponse> PatchAsync(Series resource, CancellationToken cancellationToken = default)

Parameters

resource Series

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SeriesResponse>

A task representing the asynchronous operation, containing the updated Series resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<SeriesResource>, CancellationToken)

Updates an existing Series resource asynchronously.

public Task<SeriesResponse> PatchAsync(JsonApiDocument<SeriesResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SeriesResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SeriesResponse>

A task representing the asynchronous operation, containing the updated Series resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.