Class PaginatedPeopleImportHistoryClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPeopleImportHistoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPeopleImportHistoryClient

The current PaginatedPeopleImportHistoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPeopleImportHistoryClient ClearParameters()

Returns

PaginatedPeopleImportHistoryClient

The current PaginatedPeopleImportHistoryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPeopleImportHistoryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPeopleImportHistoryClient

The current PaginatedPeopleImportHistoryClient instance.

Remarks

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPeopleImportHistoryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPeopleImportHistoryClient

The current PaginatedPeopleImportHistoryClient instance.

PerPage(int)

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

public PaginatedPeopleImportHistoryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPeopleImportHistoryClient

The current PaginatedPeopleImportHistoryClient instance.

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.