Class PaginatedPublicViewClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PublicView collection resources.

public class PaginatedPublicViewClient : PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>

Inheritance

object

ResourceClient<PublicView>

PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>

PaginatedPublicViewClient

Inherited Members

PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>.PerPage(int)

PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>.Offset(int)

PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>.Filter(string)

PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>.PostAsync(PublicView, CancellationToken)

PaginatedResourceClient<PublicView, PublicViewResource, PublicViewCollectionResponse, PublicViewResponse>.PostAsync(JsonApiDocument<PublicViewResource>, CancellationToken)

ResourceClient<PublicView>.AddQueryParameter(string, string)

ResourceClient<PublicView>.ReplaceQueryParameter(string, string)

ResourceClient<PublicView>.AddCustomParameter(string, string)

ResourceClient<PublicView>.ClearParameters()

ResourceClient<PublicView>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PublicView>.Uri

ResourceClient<PublicView>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPublicViewClient(HttpClient, Uri)

Client for interacting with PublicView collection resources.

public PaginatedPublicViewClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PublicView resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PublicViewCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public PublicViewClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PublicViewClient

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