pub struct NotificationSettings { /* private fields */ }
Expand description

A high-level API to manage the client owner’s push notification settings.

Implementations§

source§

impl NotificationSettings

source

pub fn subscribe_to_changes(&self) -> Receiver<()>

Subscribe to changes in the NotificationSettings.

Changes can happen due to local changes or changes in another session.

source

pub async fn get_user_defined_room_notification_mode( &self, room_id: &RoomId ) -> Option<RoomNotificationMode>

Get the user defined notification mode for a room.

source

pub async fn get_default_room_notification_mode( &self, is_encrypted: IsEncrypted, is_one_to_one: IsOneToOne ) -> RoomNotificationMode

Get the default notification mode for a room.

§Arguments
  • is_encrypted - Yes if the room is encrypted
  • is_one_to_one - Yes if the room is a direct chat involving two people
source

pub async fn get_rooms_with_user_defined_rules( &self, enabled: Option<bool> ) -> Vec<String>

Get all room IDs for which a user-defined rule exists.

source

pub async fn contains_keyword_rules(&self) -> bool

Get whether the given ruleset contains some enabled keywords rules.

source

pub async fn is_push_rule_enabled( &self, kind: RuleKind, rule_id: impl AsRef<str> ) -> Result<bool, NotificationSettingsError>

Get whether a push rule is enabled.

source

pub async fn set_push_rule_enabled( &self, kind: RuleKind, rule_id: impl AsRef<str>, enabled: bool ) -> Result<(), NotificationSettingsError>

Set whether a push rule is enabled.

source

pub async fn set_default_room_notification_mode( &self, is_encrypted: IsEncrypted, is_one_to_one: IsOneToOne, mode: RoomNotificationMode ) -> Result<(), NotificationSettingsError>

Set the default notification mode for a type of room.

§Arguments
  • is_encrypted - Yes if the mode is for encrypted rooms
  • is_one_to_one - Yes if the mode if for one-to-one rooms (rooms with exactly two members)
  • mode - the new default mode
source

pub async fn set_underride_push_rule_actions( &self, rule_id: PredefinedUnderrideRuleId, actions: Vec<Action> ) -> Result<(), NotificationSettingsError>

Sets the push rule actions for a given underride push rule. It also enables the push rule if it is disabled. Underride rules are the lowest priority push rules

§Arguments
  • rule_id - the identifier of the push rule
  • actions - the actions to set for the push rule
source

pub async fn set_room_notification_mode( &self, room_id: &RoomId, mode: RoomNotificationMode ) -> Result<(), NotificationSettingsError>

Set the notification mode for a room.

source

pub async fn delete_user_defined_room_rules( &self, room_id: &RoomId ) -> Result<(), NotificationSettingsError>

Delete all user defined rules for a room.

source

pub async fn unmute_room( &self, room_id: &RoomId, is_encrypted: IsEncrypted, is_one_to_one: IsOneToOne ) -> Result<(), NotificationSettingsError>

Unmute a room.

source

pub async fn enabled_keywords(&self) -> IndexSet<String>

Get the keywords which have enabled rules.

source

pub async fn add_keyword( &self, keyword: String ) -> Result<(), NotificationSettingsError>

Add or enable a rule for the given keyword.

§Arguments
  • keyword - The keyword to match.
source

pub async fn remove_keyword( &self, keyword: &str ) -> Result<(), NotificationSettingsError>

Remove the rules for the given keyword.

§Arguments
  • keyword - The keyword to unmatch.

Trait Implementations§

source§

impl Clone for NotificationSettings

source§

fn clone(&self) -> NotificationSettings

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NotificationSettings

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

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

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

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

§

type Output = T

Should always be Self
source§

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
source§

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

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

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

impl<T> Any for T
where T: Any,

source§

impl<T> AsyncTraitDeps for T

source§

impl<T> CloneAny for T
where T: Any + Clone,

source§

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

source§

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

source§

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,