Class PaginatedPersonMergerClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PersonMerger collection resources.

public class PaginatedPersonMergerClient : PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>

Inheritance

object

ResourceClient<PersonMerger>

PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>

PaginatedPersonMergerClient

Inherited Members

PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>.PerPage(int)

PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>.Offset(int)

PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>.Filter(string)

PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>.PostAsync(PersonMerger, CancellationToken)

PaginatedResourceClient<PersonMerger, PersonMergerResource, PersonMergerCollectionResponse, PersonMergerResponse>.PostAsync(JsonApiDocument<PersonMergerResource>, CancellationToken)

ResourceClient<PersonMerger>.AddQueryParameter(string, string)

ResourceClient<PersonMerger>.ReplaceQueryParameter(string, string)

ResourceClient<PersonMerger>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonMerger>.Uri

ResourceClient<PersonMerger>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPersonMergerClient(HttpClient, Uri)

Client for interacting with PersonMerger collection resources.

public PaginatedPersonMergerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPersonMergerClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPersonMergerClient

The current PaginatedPersonMergerClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPersonMergerClient ClearParameters()

Returns

PaginatedPersonMergerClient

The current PaginatedPersonMergerClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPersonMergerClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPersonMergerClient

The current PaginatedPersonMergerClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PersonMerger resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonMergerCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPersonMergerClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPersonMergerClient

The current PaginatedPersonMergerClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public PersonMergerClient OrderByCreatedAt()

Returns

PersonMergerClient

OrderByCreatedAtDescending()

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

public PersonMergerClient OrderByCreatedAtDescending()

Returns

PersonMergerClient

PerPage(int)

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

public PaginatedPersonMergerClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPersonMergerClient

The current PaginatedPersonMergerClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public PersonMergerClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

PersonMergerClient

WherePersonToKeepId(string)

Query response items by the PersonToKeepId attribute.

public PersonMergerClient WherePersonToKeepId(string value)

Parameters

value string

Returns

PersonMergerClient

WherePersonToRemoveId(string)

Query response items by the PersonToRemoveId attribute.

public PersonMergerClient WherePersonToRemoveId(string value)

Parameters

value string

Returns

PersonMergerClient

WithId(string)

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

public PersonMergerClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PersonMergerClient

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