Class PaginatedPeopleImportHistoryClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PeopleImportHistory collection resources.

public class PaginatedPeopleImportHistoryClient : PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>

Inheritance

object

ResourceClient<PeopleImportHistory>

PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>

PaginatedPeopleImportHistoryClient

Inherited Members

PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>.PerPage(int)

PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>.Offset(int)

PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>.Filter(string)

PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>.PostAsync(PeopleImportHistory, CancellationToken)

PaginatedResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryCollectionResponse, PeopleImportHistoryResponse>.PostAsync(JsonApiDocument<PeopleImportHistoryResource>, CancellationToken)

ResourceClient<PeopleImportHistory>.AddQueryParameter(string, string)

ResourceClient<PeopleImportHistory>.ReplaceQueryParameter(string, string)

ResourceClient<PeopleImportHistory>.AddCustomParameter(string, string)

ResourceClient<PeopleImportHistory>.ClearParameters()

ResourceClient<PeopleImportHistory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PeopleImportHistory>.Uri

ResourceClient<PeopleImportHistory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPeopleImportHistoryClient(HttpClient, Uri)

Client for interacting with PeopleImportHistory collection resources.

public PaginatedPeopleImportHistoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PeopleImportHistory resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PeopleImportHistoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeHousehold()

Include related Household resources in the response.

public PeopleImportHistoryClient IncludeHousehold()

Returns

PeopleImportHistoryClient

IncludePerson()

Include related Person resources in the response.

public PeopleImportHistoryClient IncludePerson()

Returns

PeopleImportHistoryClient

WhereName(string)

Query response items by the Name attribute.

public PeopleImportHistoryClient WhereName(string value)

Parameters

value string

Returns

PeopleImportHistoryClient

WithId(string)

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

public PeopleImportHistoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PeopleImportHistoryClient

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