Class SongScheduleClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SongSchedule resource.

public class SongScheduleClient : SingletonResourceClient<SongSchedule, SongScheduleResource, SongScheduleResponse>

Inheritance

object

ResourceClient<SongSchedule>

SingletonResourceClient<SongSchedule, SongScheduleResource, SongScheduleResponse>

SongScheduleClient

Inherited Members

SingletonResourceClient<SongSchedule, SongScheduleResource, SongScheduleResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SongSchedule, SongScheduleResource, SongScheduleResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SongSchedule, SongScheduleResource, SongScheduleResponse>.PatchAsync(SongSchedule, CancellationToken)

SingletonResourceClient<SongSchedule, SongScheduleResource, SongScheduleResponse>.PatchAsync(JsonApiDocument<SongScheduleResource>, CancellationToken)

SingletonResourceClient<SongSchedule, SongScheduleResource, SongScheduleResponse>.DeleteAsync(CancellationToken)

ResourceClient<SongSchedule>.AddQueryParameter(string, string)

ResourceClient<SongSchedule>.ReplaceQueryParameter(string, string)

ResourceClient<SongSchedule>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SongSchedule>.Uri

ResourceClient<SongSchedule>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SongScheduleClient(HttpClient, Uri)

Client for interacting with the SongSchedule resource.

public SongScheduleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SongScheduleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SongScheduleClient

The current SongScheduleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SongScheduleClient ClearParameters()

Returns

SongScheduleClient

The current SongScheduleClient instance.

GetAsync(CancellationToken)

Fetches the SongSchedule resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SongScheduleResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.