Class PaginatedPeopleImportClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PeopleImport collection resources.

public class PaginatedPeopleImportClient : PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>

Inheritance

object

ResourceClient<PeopleImport>

PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>

PaginatedPeopleImportClient

Inherited Members

PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>.PerPage(int)

PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>.Offset(int)

PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>.Filter(string)

PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>.PostAsync(PeopleImport, CancellationToken)

PaginatedResourceClient<PeopleImport, PeopleImportResource, PeopleImportCollectionResponse, PeopleImportResponse>.PostAsync(JsonApiDocument<PeopleImportResource>, CancellationToken)

ResourceClient<PeopleImport>.AddQueryParameter(string, string)

ResourceClient<PeopleImport>.ReplaceQueryParameter(string, string)

ResourceClient<PeopleImport>.AddCustomParameter(string, string)

ResourceClient<PeopleImport>.ClearParameters()

ResourceClient<PeopleImport>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PeopleImport>.Uri

ResourceClient<PeopleImport>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPeopleImportClient(HttpClient, Uri)

Client for interacting with PeopleImport collection resources.

public PaginatedPeopleImportClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PeopleImport resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PeopleImportCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereStatus(string)

Query response items by the Status attribute.

public PeopleImportClient WhereStatus(string value)

Parameters

value string

Returns

PeopleImportClient

WithId(string)

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

public PeopleImportClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PeopleImportClient

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