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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPublicViewClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPublicViewClient

The current PaginatedPublicViewClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPublicViewClient ClearParameters()

Returns

PaginatedPublicViewClient

The current PaginatedPublicViewClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPublicViewClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPublicViewClient

The current PaginatedPublicViewClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPublicViewClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPublicViewClient

The current PaginatedPublicViewClient instance.

PerPage(int)

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

public PaginatedPublicViewClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPublicViewClient

The current PaginatedPublicViewClient instance.

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.