Class TabClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Tab resource.

public class TabClient : SingletonResourceClient<Tab, TabResource, TabResponse>

Inheritance

object

ResourceClient<Tab>

SingletonResourceClient<Tab, TabResource, TabResponse>

TabClient

Inherited Members

SingletonResourceClient<Tab, TabResource, TabResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Tab, TabResource, TabResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Tab, TabResource, TabResponse>.PatchAsync(Tab, CancellationToken)

SingletonResourceClient<Tab, TabResource, TabResponse>.PatchAsync(JsonApiDocument<TabResource>, CancellationToken)

SingletonResourceClient<Tab, TabResource, TabResponse>.DeleteAsync(CancellationToken)

ResourceClient<Tab>.AddQueryParameter(string, string)

ResourceClient<Tab>.ReplaceQueryParameter(string, string)

ResourceClient<Tab>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Tab>.Uri

ResourceClient<Tab>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TabClient(HttpClient, Uri)

Client for interacting with the Tab resource.

public TabClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

FieldDefinitions

Associated FieldDefinitions.

public PaginatedFieldDefinitionClient FieldDefinitions { get; }

Property Value

PaginatedFieldDefinitionClient

FieldOptions

Associated FieldOptions.

public PaginatedFieldOptionClient FieldOptions { get; }

Property Value

PaginatedFieldOptionClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public TabClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

TabClient

The current TabClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public TabClient ClearParameters()

Returns

TabClient

The current TabClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TabResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeFieldDefinitions()

Include related FieldDefinitions resources in the response.

public TabClient IncludeFieldDefinitions()

Returns

TabClient

IncludeFieldOptions()

Include related FieldOptions resources in the response.

public TabClient IncludeFieldOptions()

Returns

TabClient

PatchAsync(Tab, CancellationToken)

Updates an existing Tab resource asynchronously.

public Task<TabResponse> PatchAsync(Tab resource, CancellationToken cancellationToken = default)

Parameters

resource Tab

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TabResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<TabResource>, CancellationToken)

Updates an existing Tab resource asynchronously.

public Task<TabResponse> PatchAsync(JsonApiDocument<TabResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<TabResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TabResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.