Skip to main content

ChatResource

Struct ChatResource 

Source
pub struct ChatResource<'a> { /* private fields */ }
Expand description

client.chat()

Implementations§

Source§

impl<'a> ChatResource<'a>

Source

pub fn create(&self, body: &ChatCreate) -> Result<Chat>

Start new chat

POST /chat

Starts synchronization of a chat room with Matrix. New rooms have STARTING status and record the current user as creator.

§Example
let body = models::ChatCreate {
    domain_id: 9,
    guid: "681F54E3-2EB7-40A4-84F0-EFF8E8F05727".into(),
    prefix: "ctg".into(),
    roomname: "Technical team".into(),
    ..Default::default()
};
let result = client.chat().create(&body)?;
println!("{:?}", result.creator);
Source

pub fn delete(&self, guid: impl Display) -> Result<()>

Delete a chat

DELETE /chat/{guid}

Deletes the local chat room record. A missing record is treated as already deleted.

Use Self::delete_with to pass query parameters.

§Example
client.chat().delete("681F54E3-2EB7-40A4-84F0-EFF8E8F05727")?;
Source

pub fn delete_with( &self, guid: impl Display, query: &DeleteChatGuidQuery, ) -> Result<()>

Delete a chat

Like Self::delete, with query parameters.

DELETE /chat/{guid}

Deletes the local chat room record. A missing record is treated as already deleted.

Source

pub fn list(&self) -> Result<Vec<Chat>>

Get all chats

GET /chat

Returns all chat rooms, or only rooms matching the supplied synchronization token.

Use Self::list_with to pass query parameters.

§Example
for chat in client.chat().list()? {
    println!("{:?}", chat.creator);
}
Source

pub fn list_with(&self, query: &GetChatQuery) -> Result<Vec<Chat>>

Get all chats

Like Self::list, with query parameters.

GET /chat

Returns all chat rooms, or only rooms matching the supplied synchronization token.

Source

pub fn patch(&self, guid: impl Display, body: &ChatUpdate) -> Result<Chat>

Update a chat

PATCH /chat/{guid}

Updates chat room metadata or requests a lifecycle transition.

§Example
let body = models::ChatUpdate {
    creator: Some(1),
    ..Default::default()
};
let result = client.chat().patch("681F54E3-2EB7-40A4-84F0-EFF8E8F05727", &body)?;
println!("{:?}", result.creator);

Trait Implementations§

Source§

impl<'a> Clone for ChatResource<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for ChatResource<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ChatResource<'a>

§

impl<'a> !UnwindSafe for ChatResource<'a>

§

impl<'a> Freeze for ChatResource<'a>

§

impl<'a> Send for ChatResource<'a>

§

impl<'a> Sync for ChatResource<'a>

§

impl<'a> Unpin for ChatResource<'a>

§

impl<'a> UnsafeUnpin for ChatResource<'a>

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<U> for T
where U: From<T>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
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