Struct Newsletter

Source

pub struct Newsletter<'a> { /* private fields */ }

Expand description

Feature handle for newsletter (channel) operations.

Implementations§

Source

pub async fn list_subscribed( &self, ) -> Result<Vec<NewsletterMetadata>, NewsletterError>

List all newsletters the user is subscribed to.

Source

pub async fn get_metadata( &self, jid: &Jid, ) -> Result<NewsletterMetadata, NewsletterError>

Fetch metadata for a newsletter by its JID.

Source

pub async fn create( &self, name: &str, description: Option<&str>, ) -> Result<NewsletterMetadata, NewsletterError>

Create a new newsletter.

Returns the metadata of the newly created newsletter.

Source

pub async fn join( &self, jid: &Jid, ) -> Result<NewsletterMetadata, NewsletterError>

Join (subscribe to) a newsletter.

Returns the newsletter metadata with the viewer’s role set to Subscriber.

Source

pub async fn leave(&self, jid: &Jid) -> Result<(), NewsletterError>

Leave (unsubscribe from) a newsletter.

Source

pub async fn update( &self, jid: &Jid, name: Option<&str>, description: Option<&str>, ) -> Result<NewsletterMetadata, NewsletterError>

Update a newsletter’s name and/or description.

Source

pub async fn set_follower_mute( &self, jid: &Jid, muted: bool, ) -> Result<(), NewsletterError>

Mute or unmute a newsletter’s follower-activity notifications (WA Web’s MUTE_FOLLOWER_ACTIVITY). muted = true silences them.

Source

pub async fn set_admin_mute( &self, jid: &Jid, muted: bool, ) -> Result<(), NewsletterError>

Mute or unmute a newsletter’s admin-activity notifications (WA Web’s MUTE_ADMIN_ACTIVITY). Only meaningful for owners/admins.

Source

pub async fn get_metadata_by_invite( &self, invite_code: &str, ) -> Result<NewsletterMetadata, NewsletterError>

Fetch metadata for a newsletter by its invite code.

Source

pub async fn subscribe_live_updates( &self, jid: impl Into<Jid>, ) -> Result<u64, NewsletterError>

Subscribe to live updates for a newsletter (reaction counts, message changes).

The server will send <notification type="newsletter"> stanzas with <live_updates> children, dispatched as Event::NewsletterLiveUpdate. Returns the subscription duration in seconds.

Source

pub async fn send_reaction( &self, jid: &Jid, server_id: u64, reaction: &str, ) -> Result<(), NewsletterError>

Send a reaction to a newsletter message.

server_id is the server-assigned ID of the message to react to. reaction is the emoji code (e.g., “👍”, “❤️”), or empty to remove.

Source

pub async fn edit_message( &self, jid: &Jid, message_id: impl Into<String>, new_content: Message, ) -> Result<(), NewsletterError>

Edit a message in a newsletter (channel). Channels are plaintext (not E2E).

message_id is the target message’s id (the message_id from NewsletterMessage / the id returned when it was sent), NOT its server_id (edit/revoke key on the message id, unlike reactions which use server_id). new_content is the replacement body (e.g. wa::Message { conversation: Some(..), .. }).

Source

pub async fn revoke_message( &self, jid: &Jid, message_id: impl Into<String>, ) -> Result<(), NewsletterError>

Revoke (delete) a message in a newsletter (channel).

message_id is the target message’s id (the message_id from NewsletterMessage), NOT its server_id.

Source

pub async fn get_messages( &self, jid: impl Into<Jid>, count: u32, before: Option<u64>, ) -> Result<Vec<NewsletterMessage>, NewsletterError>

Fetch message history from a newsletter.

Returns up to count messages. Use before with a server_id from a previous response to paginate backwards through history.

Newsletter

Struct Newsletter Copy item path

Implementations§

impl<'a> Newsletter<'a>

pub async fn list_subscribed( &self, ) -> Result<Vec<NewsletterMetadata>, NewsletterError>

pub async fn get_metadata( &self, jid: &Jid, ) -> Result<NewsletterMetadata, NewsletterError>

pub async fn create( &self, name: &str, description: Option<&str>, ) -> Result<NewsletterMetadata, NewsletterError>

pub async fn join( &self, jid: &Jid, ) -> Result<NewsletterMetadata, NewsletterError>

