Class SongbookStatusClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SongbookStatus resource.

public class SongbookStatusClient : SingletonResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusResponse>

Inheritance

object

ResourceClient<SongbookStatus>

SingletonResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusResponse>

SongbookStatusClient

Inherited Members

SingletonResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusResponse>.PatchAsync(SongbookStatus, CancellationToken)

SingletonResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusResponse>.PatchAsync(JsonApiDocument<SongbookStatusResource>, CancellationToken)

SingletonResourceClient<SongbookStatus, SongbookStatusResource, SongbookStatusResponse>.DeleteAsync(CancellationToken)

ResourceClient<SongbookStatus>.AddQueryParameter(string, string)

ResourceClient<SongbookStatus>.ReplaceQueryParameter(string, string)

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

SongbookStatusClient(HttpClient, Uri)

Client for interacting with the SongbookStatus resource.

public SongbookStatusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SongbookStatusClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SongbookStatusClient

The current SongbookStatusClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SongbookStatusClient ClearParameters()

Returns

SongbookStatusClient

The current SongbookStatusClient instance.

GetAsync(CancellationToken)

Fetches the SongbookStatus resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SongbookStatusResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.