Struct zoom_api::im_chat::ImChat

source · [−]

pub struct ImChat {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl ImChat

source

pub async fn session(
 &self,
 from: NaiveDate,
 to: NaiveDate,
 page_size: i64,
 next_page_token: &str
) -> Result<ImChatSessionsResponseAllOf>

Get IM chat sessions.

This function performs a GET to the /im/chat/sessions endpoint.

Retrieve IM Chat sessions for a specified period of time. This API only supports Oauth2.

Scopes: imchat:read, imchat:read:admin
Rate Limit Label: Heavy

Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.

Parameters:

from: chrono::NaiveDate – Start date in ‘yyyy-mm-dd’ format. The date range defined by the “from” and “to” parameters should only be one month as the report includes only one month worth of data at once.
to: chrono::NaiveDate – Start Date.
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 message(
 &self,
 session_id: &str,
 from: NaiveDate,
 to: NaiveDate,
 page_size: i64,
 next_page_token: &str
) -> Result<ImChatMessagesResponseAllOf>

Get IM chat messages.

This function performs a GET to the /im/chat/sessions/{sessionId} endpoint.

Retrieve IM chat messages for a specified period of time. This API only supports oauth2.

Scopes: imchat:read

Rate Limit Label: Medium

Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.

Parameters:

session_id: &str – User’s first name.
from: chrono::NaiveDate – Start date in ‘yyyy-mm-dd’ format. The date range defined by the “from” and “to” parameters should only be one month as the report includes only one month worth of data at once.
to: chrono::NaiveDate – Start Date.
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_im_messages(
 &self,
 user_id: &str,
 chat_user: &str,
 channel: &str,
 date: &str,
 page_size: i64,
 next_page_token: &str
) -> Result<Vec<ListimmessagesResponseMessages>>

Get user’s IM messages.

This function performs a GET to the /im/users/{userId}/chat/messages endpoint.

Get IM Chat messages for a specified period of time. This API only supports Oauth2.
Scopes: imchat:read
Rate Limit Label: Medium

Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.

Parameters:

user_id: &str – The user ID or email address.
chat_user: &str – Chat user’s ID or email address.
channel: &str – User’s first name.
date: &str – IM message’s query date time, format as yyyy-MM-dd.
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_im_messages(
 &self,
 user_id: &str,
 chat_user: &str,
 channel: &str,
 date: &str
) -> Result<Vec<ListimmessagesResponseMessages>>

Get user’s IM messages.

This function performs a GET to the /im/users/{userId}/chat/messages endpoint.

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

Get IM Chat messages for a specified period of time. This API only supports Oauth2.
Scopes: imchat:read
Rate Limit Label: Medium

Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.

source

pub async fn send_im_messages(
 &self,
 chat_user: &str,
 body: &SendimmessagesRequest
) -> Result<Groups>

Send IM messages.

This function performs a POST to the /im/users/me/chat/messages endpoint.

Send chat message to a user.

Scope: imchat:write

Rate Limit Label: Medium

Parameters:

chat_user: &str – The email address (registered with Zoom) or the userId of the chat user.

Auto Trait Implementations

impl !RefUnwindSafe for ImChat

impl Send for ImChat

impl Sync for ImChat

impl Unpin for ImChat

impl !UnwindSafe for ImChat

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::im_chat::ImChat

Fields

Implementations

impl ImChat

pub async fn session( &self, from: NaiveDate, to: NaiveDate, page_size: i64, next_page_token: &str) -> Result<ImChatSessionsResponseAllOf>

pub async fn message( &self, session_id: &str, from: NaiveDate, to: NaiveDate, page_size: i64, next_page_token: &str) -> Result<ImChatMessagesResponseAllOf>

pub async fn list_im_messages( &self, user_id: &str, chat_user: &str, channel: &str, date: &str, page_size: i64, next_page_token: &str) -> Result<Vec<ListimmessagesResponseMessages>>

pub async fn list_all_im_messages( &self, user_id: &str, chat_user: &str, channel: &str, date: &str) -> Result<Vec<ListimmessagesResponseMessages>>

pub async fn send_im_messages( &self, chat_user: &str, body: &SendimmessagesRequest) -> Result<Groups>

Auto Trait Implementations

impl !RefUnwindSafe for ImChat

impl Send for ImChat

impl Sync for ImChat

impl Unpin for ImChat

impl !UnwindSafe for ImChat

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 session(
&self,
from: NaiveDate,
to: NaiveDate,
page_size: i64,
next_page_token: &str
) -> Result<ImChatSessionsResponseAllOf>

pub async fn message(
&self,
session_id: &str,
from: NaiveDate,
to: NaiveDate,
page_size: i64,
next_page_token: &str
) -> Result<ImChatMessagesResponseAllOf>

pub async fn list_im_messages(
&self,
user_id: &str,
chat_user: &str,
channel: &str,
date: &str,
page_size: i64,
next_page_token: &str
) -> Result<Vec<ListimmessagesResponseMessages>>

pub async fn list_all_im_messages(
&self,
user_id: &str,
chat_user: &str,
channel: &str,
date: &str
) -> Result<Vec<ListimmessagesResponseMessages>>

pub async fn send_im_messages(
&self,
chat_user: &str,
body: &SendimmessagesRequest
) -> Result<Groups>

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>,