juce::PushNotifications::Channel Struct Reference

Android API level 26 or higher only: Represents notification channel through which notifications will be sent. More...

#include <juce_PushNotifications.h>

Collaboration diagram for juce::PushNotifications::Channel:

Public Types
enum	Importance {   none,   min,   low,   normal,   high,   max }
	Controls how interruptive the notification posted on this channel are. More...

Public Attributes
bool	bypassDoNotDisturb = false
	Optional: true if notifications in this channel can bypass do not disturb setting. More...
bool	canShowBadge = false
	Optional: true if notifications in this channel can show badges in a Launcher application. More...
String	description
	Optional: user visible description of the channel. More...
bool	enableLights = false
	Optional: true if notifications in this channel should show lights (subject to hardware support). More...
bool	enableVibration = false
	Optional: true if notifications in this channel should trigger vibrations. More...
String	groupId
	Required: group this channel belongs to (see ChannelGroup). More...
String	identifier
	Required: Unique channel identifier. More...
Importance	importance = normal
	Required. More...
Colour	ledColour
	Optional: sets the led colour for notifications in this channel. More...
Notification::LockScreenAppearance	lockScreenAppearance = Notification::showPartially
	Optional. More...
String	name
	Required: User facing name of the channel. More...
URL	soundToPlay
	Optional: sound to play in this channel. More...
Array< int >	vibrationPattern
	Optional: vibration pattern for this channel. More...

Detailed Description

Android API level 26 or higher only: Represents notification channel through which notifications will be sent.

Starting from Android API level 26, you should call setupChannels() at the start of your application, before posting any notifications. Then, when sending notifications, assign a channel to each created notification.

Member Enumeration Documentation

Importance

enum juce::PushNotifications::Channel::Importance

Controls how interruptive the notification posted on this channel are.

Enumerator
none
min
low
normal
high
max

Member Data Documentation

bypassDoNotDisturb

bool juce::PushNotifications::Channel::bypassDoNotDisturb = false

Optional: true if notifications in this channel can bypass do not disturb setting.

canShowBadge

bool juce::PushNotifications::Channel::canShowBadge = false

Optional: true if notifications in this channel can show badges in a Launcher application.

description

String juce::PushNotifications::Channel::description

Optional: user visible description of the channel.

enableLights

bool juce::PushNotifications::Channel::enableLights = false

Optional: true if notifications in this channel should show lights (subject to hardware support).

enableVibration

bool juce::PushNotifications::Channel::enableVibration = false

Optional: true if notifications in this channel should trigger vibrations.

groupId

String juce::PushNotifications::Channel::groupId

Required: group this channel belongs to (see ChannelGroup).

identifier

String juce::PushNotifications::Channel::identifier

Required: Unique channel identifier.

importance

Importance juce::PushNotifications::Channel::importance = normal

Required.

ledColour

Colour juce::PushNotifications::Channel::ledColour

Optional: sets the led colour for notifications in this channel.

lockScreenAppearance

Notification::LockScreenAppearance juce::PushNotifications::Channel::lockScreenAppearance = Notification::showPartially

Optional.

name

String juce::PushNotifications::Channel::name

Required: User facing name of the channel.

soundToPlay

URL juce::PushNotifications::Channel::soundToPlay

Optional: sound to play in this channel.

See Notification::soundToPlay for more info.

vibrationPattern

Array<int> juce::PushNotifications::Channel::vibrationPattern

Optional: vibration pattern for this channel.

See Notification::vibrationPattern for more info.

---

The documentation for this struct was generated from the following file:

• juce_PushNotifications.h