Class MediaScheduleClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the MediaSchedule resource.

public class MediaScheduleClient : SingletonResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleResponse>

Inheritance

object

ResourceClient<MediaSchedule>

SingletonResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleResponse>

MediaScheduleClient

Inherited Members

SingletonResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleResponse>.GetAsync(CancellationToken)

SingletonResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleResponse>.PatchAsync(MediaSchedule, CancellationToken)

SingletonResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleResponse>.PatchAsync(JsonApiDocument<MediaScheduleResource>, CancellationToken)

SingletonResourceClient<MediaSchedule, MediaScheduleResource, MediaScheduleResponse>.DeleteAsync(CancellationToken)

ResourceClient<MediaSchedule>.AddQueryParameter(string, string)

ResourceClient<MediaSchedule>.ReplaceQueryParameter(string, string)

ResourceClient<MediaSchedule>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<MediaSchedule>.Uri

ResourceClient<MediaSchedule>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MediaScheduleClient(HttpClient, Uri)

Client for interacting with the MediaSchedule resource.

public MediaScheduleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public MediaScheduleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

MediaScheduleClient

The current MediaScheduleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public MediaScheduleClient ClearParameters()

Returns

MediaScheduleClient

The current MediaScheduleClient instance.

GetAsync(CancellationToken)

Fetches the MediaSchedule resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MediaScheduleResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.