Class PaginatedOwnerClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

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>.AddCustomParameter(string, string)

ResourceClient<Owner>.ClearParameters()

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

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.

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.