Class PaginatedZoomClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_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>.AddCustomParameter(string, string)

ResourceClient<Zoom>.ClearParameters()

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

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.

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.