Class PaginatedPeopleImportConflictClient

Namespace

Crews.PlanningCenter.Api.People.V2023_03_21

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PeopleImportConflict collection resources.

public class PaginatedPeopleImportConflictClient : PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>

Inheritance

object

ResourceClient<PeopleImportConflict>

PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>

PaginatedPeopleImportConflictClient

Inherited Members

PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>.PerPage(int)

PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>.Offset(int)

PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>.Filter(string)

PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>.PostAsync(PeopleImportConflict, CancellationToken)

PaginatedResourceClient<PeopleImportConflict, PeopleImportConflictResource, PeopleImportConflictCollectionResponse, PeopleImportConflictResponse>.PostAsync(JsonApiDocument<PeopleImportConflictResource>, CancellationToken)

ResourceClient<PeopleImportConflict>.AddQueryParameter(string, string)

ResourceClient<PeopleImportConflict>.ReplaceQueryParameter(string, string)

ResourceClient<PeopleImportConflict>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PeopleImportConflict>.Uri

ResourceClient<PeopleImportConflict>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPeopleImportConflictClient(HttpClient, Uri)

Client for interacting with PeopleImportConflict collection resources.

public PaginatedPeopleImportConflictClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPeopleImportConflictClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPeopleImportConflictClient

The current PaginatedPeopleImportConflictClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPeopleImportConflictClient ClearParameters()

Returns

PaginatedPeopleImportConflictClient

The current PaginatedPeopleImportConflictClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPeopleImportConflictClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPeopleImportConflictClient

The current PaginatedPeopleImportConflictClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PeopleImportConflict resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PeopleImportConflictCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPeopleImportConflictClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPeopleImportConflictClient

The current PaginatedPeopleImportConflictClient instance.

PerPage(int)

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

public PaginatedPeopleImportConflictClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPeopleImportConflictClient

The current PaginatedPeopleImportConflictClient instance.

WhereKind(string)

Query response items by the Kind attribute.

public PeopleImportConflictClient WhereKind(string value)

Parameters

value string

Returns

PeopleImportConflictClient

WhereName(string)

Query response items by the Name attribute.

public PeopleImportConflictClient WhereName(string value)

Parameters

value string

Returns

PeopleImportConflictClient

WithId(string)

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

public PeopleImportConflictClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PeopleImportConflictClient

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