Struct zoom_api::rooms::Rooms

source · [−]

pub struct Rooms {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Rooms

source

pub async fn list_zoom(
 &self,
 status: ListZoomRoomsStatus,
 type_: ListZoomRoomsType,
 unassigned_rooms: bool,
 page_size: i64,
 next_page_token: &str,
 location_id: &str
) -> Result<Vec<ListZoomRoomsResponse>>

List Zoom Rooms.

This function performs a GET to the /rooms endpoint.

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing Zoom Rooms in a Zoom account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters:

status: crate::types::ListZoomRoomsStatus – The status of the Zoom Room.
type_: crate::types::ListZoomRoomsType – Type of the Zoom Rooms.
unassigned_rooms: bool – Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
page_size: i64 – The number of records returned within a single API call.
next_page_token: &str – The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
location_id: &str – Parent location ID of the Zoom Room.

source

pub async fn list_all_zoom(
 &self,
 status: ListZoomRoomsStatus,
 type_: ListZoomRoomsType,
 unassigned_rooms: bool,
 location_id: &str
) -> Result<Vec<ListZoomRoomsResponse>>

List Zoom Rooms.

This function performs a GET to the /rooms endpoint.

As opposed to list_zoom, this function returns all the pages of the request at once.

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing Zoom Rooms in a Zoom account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: Medium

source

pub async fn add(&self, body: &AddRoomRequest) -> Result<AddRoomResponse>

Add a Zoom Room.

This function performs a POST to the /rooms endpoint.

Use this API to add a Zoom Room to a Zoom account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Medium

source

pub async fn get_zr_profile(
&self,
room_id: &str
) -> Result<GetZrProfileResponse>

Get Zoom Room profile.

This function performs a GET to the /rooms/{roomId} endpoint.

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: Medium

Parameters:

room_id: &str – Unique Identifier of the Zoom Room. This can be retrieved from the response of List Zoom Rooms API.

source

pub async fn delete_zoom(&self, room_id: &str) -> Result<Domains>

Delete a Zoom Room.

This function performs a DELETE to the /rooms/{roomId} endpoint.

Remove a specific Zoom Room profile from a Zoom account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Light

Parameters:

room_id: &str – Unique Identifier of a Zoom Room.

source

pub async fn update_profile(
 &self,
 room_id: &str,
 body: &UpdateRoomProfileRequest
) -> Result<Domains>

Update a Zoom Room profile.

This function performs a PATCH to the /rooms/{roomId} endpoint.

Update basic information on a specific Zoom Room in a Zoom account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Medium

Parameters:

room_id: &str – Unique Identifier of a Zoom Room.

source

pub async fn get_zr_setting(
 &self,
 room_id: &str,
 setting_type: &str
) -> Result<Domains>

Get Zoom Room settings.

This function performs a GET to the /rooms/{roomId}/settings endpoint.

Get information on meeting or alert settings applied to a specific Zoom Room. By default, only Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter.
Prerequisites:

Zoom Room licenses
Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin

Rate Limit Label: Medium

Parameters:

setting_type: &str – The type of setting that you would like to retrieve.
alert: Alert Settings applied on the Zoom Rooms Account.
meeting: Meeting settings of the Zoom Rooms Account.
room_id: &str – Unique identifier of the Zoom Room.

source

pub async fn update_zr_settings(
 &self,
 room_id: &str,
 setting_type: &str
) -> Result<()>

Update Zoom Room settings.

This function performs a PATCH to the /rooms/{roomId}/settings endpoint.

Update either meeting or alert settings applied to a specific Zoom Room. To update Alert Settings, specify alert as the value of the setting_type query parameter. To update Meeting Settings, specify meeting as the value of the setting_type query parameter.
Prerequisites:

Zoom Room licenses
Owner or Admin privileges on the Zoom Account.
Scopes: room:write:admin
Rate Limit Label: Medium

Parameters:

room_id: &str – Unique Identifier of the Zoom Room.
setting_type: &str – The type of setting that you would like to update.
alert: Alert Settings applied on the Zoom Room.
meeting: Meeting settings of the Zoom Room.
signage: Digital signage settings applied on the Zoom Room.

source

pub async fn list_zr_devices(
&self,
room_id: &str
) -> Result<ListZrDevicesResponse>

List Zoom Room devices.

This function performs a GET to the /rooms/{roomId}/devices endpoint.

List information about the devices that are being used for a specific Zoom Room in an account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Account owner or admin permissions. Scopes: room:read:admin
Rate Limit Label: Medium

Parameters:

room_id: &str – Unique Identifier of the Zoom Room. This can be retrieved from the response of List Zoom Rooms API.

source

pub async fn change_zr_location(
 &self,
 room_id: &str,
 body: &ChangeZrLocationRequest
) -> Result<()>

Change a Zoom Room’s location.

This function performs a PUT to the /rooms/{roomId}/location endpoint.

An account owner of a Zoom account can establish a Zoom Rooms Location Hierarchy to better organize Zoom Rooms spread accress various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. Prerequisite:

Account owner or admin permission
Zoom Rooms version 4.0 or higher
Scopes: room:write:admin
Rate Limit Label: Light

Parameters:

room_id: &str – Unique Identifier of the Zoom Room.

source

pub async fn check(&self, id: &str, body: &CheckInRoomsRequest) -> Result<()>

Check-in or check-out of a Zoom Room.

This function performs a PATCH to the /rooms/{id}/events endpoint.

The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either check in and confirm that you are utilizing the room reservation or to check out of the room so that the room gets released from the scheduled meeting and will be made available for others to use. Learn more from the Using the Zoom Rooms check-in feature guide.

Prerequisites:

Zoom Rooms must have been set up for use for the account and must be online.
You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room.

Scope: room:write:admin

Parameters:

id: &str – User’s first name.

source

pub async fn list_digital_signage_content(
 &self,
 type_: &str,
 folder_id: &str,
 page_size: i64,
 next_page_token: &str
) -> Result<Vec<Site>>

List digital signage contents.

This function performs a GET to the /rooms/digital_signage endpoint.

List information about existing Zoom Rooms digital signage content in a Zoom account.
You can also access this information by logging into your Zoom account in the Zoom web portal and visiting the Digital Signage Content page listed under Room Management.

Prerequisites:

Pro or a higher account with Zoom Rooms.
Existing content files or folder in Digital Signage Content page.

Parameters:

type_: &str – Specify the type of digital signane resource. The value can be one of the following:
- content: Returns information about content files.
- folder: Returns information about the folder where the content files are located.
folder_id: &str – Unique identifier of the folder where the content is located. Provide this field if you would like to filter the response by contents that are only available in a specific folder.
page_size: i64 – The number of records returned within a single API call.
next_page_token: &str – The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

source

pub async fn list_all_digital_signage_content(
 &self,
 type_: &str,
 folder_id: &str
) -> Result<Vec<Site>>

List digital signage contents.

This function performs a GET to the /rooms/digital_signage endpoint.

As opposed to list_digital_signage_content, this function returns all the pages of the request at once.

List information about existing Zoom Rooms digital signage content in a Zoom account.
You can also access this information by logging into your Zoom account in the Zoom web portal and visiting the Digital Signage Content page listed under Room Management.

Prerequisites:

Pro or a higher account with Zoom Rooms.
Existing content files or folder in Digital Signage Content page.

source

pub async fn manage_e_91_1signage(&self) -> Result<ManageE911SignageResponse>

Update E911 digital signage.

This function performs a PATCH to the /rooms/events endpoint.

Display or hide E911 emergency alert text content from Zoom Rooms digital signage.

Scope: room:write:admin

Prerequisites:

Zoom Rooms 5.3.0 or higher
Zoom Rooms digital signage must be enabled

Auto Trait Implementations

impl !RefUnwindSafe for Rooms

impl Send for Rooms

impl Sync for Rooms

impl Unpin for Rooms

impl !UnwindSafe for Rooms

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct zoom_api::rooms::Rooms

Fields

Implementations

impl Rooms

pub async fn list_zoom( &self, status: ListZoomRoomsStatus, type_: ListZoomRoomsType, unassigned_rooms: bool, page_size: i64, next_page_token: &str, location_id: &str) -> Result<Vec<ListZoomRoomsResponse>>

pub async fn list_all_zoom( &self, status: ListZoomRoomsStatus, type_: ListZoomRoomsType, unassigned_rooms: bool, location_id: &str) -> Result<Vec<ListZoomRoomsResponse>>

pub async fn add(&self, body: &AddRoomRequest) -> Result<AddRoomResponse>

pub async fn get_zr_profile( &self, room_id: &str) -> Result<GetZrProfileResponse>

pub async fn delete_zoom(&self, room_id: &str) -> Result<Domains>

pub async fn update_profile( &self, room_id: &str, body: &UpdateRoomProfileRequest) -> Result<Domains>

pub async fn get_zr_setting( &self, room_id: &str, setting_type: &str) -> Result<Domains>

pub async fn update_zr_settings( &self, room_id: &str, setting_type: &str) -> Result<()>

pub async fn list_zr_devices( &self, room_id: &str) -> Result<ListZrDevicesResponse>

pub async fn change_zr_location( &self, room_id: &str, body: &ChangeZrLocationRequest) -> Result<()>

pub async fn check(&self, id: &str, body: &CheckInRoomsRequest) -> Result<()>

pub async fn list_digital_signage_content( &self, type_: &str, folder_id: &str, page_size: i64, next_page_token: &str) -> Result<Vec<Site>>

pub async fn list_all_digital_signage_content( &self, type_: &str, folder_id: &str) -> Result<Vec<Site>>

pub async fn manage_e_91_1signage(&self) -> Result<ManageE911SignageResponse>

Auto Trait Implementations

impl !RefUnwindSafe for Rooms

impl Send for Rooms

impl Sync for Rooms

impl Unpin for Rooms

impl !UnwindSafe for Rooms

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn list_zoom(
&self,
status: ListZoomRoomsStatus,
type_: ListZoomRoomsType,
unassigned_rooms: bool,
page_size: i64,
next_page_token: &str,
location_id: &str
) -> Result<Vec<ListZoomRoomsResponse>>

pub async fn list_all_zoom(
&self,
status: ListZoomRoomsStatus,
type_: ListZoomRoomsType,
unassigned_rooms: bool,
location_id: &str
) -> Result<Vec<ListZoomRoomsResponse>>

pub async fn get_zr_profile(
&self,
room_id: &str
) -> Result<GetZrProfileResponse>

pub async fn update_profile(
&self,
room_id: &str,
body: &UpdateRoomProfileRequest
) -> Result<Domains>

pub async fn get_zr_setting(
&self,
room_id: &str,
setting_type: &str
) -> Result<Domains>

pub async fn update_zr_settings(
&self,
room_id: &str,
setting_type: &str
) -> Result<()>

pub async fn list_zr_devices(
&self,
room_id: &str
) -> Result<ListZrDevicesResponse>

pub async fn change_zr_location(
&self,
room_id: &str,
body: &ChangeZrLocationRequest
) -> Result<()>

pub async fn list_digital_signage_content(
&self,
type_: &str,
folder_id: &str,
page_size: i64,
next_page_token: &str
) -> Result<Vec<Site>>

pub async fn list_all_digital_signage_content(
&self,
type_: &str,
folder_id: &str
) -> Result<Vec<Site>>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,