Class PaginatedZoomClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Zoom collection resources.

public class PaginatedZoomClient : PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>

Inheritance

object

ResourceClient<Zoom>

PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>

PaginatedZoomClient

Inherited Members

PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>.PerPage(int)

PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>.Offset(int)

PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>.Filter(string)

PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>.PostAsync(Zoom, CancellationToken)

PaginatedResourceClient<Zoom, ZoomResource, ZoomCollectionResponse, ZoomResponse>.PostAsync(JsonApiDocument<ZoomResource>, CancellationToken)

ResourceClient<Zoom>.AddQueryParameter(string, string)

ResourceClient<Zoom>.ReplaceQueryParameter(string, string)

ResourceClient<Zoom>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Zoom>.Uri

ResourceClient<Zoom>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedZoomClient(HttpClient, Uri)

Client for interacting with Zoom collection resources.

public PaginatedZoomClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedZoomClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedZoomClient

The current PaginatedZoomClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedZoomClient ClearParameters()

Returns

PaginatedZoomClient

The current PaginatedZoomClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedZoomClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedZoomClient

The current PaginatedZoomClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Zoom resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ZoomCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedZoomClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedZoomClient

The current PaginatedZoomClient instance.

PerPage(int)

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

public PaginatedZoomClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedZoomClient

The current PaginatedZoomClient instance.

PostAsync(Zoom, CancellationToken)

Creates a new Zoom resource asynchronously.

public Task<ZoomResponse> PostAsync(Zoom resource, CancellationToken cancellationToken = default)

Parameters

resource Zoom

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ZoomResponse>

A task representing the asynchronous operation, containing the created Zoom resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ZoomResource>, CancellationToken)

Creates a new Zoom resource asynchronously.

public Task<ZoomResponse> PostAsync(JsonApiDocument<ZoomResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ZoomResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ZoomResponse>

A task representing the asynchronous operation, containing the created Zoom resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ZoomClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ZoomClient

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