Class PaginatedOrganizationClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Organization collection resources.

public class PaginatedOrganizationClient : PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>

Inheritance

object

ResourceClient<Organization>

PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>

PaginatedOrganizationClient

Inherited Members

PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>.PerPage(int)

PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>.Offset(int)

PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>.Filter(string)

PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>.PostAsync(Organization, CancellationToken)

PaginatedResourceClient<Organization, OrganizationResource, OrganizationCollectionResponse, OrganizationResponse>.PostAsync(JsonApiDocument<OrganizationResource>, CancellationToken)

ResourceClient<Organization>.AddQueryParameter(string, string)

ResourceClient<Organization>.ReplaceQueryParameter(string, string)

ResourceClient<Organization>.AddCustomParameter(string, string)

ResourceClient<Organization>.ClearParameters()

ResourceClient<Organization>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Organization>.Uri

ResourceClient<Organization>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedOrganizationClient(HttpClient, Uri)

Client for interacting with Organization collection resources.

public PaginatedOrganizationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Organization resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OrganizationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public OrganizationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

OrganizationClient

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