Class PaginatedNamePrefixClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with NamePrefix collection resources.

public class PaginatedNamePrefixClient : PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>

Inheritance

object

ResourceClient<NamePrefix>

PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>

PaginatedNamePrefixClient

Inherited Members

PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>.PerPage(int)

PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>.Offset(int)

PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>.Filter(string)

PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>.PostAsync(NamePrefix, CancellationToken)

PaginatedResourceClient<NamePrefix, NamePrefixResource, NamePrefixCollectionResponse, NamePrefixResponse>.PostAsync(JsonApiDocument<NamePrefixResource>, CancellationToken)

ResourceClient<NamePrefix>.AddQueryParameter(string, string)

ResourceClient<NamePrefix>.ReplaceQueryParameter(string, string)

ResourceClient<NamePrefix>.AddCustomParameter(string, string)

ResourceClient<NamePrefix>.ClearParameters()

ResourceClient<NamePrefix>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NamePrefix>.Uri

ResourceClient<NamePrefix>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedNamePrefixClient(HttpClient, Uri)

Client for interacting with NamePrefix collection resources.

public PaginatedNamePrefixClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of NamePrefix resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NamePrefixCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByValue()

Sort response items by the Value attribute.

public NamePrefixClient OrderByValue()

Returns

NamePrefixClient

OrderByValueDescending()

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

public NamePrefixClient OrderByValueDescending()

Returns

NamePrefixClient

PostAsync(NamePrefix, CancellationToken)

Creates a new NamePrefix resource asynchronously.

public Task<NamePrefixResponse> PostAsync(NamePrefix resource, CancellationToken cancellationToken = default)

Parameters

resource NamePrefix

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NamePrefixResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<NamePrefixResource>, CancellationToken)

Creates a new NamePrefix resource asynchronously.

public Task<NamePrefixResponse> PostAsync(JsonApiDocument<NamePrefixResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NamePrefixResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NamePrefixResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereValue(string)

Query response items by the Value attribute.

public NamePrefixClient WhereValue(string value)

Parameters

value string

Returns

NamePrefixClient

WithId(string)

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

public NamePrefixClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

NamePrefixClient

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