Class ThemeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Theme resource.

public class ThemeClient : SingletonResourceClient<Theme, ThemeResource, ThemeResponse>

Inheritance

object

ResourceClient<Theme>

SingletonResourceClient<Theme, ThemeResource, ThemeResponse>

ThemeClient

Inherited Members

SingletonResourceClient<Theme, ThemeResource, ThemeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Theme, ThemeResource, ThemeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Theme, ThemeResource, ThemeResponse>.PatchAsync(Theme, CancellationToken)

SingletonResourceClient<Theme, ThemeResource, ThemeResponse>.PatchAsync(JsonApiDocument<ThemeResource>, CancellationToken)

SingletonResourceClient<Theme, ThemeResource, ThemeResponse>.DeleteAsync(CancellationToken)

ResourceClient<Theme>.AddQueryParameter(string, string)

ResourceClient<Theme>.ReplaceQueryParameter(string, string)

ResourceClient<Theme>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Theme>.Uri

ResourceClient<Theme>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ThemeClient(HttpClient, Uri)

Client for interacting with the Theme resource.

public ThemeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ThemeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ThemeClient

The current ThemeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ThemeClient ClearParameters()

Returns

ThemeClient

The current ThemeClient instance.

GetAsync(CancellationToken)

Fetches the Theme resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ThemeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.