Class PaginatedHouseholdMembershipClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with HouseholdMembership collection resources.

public class PaginatedHouseholdMembershipClient : PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>

Inheritance

object

ResourceClient<HouseholdMembership>

PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>

PaginatedHouseholdMembershipClient

Inherited Members

PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>.PerPage(int)

PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>.Offset(int)

PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>.Filter(string)

PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>.PostAsync(HouseholdMembership, CancellationToken)

PaginatedResourceClient<HouseholdMembership, HouseholdMembershipResource, HouseholdMembershipCollectionResponse, HouseholdMembershipResponse>.PostAsync(JsonApiDocument<HouseholdMembershipResource>, CancellationToken)

ResourceClient<HouseholdMembership>.AddQueryParameter(string, string)

ResourceClient<HouseholdMembership>.ReplaceQueryParameter(string, string)

ResourceClient<HouseholdMembership>.AddCustomParameter(string, string)

ResourceClient<HouseholdMembership>.ClearParameters()

ResourceClient<HouseholdMembership>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<HouseholdMembership>.Uri

ResourceClient<HouseholdMembership>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedHouseholdMembershipClient(HttpClient, Uri)

Client for interacting with HouseholdMembership collection resources.

public PaginatedHouseholdMembershipClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of HouseholdMembership resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<HouseholdMembershipCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeHousehold()

Include related Household resources in the response.

public HouseholdMembershipClient IncludeHousehold()

Returns

HouseholdMembershipClient

IncludePerson()

Include related Person resources in the response.

public HouseholdMembershipClient IncludePerson()

Returns

HouseholdMembershipClient

OrderByPending()

Sort response items by the Pending attribute.

public HouseholdMembershipClient OrderByPending()

Returns

HouseholdMembershipClient

OrderByPendingDescending()

Sort response items by the Pending attribute. Use reverse order.

public HouseholdMembershipClient OrderByPendingDescending()

Returns

HouseholdMembershipClient

OrderByPersonName()

Sort response items by the PersonName attribute.

public HouseholdMembershipClient OrderByPersonName()

Returns

HouseholdMembershipClient

OrderByPersonNameDescending()

Sort response items by the PersonName attribute. Use reverse order.

public HouseholdMembershipClient OrderByPersonNameDescending()

Returns

HouseholdMembershipClient

PostAsync(HouseholdMembership, CancellationToken)

Creates a new HouseholdMembership resource asynchronously.

public Task<HouseholdMembershipResponse> PostAsync(HouseholdMembership resource, CancellationToken cancellationToken = default)

Parameters

resource HouseholdMembership

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<HouseholdMembershipResponse>

A task representing the asynchronous operation, containing the created HouseholdMembership resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<HouseholdMembershipResource>, CancellationToken)

Creates a new HouseholdMembership resource asynchronously.

public Task<HouseholdMembershipResponse> PostAsync(JsonApiDocument<HouseholdMembershipResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<HouseholdMembershipResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<HouseholdMembershipResponse>

A task representing the asynchronous operation, containing the created HouseholdMembership resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WherePending(bool)

Query response items by the Pending attribute.

public HouseholdMembershipClient WherePending(bool value)

Parameters

value bool

Returns

HouseholdMembershipClient

WherePersonName(string)

Query response items by the PersonName attribute.

public HouseholdMembershipClient WherePersonName(string value)

Parameters

value string

Returns

HouseholdMembershipClient

WithId(string)

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

public HouseholdMembershipClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

HouseholdMembershipClient

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