Class PaginatedOwnerClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Owner collection resources.

public class PaginatedOwnerClient : PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>

Inheritance

object

ResourceClient<Owner>

PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>

PaginatedOwnerClient

Inherited Members

PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>.PerPage(int)

PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>.Offset(int)

PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>.Filter(string)

PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>.PostAsync(Owner, CancellationToken)

PaginatedResourceClient<Owner, OwnerResource, OwnerCollectionResponse, OwnerResponse>.PostAsync(JsonApiDocument<OwnerResource>, CancellationToken)

ResourceClient<Owner>.AddQueryParameter(string, string)

ResourceClient<Owner>.ReplaceQueryParameter(string, string)

ResourceClient<Owner>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Owner>.Uri

ResourceClient<Owner>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedOwnerClient(HttpClient, Uri)

Client for interacting with Owner collection resources.

public PaginatedOwnerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedOwnerClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedOwnerClient

The current PaginatedOwnerClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedOwnerClient ClearParameters()

Returns

PaginatedOwnerClient

The current PaginatedOwnerClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedOwnerClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedOwnerClient

The current PaginatedOwnerClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Owner resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OwnerCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedOwnerClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedOwnerClient

The current PaginatedOwnerClient instance.

PerPage(int)

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

public PaginatedOwnerClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedOwnerClient

The current PaginatedOwnerClient instance.

WithId(string)

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

public OwnerClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

OwnerClient

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