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

#include "juce_PushNotifications.h"

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

Public Attributes
String	identifier
	Required: Unique channel identifier.

String	name
	Required: User facing name of the channel.

Importance	importance
	Required.

Notification::LockScreenAppearance	lockScreenAppearance
	Optional.

String	description
	Optional: user visible description of the channel.

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

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

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

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

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

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

URL	soundToPlay
	Optional: sound to play in this channel.

Array< int >	vibrationPattern
	Optional: vibration pattern for this channel.

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.

Definition at line 446 of file juce_PushNotifications.h.

Member Enumeration Documentation

◆ Importance

enum juce::PushNotifications::Channel::Importance

Controls how interruptive the notification posted on this channel are.

Definition at line 452 of file juce_PushNotifications.h.

Member Data Documentation

◆ bypassDoNotDisturb

bool juce::PushNotifications::Channel::bypassDoNotDisturb

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

Definition at line 468 of file juce_PushNotifications.h.

◆ canShowBadge

bool juce::PushNotifications::Channel::canShowBadge

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

Definition at line 469 of file juce_PushNotifications.h.

◆ description

String juce::PushNotifications::Channel::description

Optional: user visible description of the channel.

Definition at line 465 of file juce_PushNotifications.h.

◆ enableLights

bool juce::PushNotifications::Channel::enableLights

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

Definition at line 470 of file juce_PushNotifications.h.

◆ enableVibration

bool juce::PushNotifications::Channel::enableVibration

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

Definition at line 471 of file juce_PushNotifications.h.

◆ groupId

String juce::PushNotifications::Channel::groupId

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

Definition at line 466 of file juce_PushNotifications.h.

◆ identifier

String juce::PushNotifications::Channel::identifier

Required: Unique channel identifier.

Definition at line 448 of file juce_PushNotifications.h.

◆ importance

Importance juce::PushNotifications::Channel::importance

Required.

Definition at line 462 of file juce_PushNotifications.h.

◆ ledColour

Colour juce::PushNotifications::Channel::ledColour

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

Definition at line 467 of file juce_PushNotifications.h.

◆ lockScreenAppearance

Notification::LockScreenAppearance juce::PushNotifications::Channel::lockScreenAppearance

Optional.

Definition at line 463 of file juce_PushNotifications.h.

◆ name

String juce::PushNotifications::Channel::name

Required: User facing name of the channel.

Definition at line 449 of file juce_PushNotifications.h.

◆ soundToPlay

URL juce::PushNotifications::Channel::soundToPlay

Optional: sound to play in this channel.

See Notification::soundToPlay for more info.

Definition at line 473 of file juce_PushNotifications.h.

◆ vibrationPattern

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

Optional: vibration pattern for this channel.

See Notification::vibrationPattern for more info.

Definition at line 474 of file juce_PushNotifications.h.

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

juce_gui_extra/misc/juce_PushNotifications.h

Public Types

Public Attributes