Class SeriesClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

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>.AddCustomParameter(string, string)

ResourceClient<Series>.ClearParameters()

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

Plans

Associated Plans.

public PaginatedPlanClient Plans { get; }

Property Value

PaginatedPlanClient

Methods

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.