Class PersonClient

Namespace

Crews.PlanningCenter.Api.People.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Person resource.

public class PersonClient : SingletonResourceClient<Person, PersonResource, PersonResponse>

Inheritance

object

ResourceClient<Person>

SingletonResourceClient<Person, PersonResource, PersonResponse>

PersonClient

Inherited Members

SingletonResourceClient<Person, PersonResource, PersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(Person, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(JsonApiDocument<PersonResource>, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<Person>.AddQueryParameter(string, string)

ResourceClient<Person>.ReplaceQueryParameter(string, string)

ResourceClient<Person>.AddCustomParameter(string, string)

ResourceClient<Person>.ClearParameters()

ResourceClient<Person>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Person>.Uri

ResourceClient<Person>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PersonClient(HttpClient, Uri)

Client for interacting with the Person resource.

public PersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Addresses

Associated Addresses.

public PaginatedAddressClient Addresses { get; }

Property Value

PaginatedAddressClient

Apps

Associated Apps.

public PaginatedAppClient Apps { get; }

Property Value

PaginatedAppClient

ConnectedPeople

Associated ConnectedPeople.

public PaginatedConnectedPersonClient ConnectedPeople { get; }

Property Value

PaginatedConnectedPersonClient

Emails

Associated Emails.

public PaginatedEmailClient Emails { get; }

Property Value

PaginatedEmailClient

FieldData

Associated FieldData.

public PaginatedFieldDatumClient FieldData { get; }

Property Value

PaginatedFieldDatumClient

HouseholdMemberships

Associated HouseholdMemberships.

public PaginatedHouseholdMembershipClient HouseholdMemberships { get; }

Property Value

PaginatedHouseholdMembershipClient

Households

Associated Households.

public PaginatedHouseholdClient Households { get; }

Property Value

PaginatedHouseholdClient

InactiveReason

Associated InactiveReason.

public InactiveReasonClient InactiveReason { get; }

Property Value

InactiveReasonClient

MaritalStatus

Associated MaritalStatus.

public PaginatedMaritalStatusClient MaritalStatus { get; }

Property Value

PaginatedMaritalStatusClient

MessageGroups

Associated MessageGroups.

public PaginatedMessageGroupClient MessageGroups { get; }

Property Value

PaginatedMessageGroupClient

Messages

Associated Messages.

public PaginatedMessageClient Messages { get; }

Property Value

PaginatedMessageClient

NamePrefix

Associated NamePrefix.

public NamePrefixClient NamePrefix { get; }

Property Value

NamePrefixClient

NameSuffix

Associated NameSuffix.

public NameSuffixClient NameSuffix { get; }

Property Value

NameSuffixClient

Notes

Associated Notes.

public PaginatedNoteClient Notes { get; }

Property Value

PaginatedNoteClient

Organization

Associated Organization.

public OrganizationClient Organization { get; }

Property Value

OrganizationClient

PersonApps

Associated PersonApps.

public PaginatedPersonAppClient PersonApps { get; }

Property Value

PaginatedPersonAppClient

PhoneNumbers

Associated PhoneNumbers.

public PaginatedPhoneNumberClient PhoneNumbers { get; }

Property Value

PaginatedPhoneNumberClient

PlatformNotifications

Associated PlatformNotifications.

public PaginatedPlatformNotificationClient PlatformNotifications { get; }

Property Value

PaginatedPlatformNotificationClient

PrimaryCampus

Associated PrimaryCampus.

public PaginatedCampusClient PrimaryCampus { get; }

Property Value

PaginatedCampusClient

School

Associated School.

public SchoolOptionClient School { get; }

Property Value

SchoolOptionClient

SocialProfiles

Associated SocialProfiles.

public PaginatedSocialProfileClient SocialProfiles { get; }

Property Value

PaginatedSocialProfileClient

WorkflowCards

Associated WorkflowCards.

public PaginatedWorkflowCardClient WorkflowCards { get; }

Property Value

PaginatedWorkflowCardClient

WorkflowShares

Associated WorkflowShares.

public PaginatedWorkflowShareClient WorkflowShares { get; }

Property Value

PaginatedWorkflowShareClient

Methods

DeleteAsync(CancellationToken)

Deletes the Person resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Person resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeAddresses()

Include related Addresses resources in the response.

public PersonClient IncludeAddresses()

Returns

PersonClient

IncludeEmails()

Include related Emails resources in the response.

public PersonClient IncludeEmails()

Returns

PersonClient

IncludeFieldData()

Include related FieldData resources in the response.

public PersonClient IncludeFieldData()

Returns

PersonClient

IncludeHouseholds()

Include related Households resources in the response.

public PersonClient IncludeHouseholds()

Returns

PersonClient

IncludeInactiveReason()

Include related InactiveReason resources in the response.

public PersonClient IncludeInactiveReason()

Returns

PersonClient

IncludeMaritalStatus()

Include related MaritalStatus resources in the response.

public PersonClient IncludeMaritalStatus()

Returns

PersonClient

IncludeNamePrefix()

Include related NamePrefix resources in the response.

public PersonClient IncludeNamePrefix()

Returns

PersonClient

IncludeNameSuffix()

Include related NameSuffix resources in the response.

public PersonClient IncludeNameSuffix()

Returns

PersonClient

IncludeOrganization()

Include related Organization resources in the response.

public PersonClient IncludeOrganization()

Returns

PersonClient

IncludePersonApps()

Include related PersonApps resources in the response.

public PersonClient IncludePersonApps()

Returns

PersonClient

IncludePhoneNumbers()

Include related PhoneNumbers resources in the response.

public PersonClient IncludePhoneNumbers()

Returns

PersonClient

IncludePlatformNotifications()

Include related PlatformNotifications resources in the response.

public PersonClient IncludePlatformNotifications()

Returns

PersonClient

IncludePrimaryCampus()

Include related PrimaryCampus resources in the response.

public PersonClient IncludePrimaryCampus()

Returns

PersonClient

IncludeSchool()

Include related School resources in the response.

public PersonClient IncludeSchool()

Returns

PersonClient

IncludeSocialProfiles()

Include related SocialProfiles resources in the response.

public PersonClient IncludeSocialProfiles()

Returns

PersonClient

PatchAsync(Person, CancellationToken)

Updates an existing Person resource asynchronously.

public Task<PersonResponse> PatchAsync(Person resource, CancellationToken cancellationToken = default)

Parameters

resource Person

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonResponse>

A task representing the asynchronous operation, containing the updated Person resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<PersonResource>, CancellationToken)

Updates an existing Person resource asynchronously.

public Task<PersonResponse> PatchAsync(JsonApiDocument<PersonResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PersonResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonResponse>

A task representing the asynchronous operation, containing the updated Person resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.