Struct Client

pub struct Client { /* private fields */ }

Entrypoint for interacting with the API client.

Implementations

impl Client

pub fn new<I, K, R, T, Q>( client_id: I, client_secret: K, redirect_uri: R, token: T, refresh_token: Q, ) -> Self

where I: ToString, K: ToString, R: ToString, T: ToString, Q: ToString,

Create a new Client struct. Requires OAuth2 configuration values as well as an access and refresh token.

Panics

This function will panic if the internal http client fails to create

pub fn set_auto_access_token_refresh(&mut self, enabled: bool) -> &mut Self

Enables or disables the automatic refreshing of access tokens upon expiration

pub async fn set_expires_at(&self, expires_at: Option<Instant>) -> &Self

Sets a specific Instant at which the access token should be considered expired. The expiration value will only be used when automatic access token refreshing is also enabled. None may be passed in if the expiration is unknown. In this case automatic refreshes will be attempted when encountering an UNAUTHENTICATED status code on a response.

pub async fn expires_at(&self) -> Option<Instant>

Gets the Instant at which the access token used by this client is set to expire if one is known

pub async fn set_expires_in(&self, expires_in: i64) -> &Self

Sets the number of seconds in which the current access token should be considered expired

pub async fn expires_in(&self) -> Option<Duration>

Gets the number of seconds from now in which the current access token will be considered expired if one is known

pub async fn is_expired(&self) -> Option<bool>

Determines if the access token currently stored in the client is expired. If the expiration can not be determined, None is returned

pub fn with_host_override<H>(&mut self, host: H) -> &mut Self

where H: ToString,

Override the host for all endpoins in the client.

pub fn remove_host_override(&mut self) -> &mut Self

Disables the global host override for the client.

pub fn get_host_override(&self) -> Option<&str>

pub fn new_from_env<T, R>(token: T, refresh_token: R) -> Self

where T: ToString, R: ToString,

Create a new Client struct from environment variables. Requires an existing access and refresh token.

The following environment variables are expected to be set:

• ZOOM_CLIENT_ID
• ZOOM_CLIENT_SECRET
• ZOOM_REDIRECT_URI

Panics

This function will panic if the expected environment variables can not be found

pub fn user_consent_url(&self, scopes: &[String]) -> String

Return a user consent url with an optional set of scopes. If no scopes are provided, they will not be passed in the url.

pub async fn refresh_access_token(&self) -> Result<AccessToken, ClientError>

Refresh an access token from a refresh token. Client must have a refresh token for this to work.

pub async fn get_access_token( &mut self, code: &str, state: &str, ) -> Result<AccessToken, ClientError>

Get an access token from the code returned by the URL paramter sent to the redirect URL.

pub fn accounts(&self) -> Accounts

pub fn archiving(&self) -> Archiving

pub fn billing(&self) -> Billing

pub fn chat_channels(&self) -> ChatChannels

pub fn chat_channels_account_level(&self) -> ChatChannelsAccountLevel

pub fn chat_messages(&self) -> ChatMessages

pub fn chatbot_messages(&self) -> ChatbotMessages

pub fn cloud_recording(&self) -> CloudRecording

pub fn common_area_phones(&self) -> CommonAreaPhones

pub fn contacts(&self) -> Contacts

pub fn dashboards(&self) -> Dashboards

pub fn deprecated_api_endpoints(&self) -> DeprecatedApiEndpoints

pub fn devices(&self) -> Devices

pub fn groups(&self) -> Groups

pub fn im_chat(&self) -> ImChat

pub fn im_groups(&self) -> ImGroups

pub fn meetings(&self) -> Meetings

pub fn pac(&self) -> Pac

pub fn phone(&self) -> Phone

pub fn phone_auto_receptionists(&self) -> PhoneAutoReceptionists

pub fn phone_blocked_list(&self) -> PhoneBlockedList

pub fn phone_call_queues(&self) -> PhoneCallQueues

pub fn phone_devices(&self) -> PhoneDevices

pub fn phone_reports(&self) -> PhoneReports

pub fn phone_shared_line_groups(&self) -> PhoneSharedLineGroups

pub fn phone_site(&self) -> PhoneSite

pub fn reports(&self) -> Reports

pub fn roles(&self) -> Roles

pub fn rooms(&self) -> Rooms

pub fn rooms_account(&self) -> RoomsAccount

pub fn rooms_devices(&self) -> RoomsDevices

pub fn rooms_location(&self) -> RoomsLocation

pub fn sip_connected_audio(&self) -> SipConnectedAudio

pub fn sip_phone(&self) -> SipPhone

pub fn tracking_field(&self) -> TrackingField

pub fn tsp(&self) -> Tsp

pub fn users(&self) -> Users

pub fn webinars(&self) -> Webinars

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.