pub async fn leave(&self, jid: &Jid) -> Result<(), NewsletterError>

pub async fn update( &self, jid: &Jid, name: Option<&str>, description: Option<&str>, ) -> Result<NewsletterMetadata, NewsletterError>

pub async fn set_follower_mute( &self, jid: &Jid, muted: bool, ) -> Result<(), NewsletterError>

pub async fn set_admin_mute( &self, jid: &Jid, muted: bool, ) -> Result<(), NewsletterError>

pub async fn get_metadata_by_invite( &self, invite_code: &str, ) -> Result<NewsletterMetadata, NewsletterError>

pub async fn subscribe_live_updates( &self, jid: impl Into<Jid>, ) -> Result<u64, NewsletterError>

pub async fn send_reaction( &self, jid: &Jid, server_id: u64, reaction: &str, ) -> Result<(), NewsletterError>

pub async fn edit_message( &self, jid: &Jid, message_id: impl Into<String>, new_content: Message, ) -> Result<(), NewsletterError>

pub async fn revoke_message( &self, jid: &Jid, message_id: impl Into<String>, ) -> Result<(), NewsletterError>

pub async fn get_messages( &self, jid: impl Into<Jid>, count: u32, before: Option<u64>, ) -> Result<Vec<NewsletterMessage>, NewsletterError>

Auto Trait Implementations§

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

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

impl<'a> Freeze for Newsletter<'a>

impl<'a> Send for Newsletter<'a>

impl<'a> Sync for Newsletter<'a>

impl<'a> Unpin for Newsletter<'a>

impl<'a> UnsafeUnpin for Newsletter<'a>

Blanket Implementations§

impl<T> AggregateExpressionMethods for T

fn aggregate_distinct(self) -> Self::Outputwhere Self: DistinctDsl,

fn aggregate_all(self) -> Self::Outputwhere Self: AllDsl,

fn aggregate_filter<P>(self, f: P) -> Self::Outputwhere P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

fn aggregate_order<O>(self, o: O) -> Self::Outputwhere Self: OrderAggregateDsl<O>,

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSend for Twhere T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

impl<T> ErasedDestructor for Twhere T: 'static,

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoSql for T

fn into_sql<T>(self) -> Self::Expressionwhere Self: Sized + AsExpression<T>, T: SqlType + TypedExpressionType,

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expressionwhere &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

impl<T> MaybeSend for Twhere T: Send + ?Sized,

impl<T> MaybeSendSync for Twhere T: Send + Sync + ?Sized,

impl<T> Same for T

type Output = T

impl<T> Spawnable for Twhere T: Send + 'static,

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

type Error = Infallible

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

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

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

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

impl<T> WindowExpressionMethods for T

fn over(self) -> Self::Outputwhere Self: OverDsl,

fn window_filter<P>(self, f: P) -> Self::Outputwhere P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

fn partition_by<E>(self, expr: E) -> Self::Outputwhere Self: PartitionByDsl<E>,

fn window_order<E>(self, expr: E) -> Self::Outputwhere Self: OrderWindowDsl<E>,

fn frame_by<E>(self, expr: E) -> Self::Outputwhere Self: FrameDsl<E>,

Struct Newsletter

fn aggregate_distinct(self) -> Self::Output
where Self: DistinctDsl,

fn aggregate_all(self) -> Self::Output
where Self: AllDsl,

fn aggregate_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

fn aggregate_order<O>(self, o: O) -> Self::Output
where Self: OrderAggregateDsl<O>,

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> Downcast for T
where T: Any,

impl<T> DowncastSend for T
where T: Any + Send,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

impl<T> ErasedDestructor for T
where T: 'static,

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

fn into_sql<T>(self) -> Self::Expression
where Self: Sized + AsExpression<T>, T: SqlType + TypedExpressionType,

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
where &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

impl<T> MaybeSend for T
where T: Send + ?Sized,

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

impl<T> Spawnable for T
where T: Send + 'static,

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

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

fn over(self) -> Self::Output
where Self: OverDsl,

fn window_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

fn partition_by<E>(self, expr: E) -> Self::Output
where Self: PartitionByDsl<E>,

fn window_order<E>(self, expr: E) -> Self::Output
where Self: OrderWindowDsl<E>,

fn frame_by<E>(self, expr: E) -> Self::Output
where Self: FrameDsl<E>,