Skip to main content

TalkClient

nextcloud_talk

Struct TalkClient 

Source 
pub struct TalkClient<'a, T: Transport, A: AuthProvider> { /* private fields */ }
Expand description

Asynchronous client for Nextcloud Talk (Spreed) API.

Wraps an OcsClient by reference and provides high-level typed calls for:

  • Listing conversations / rooms (/ocs/v2.php/apps/spreed/api/v4/room)
  • Fetching conversation details by token (/ocs/v2.php/apps/spreed/api/v4/room/{token})
  • Creating conversations (/ocs/v2.php/apps/spreed/api/v4/room)
  • Deleting conversations (/ocs/v2.php/apps/spreed/api/v4/room/{token})
  • Listing chat messages (/ocs/v2.php/apps/spreed/api/v1/chat/{token})
  • Sending chat messages (/ocs/v2.php/apps/spreed/api/v1/chat/{token})

Implementations§

Source§

impl<'a, T: Transport, A: AuthProvider> TalkClient<'a, T, A>

Source

pub const fn new(ocs: &'a OcsClient<T, A>) -> Self

Binds a talk client to an underlying OcsClient.

Source

pub const fn ocs(&self) -> &'a OcsClient<T, A>

Borrows the underlying OcsClient.

Source

pub async fn list_rooms(&self) -> Result<Vec<Room>, Error>

Lists all conversations the authenticated user belongs to.

Sends GET /ocs/v2.php/apps/spreed/api/v4/room.

Source

pub async fn get_room(&self, token: &str) -> Result<Room, Error>

Retrieves conversation details for a specific room token.

Sends GET /ocs/v2.php/apps/spreed/api/v4/room/{token}.

Source

pub async fn create_room( &self, room_type: RoomType, invite: Option<&str>, name: Option<&str>, ) -> Result<Room, Error>

Creates a new conversation room.

Sends POST /ocs/v2.php/apps/spreed/api/v4/room.

Source

pub async fn delete_room(&self, token: &str) -> Result<(), Error>

Deletes a conversation room by its token.

Sends DELETE /ocs/v2.php/apps/spreed/api/v4/room/{token}.

Source

pub async fn list_messages( &self, token: &str, limit: Option<u32>, ) -> Result<Vec<ChatMessage>, Error>

Lists chat messages in a conversation.

Sends GET /ocs/v2.php/apps/spreed/api/v1/chat/{token} with lookIntoFuture=0 and optional limit.

Source

pub async fn send_message( &self, token: &str, message: &str, ) -> Result<ChatMessage, Error>

Sends a new chat message to a conversation.

Sends POST /ocs/v2.php/apps/spreed/api/v1/chat/{token} with {"message": "..."}.

Trait Implementations§

Source§

impl<'a, T: Clone + Transport, A: Clone + AuthProvider> Clone for TalkClient<'a, T, 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, T: Copy + Transport, A: Copy + AuthProvider> Copy for TalkClient<'a, T, A>

Source§

impl<'a, T: Debug + Transport, A: Debug + AuthProvider> Debug for TalkClient<'a, T, A>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T, A> Freeze for TalkClient<'a, T, A>
where &'a OcsClient<T, A>: Freeze,

§

impl<'a, T, A> RefUnwindSafe for TalkClient<'a, T, A>
where &'a OcsClient<T, A>: RefUnwindSafe,

§

impl<'a, T, A> Send for TalkClient<'a, T, A>
where &'a OcsClient<T, A>: Send,

§

impl<'a, T, A> Sync for TalkClient<'a, T, A>
where &'a OcsClient<T, A>: Sync,

§

impl<'a, T, A> Unpin for TalkClient<'a, T, A>
where &'a OcsClient<T, A>: Unpin,

§

impl<'a, T, A> UnsafeUnpin for TalkClient<'a, T, A>
where &'a OcsClient<T, A>: UnsafeUnpin,

§

impl<'a, T, A> UnwindSafe for TalkClient<'a, T, A>
where &'a OcsClient<T, A>: UnwindSafe,

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