Class PeopleImportClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PeopleImport resource.

public class PeopleImportClient : SingletonResourceClient<PeopleImport, PeopleImportResource, PeopleImportResponse>

Inheritance

object

ResourceClient<PeopleImport>

SingletonResourceClient<PeopleImport, PeopleImportResource, PeopleImportResponse>

PeopleImportClient

Inherited Members

SingletonResourceClient<PeopleImport, PeopleImportResource, PeopleImportResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PeopleImport, PeopleImportResource, PeopleImportResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PeopleImport, PeopleImportResource, PeopleImportResponse>.PatchAsync(PeopleImport, CancellationToken)

SingletonResourceClient<PeopleImport, PeopleImportResource, PeopleImportResponse>.PatchAsync(JsonApiDocument<PeopleImportResource>, CancellationToken)

SingletonResourceClient<PeopleImport, PeopleImportResource, PeopleImportResponse>.DeleteAsync(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

PeopleImportClient(HttpClient, Uri)

Client for interacting with the PeopleImport resource.

public PeopleImportClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Conflicts

Associated Conflicts.

public PaginatedPeopleImportConflictClient Conflicts { get; }

Property Value

PaginatedPeopleImportConflictClient

Histories

Associated Histories.

public PaginatedPeopleImportHistoryClient Histories { get; }

Property Value

PaginatedPeopleImportHistoryClient

Methods

GetAsync(CancellationToken)

Fetches the PeopleImport resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PeopleImportResponse>

A task representing the asynchronous operation, containing the PeopleImport resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.