Class PaginatedTextSettingClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with TextSetting collection resources.

public class PaginatedTextSettingClient : PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>

Inheritance

object

ResourceClient<TextSetting>

PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>

PaginatedTextSettingClient

Inherited Members

PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>.PerPage(int)

PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>.Offset(int)

PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>.Filter(string)

PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>.PostAsync(TextSetting, CancellationToken)

PaginatedResourceClient<TextSetting, TextSettingResource, TextSettingCollectionResponse, TextSettingResponse>.PostAsync(JsonApiDocument<TextSettingResource>, CancellationToken)

ResourceClient<TextSetting>.AddQueryParameter(string, string)

ResourceClient<TextSetting>.ReplaceQueryParameter(string, string)

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

PaginatedTextSettingClient(HttpClient, Uri)

Client for interacting with TextSetting collection resources.

public PaginatedTextSettingClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedTextSettingClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedTextSettingClient

The current PaginatedTextSettingClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedTextSettingClient ClearParameters()

Returns

PaginatedTextSettingClient

The current PaginatedTextSettingClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedTextSettingClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedTextSettingClient

The current PaginatedTextSettingClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of TextSetting resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TextSettingCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of TextSetting resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedTextSettingClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedTextSettingClient

The current PaginatedTextSettingClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedTextSettingClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedTextSettingClient

The current PaginatedTextSettingClient instance.

WithId(string)

Creates a new instance of a TextSetting client for a specific resource ID.

public TextSettingClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

TextSettingClient

A new instance of the resource client for the specified resource ID.