Skip to main content

Service

Struct Service 

Source
pub struct Service<T>
where T: XrpcClient + Send + Sync,
{ /* private fields */ }
Available on crate feature namespace-chatbsky only.

Implementations§

Source§

impl<T> Service<T>
where T: XrpcClient + Send + Sync,

Source

pub async fn accept_convo(&self, input: Input) -> Result<Output, Error>

Marks a conversation as accepted, so it is shown in the list of accepted convos instead on the request convos.

Source

pub async fn add_reaction(&self, input: Input) -> Result<Output, Error>

Adds an emoji reaction to a message. Requires authentication. It is idempotent, so multiple calls from the same user with the same emoji result in a single reaction.

Source

pub async fn delete_message_for_self( &self, input: Input, ) -> Result<Output, Error>

Marks a message as deleted for the viewer, so they won’t see that message in future enumerations.

Source

pub async fn get_convo(&self, params: Parameters) -> Result<Output, Error>

Gets an existing conversation by its ID.

Source

pub async fn get_convo_availability( &self, params: Parameters, ) -> Result<Output, Error>

Check whether the requester and the other members can start a 1-1 chat. Only applicable to direct (non-group) conversations. If an existing convo is found for these members, it is returned. Does not create a new convo if it doesn’t exist.

Source

pub async fn get_convo_for_members( &self, params: Parameters, ) -> Result<Output, Error>

Get or create a 1-1 conversation for the given members. Always returns the same direct (non-group) conversation. To create a group conversation, use createGroup.

Source

pub async fn get_convo_members( &self, params: Parameters, ) -> Result<Output, Error>

Returns a paginated list of members from a conversation.

Source

pub async fn get_log(&self, params: Parameters) -> Result<Output, Error>

Source

pub async fn get_messages(&self, params: Parameters) -> Result<Output, Error>

Returns a page of messages from a conversation.

Source

pub async fn get_unread_counts( &self, params: Parameters, ) -> Result<Output, Error>

Returns unread conversation counts for conversations that are unlocked, not muted, split by convo status. Direct convos are excluded when a block relationship exists between the actor and the other member, or when the other member’s account is deleted or deactivated. Group convos are considered unread if they have unread join request counts.

Source

pub async fn leave_convo(&self, input: Input) -> Result<Output, Error>

Leaves a conversation (direct or group). For group, this effectively removes membership. For direct, membership is never removed, only changed to remove from enumerations by the user who left.

Source

pub async fn list_convo_requests( &self, params: Parameters, ) -> Result<Output, Error>

Returns a page of incoming conversation requests for the user. Direct convo requests are returned as convoView; group join requests made by the user are returned as joinRequestConvoView.

Source

pub async fn list_convos(&self, params: Parameters) -> Result<Output, Error>

Returns a page of conversations (direct or group) for the user.

Source

pub async fn lock_convo(&self, input: Input) -> Result<Output, Error>

Locks a group convo so no more content (messages, reactions) can be added to it.

Source

pub async fn mute_convo(&self, input: Input) -> Result<Output, Error>

Mutes a conversation, preventing notifications related to it.

Source

pub async fn remove_reaction(&self, input: Input) -> Result<Output, Error>

Removes an emoji reaction from a message. Requires authentication. It is idempotent, so multiple calls from the same user with the same emoji result in that reaction not being present, even if it already wasn’t.

Source

pub async fn send_message(&self, input: Input) -> Result<Output, Error>

Sends a message to a conversation.

Source

pub async fn send_message_batch(&self, input: Input) -> Result<Output, Error>

Sends a batch of messages to a conversation.

Source

pub async fn unlock_convo(&self, input: Input) -> Result<Output, Error>

Unlocks a group convo so it is able to receive new content.

Source

pub async fn unmute_convo(&self, input: Input) -> Result<Output, Error>

Unmutes a conversation, allowing notifications related to it.

Source

pub async fn update_all_read(&self, input: Input) -> Result<Output, Error>

Sets conversations from a user as read to the latest message, with filters.

Source

pub async fn update_read(&self, input: Input) -> Result<Output, Error>

Updates the read state of a conversation from, optionally specifying the last read message.

Auto Trait Implementations§

§

impl<T> Freeze for Service<T>
where Arc<T>: Freeze, PhantomData<T>: Freeze,

§

impl<T> RefUnwindSafe for Service<T>

§

impl<T> Send for Service<T>
where Arc<T>: Send, PhantomData<T>: Send,

§

impl<T> Sync for Service<T>
where Arc<T>: Sync, PhantomData<T>: Sync,

§

impl<T> Unpin for Service<T>
where Arc<T>: Unpin, PhantomData<T>: Unpin,

§

impl<T> UnsafeUnpin for Service<T>

§

impl<T> UnwindSafe for Service<T>

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, C> Cacheable<C> for T

Source§

fn cached(self, cache: C) -> Cached<T, C>

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<P, T> Throttleable<P> for T
where P: Default,

Source§

fn throttled(self) -> Throttled<T, P>

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.