Struct Category 

pub struct Category { /* private fields */ }

One notification category the venture declares.

Categories are the vocabulary an account switches on and off, so they are the venture’s, not the module’s: booking, coach_notes, room_starting.

Implementations

impl Category

pub fn new(name: impl Into<String>) -> Self

A category that is on until the account says otherwise, and sends no badge count.

pub fn default_enabled(self, enabled: bool) -> Self

Whether an account that has never expressed a preference gets this category (default true).

pub fn badge(self, allowed: bool) -> Self

Whether a badge count may travel with this category’s notifications (default false).

Off by default because a badge number the server cannot compute correctly is worse than no badge: it is wrong on the device until the next push, and only the venture knows what it counts.

pub fn in_app(self, keeps_a_row: bool) -> Self

Whether this category writes an in-app inbox row (default true).

Turn it off for a notification that is noise once it is past — “your room starts in ten minutes” is worth a push and worth nothing in a list read tomorrow. This is the venture’s decision about the category; the account’s own in_app switch is separate and is checked as well.

pub fn email(self, sends_mail: bool) -> Self

Whether this category is emailed to an account with a verified address (default false).

Off by default because email is the most intrusive of the three channels and the hardest to take back — a venture opts a category in deliberately. The account’s own email switch is separate and is checked as well, and a category that is on here still sends nothing to an account with no verified address.

pub fn subject_template(self, subject: impl Into<String>) -> Self

The subject line for this category’s mail. Defaults to the notification’s own title.

pub fn render(self, mode: RenderMode) -> Self

Who renders this category’s strings for a device (default RenderMode::Server, issue #190).

Only ever consulted for a Message::Localizable: a caller that passes a rendered Notification gets exactly what it wrote, whatever this says.

RenderMode::Native and RenderMode::Both pass the caller’s Localizable::loc keys through to APNs and FCM, so an app that ships its own translations renders in the device’s language without the server knowing any of them. Web Push has no such mechanism, so a browser is always served the rendered text whatever the mode.

pub fn name(&self) -> &str

The category’s name.

Trait Implementations

impl Clone for Category

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Category

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

Formats the value using the given formatter.

impl Eq for Category

impl PartialEq for Category

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Category