Class CustomSlideClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the CustomSlide resource.

public class CustomSlideClient : SingletonResourceClient<CustomSlide, CustomSlideResource, CustomSlideResponse>

Inheritance

object

ResourceClient<CustomSlide>

SingletonResourceClient<CustomSlide, CustomSlideResource, CustomSlideResponse>

CustomSlideClient

Inherited Members

SingletonResourceClient<CustomSlide, CustomSlideResource, CustomSlideResponse>.GetAsync(CancellationToken)

SingletonResourceClient<CustomSlide, CustomSlideResource, CustomSlideResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<CustomSlide, CustomSlideResource, CustomSlideResponse>.PatchAsync(CustomSlide, CancellationToken)

SingletonResourceClient<CustomSlide, CustomSlideResource, CustomSlideResponse>.PatchAsync(JsonApiDocument<CustomSlideResource>, CancellationToken)

SingletonResourceClient<CustomSlide, CustomSlideResource, CustomSlideResponse>.DeleteAsync(CancellationToken)

ResourceClient<CustomSlide>.AddQueryParameter(string, string)

ResourceClient<CustomSlide>.ReplaceQueryParameter(string, string)

ResourceClient<CustomSlide>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CustomSlide>.Uri

ResourceClient<CustomSlide>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CustomSlideClient(HttpClient, Uri)

Client for interacting with the CustomSlide resource.

public CustomSlideClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public CustomSlideClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

CustomSlideClient

The current CustomSlideClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public CustomSlideClient ClearParameters()

Returns

CustomSlideClient

The current CustomSlideClient instance.

DeleteAsync(CancellationToken)

Deletes the CustomSlide 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 CustomSlide resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSlideResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(CustomSlide, CancellationToken)

Updates an existing CustomSlide resource asynchronously.

public Task<CustomSlideResponse> PatchAsync(CustomSlide resource, CancellationToken cancellationToken = default)

Parameters

resource CustomSlide

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSlideResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<CustomSlideResource>, CancellationToken)

Updates an existing CustomSlide resource asynchronously.

public Task<CustomSlideResponse> PatchAsync(JsonApiDocument<CustomSlideResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<CustomSlideResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSlideResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.