Class TextSettingClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the TextSetting resource.

public class TextSettingClient : SingletonResourceClient<TextSetting, TextSettingResource, TextSettingResponse>

Inheritance

object

ResourceClient<TextSetting>

SingletonResourceClient<TextSetting, TextSettingResource, TextSettingResponse>

TextSettingClient

Inherited Members

SingletonResourceClient<TextSetting, TextSettingResource, TextSettingResponse>.GetAsync(CancellationToken)

SingletonResourceClient<TextSetting, TextSettingResource, TextSettingResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<TextSetting, TextSettingResource, TextSettingResponse>.PatchAsync(TextSetting, CancellationToken)

SingletonResourceClient<TextSetting, TextSettingResource, TextSettingResponse>.PatchAsync(JsonApiDocument<TextSettingResource>, CancellationToken)

SingletonResourceClient<TextSetting, TextSettingResource, TextSettingResponse>.DeleteAsync(CancellationToken)

ResourceClient<TextSetting>.AddQueryParameter(string, string)

ResourceClient<TextSetting>.ReplaceQueryParameter(string, string)

ResourceClient<TextSetting>.AddCustomParameter(string, string)

ResourceClient<TextSetting>.ClearParameters()

ResourceClient<TextSetting>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TextSetting>.Uri

ResourceClient<TextSetting>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TextSettingClient(HttpClient, Uri)

Client for interacting with the TextSetting resource.

public TextSettingClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the TextSetting resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TextSettingResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(TextSetting, CancellationToken)

Updates an existing TextSetting resource asynchronously.

public Task<TextSettingResponse> PatchAsync(TextSetting resource, CancellationToken cancellationToken = default)

Parameters

resource TextSetting

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TextSettingResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<TextSettingResource>, CancellationToken)

Updates an existing TextSetting resource asynchronously.

public Task<TextSettingResponse> PatchAsync(JsonApiDocument<TextSettingResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<TextSettingResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TextSettingResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.