Struct NotificationSettings

pub struct NotificationSettings { /* private fields */ }

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

Implementations

impl NotificationSettings

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.

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

Get the user defined notification mode for a room.

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

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.

pub async fn contains_keyword_rules(&self) -> bool

Get whether the given ruleset contains some enabled keywords rules.

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.

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.

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

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

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

Set the notification mode for a room.

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

Delete all user defined rules for a room.

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

Unmute a room.

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

Get the keywords which have enabled rules.

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.

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

impl Clone for NotificationSettings

fn clone(&self) -> NotificationSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotificationSettings

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

Formats the value using the given formatter.