Struct Channel 

pub struct Channel { /* private fields */ }

A notification channel, the category users configure notification behavior on.

Notifications reference a channel through NotificationBuilder::channel_id and are not delivered when the channel does not exist. Only available on Android. Use Channel::builder to construct one.

Implementations

impl Channel

pub fn builder(id: impl Into<String>, name: impl Into<String>) -> ChannelBuilder

Creates a builder for a channel with the given identifier and user visible name.

Lights and vibration are disabled, the importance defaults to Importance::Default and the remaining settings default to None; call ChannelBuilder::build to get the Channel.

pub fn id(&self) -> &str

The identifier of this channel.

pub fn name(&self) -> &str

The user visible name of this channel.

pub fn description(&self) -> Option<&str>

The user visible description of this channel.

pub fn sound(&self) -> Option<&str>

The name of the sound resource played by the notifications of this channel.

The resource must be placed in the app’s res/raw folder.

pub fn lights(&self) -> bool

Whether the notifications of this channel blink the device light.

pub fn light_color(&self) -> Option<&str>

The color of the device light, as a color string such as #ff0000.

pub fn vibration(&self) -> bool

Whether the notifications of this channel vibrate the device.

pub fn importance(&self) -> Importance

How much the notifications of this channel interrupt the user.

pub fn visibility(&self) -> Option<Visibility>

How much of the notifications of this channel is shown on the lock screen.

Visibility::Private is used when this is None.

Trait Implementations

impl Debug for Channel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Channel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Channel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.