Class ZoomClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Zoom resource.

public class ZoomClient : SingletonResourceClient<Zoom, ZoomResource, ZoomResponse>

Inheritance

object

ResourceClient<Zoom>

SingletonResourceClient<Zoom, ZoomResource, ZoomResponse>

ZoomClient

Inherited Members

SingletonResourceClient<Zoom, ZoomResource, ZoomResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Zoom, ZoomResource, ZoomResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Zoom, ZoomResource, ZoomResponse>.PatchAsync(Zoom, CancellationToken)

SingletonResourceClient<Zoom, ZoomResource, ZoomResponse>.PatchAsync(JsonApiDocument<ZoomResource>, CancellationToken)

SingletonResourceClient<Zoom, ZoomResource, ZoomResponse>.DeleteAsync(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

ZoomClient(HttpClient, Uri)

Client for interacting with the Zoom resource.

public ZoomClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ZoomClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ZoomClient

The current ZoomClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ZoomClient ClearParameters()

Returns

ZoomClient

The current ZoomClient instance.

DeleteAsync(CancellationToken)

Deletes the Zoom resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Zoom resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ZoomResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(Zoom, CancellationToken)

Updates an existing Zoom resource asynchronously.

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

Parameters

resource Zoom

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ZoomResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ZoomResource>, CancellationToken)

Updates an existing Zoom resource asynchronously.

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

Parameters

document JsonApiDocument<ZoomResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ZoomResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.