Class PaginatedNameSuffixClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with NameSuffix collection resources.

public class PaginatedNameSuffixClient : PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>

Inheritance

object

ResourceClient<NameSuffix>

PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>

PaginatedNameSuffixClient

Inherited Members

PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>.PerPage(int)

PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>.Offset(int)

PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>.Filter(string)

PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>.PostAsync(NameSuffix, CancellationToken)

PaginatedResourceClient<NameSuffix, NameSuffixResource, NameSuffixCollectionResponse, NameSuffixResponse>.PostAsync(JsonApiDocument<NameSuffixResource>, CancellationToken)

ResourceClient<NameSuffix>.AddQueryParameter(string, string)

ResourceClient<NameSuffix>.ReplaceQueryParameter(string, string)

ResourceClient<NameSuffix>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NameSuffix>.Uri

ResourceClient<NameSuffix>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNameSuffixClient(HttpClient, Uri)

Client for interacting with NameSuffix collection resources.

public PaginatedNameSuffixClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedNameSuffixClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedNameSuffixClient

The current PaginatedNameSuffixClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedNameSuffixClient ClearParameters()

Returns

PaginatedNameSuffixClient

The current PaginatedNameSuffixClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedNameSuffixClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedNameSuffixClient

The current PaginatedNameSuffixClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of NameSuffix resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NameSuffixCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedNameSuffixClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedNameSuffixClient

The current PaginatedNameSuffixClient instance.

OrderByValue()

Sort response items by the Value attribute.

public NameSuffixClient OrderByValue()

Returns

NameSuffixClient

OrderByValueDescending()

Sort response items by the Value attribute. Use reverse order.

public NameSuffixClient OrderByValueDescending()

Returns

NameSuffixClient

PerPage(int)

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

public PaginatedNameSuffixClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedNameSuffixClient

The current PaginatedNameSuffixClient instance.

PostAsync(NameSuffix, CancellationToken)

Creates a new NameSuffix resource asynchronously.

public Task<NameSuffixResponse> PostAsync(NameSuffix resource, CancellationToken cancellationToken = default)

Parameters

resource NameSuffix

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NameSuffixResponse>

A task representing the asynchronous operation, containing the created NameSuffix resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<NameSuffixResource>, CancellationToken)

Creates a new NameSuffix resource asynchronously.

public Task<NameSuffixResponse> PostAsync(JsonApiDocument<NameSuffixResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NameSuffixResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NameSuffixResponse>

A task representing the asynchronous operation, containing the created NameSuffix resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereValue(string)

Query response items by the Value attribute.

public NameSuffixClient WhereValue(string value)

Parameters

value string

Returns

NameSuffixClient

WithId(string)

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

public NameSuffixClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NameSuffixClient

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