Package | com.myflashlab.air.extensions.localNotifi |
Class | public class NotificationChannel |
Inheritance | NotificationChannel Object |
Property | Defined By | ||
---|---|---|---|
bypassDnd : Boolean [write-only]
Sets whether or not notifications posted to this channel can interrupt the user in
android.app.NotificationManager.Policy#INTERRUPTION_FILTER_PRIORITY mode. | NotificationChannel | ||
description : String [write-only]
Sets the user visible description of this channel. | NotificationChannel | ||
groupId : String [write-only]
Sets what group this channel belongs to. | NotificationChannel | ||
importance : int [write-only]
The importance of the channel. | NotificationChannel | ||
isLightsEnabled : Boolean [write-only]
Sets whether notifications posted to this channel should display notification lights, on devices that
support that feature. | NotificationChannel | ||
isVibrationEnabled : Boolean [write-only]
Sets whether notification posted to this channel should vibrate. | NotificationChannel | ||
lightColor : String [write-only]
Sets the notification light color for notifications posted to this channel, if lights are on this channel
and the device supports that feature. | NotificationChannel | ||
lockscreenVisibility : int [write-only]
Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they
appear in a redacted form. | NotificationChannel | ||
rawSound : String [write-only]
name of the sound resource placed in "res/raw" folder of this ANE. | NotificationChannel | ||
showBadge : Boolean [write-only]
Sets whether notifications posted to this channel can appear as application icon badges in a Launcher. | NotificationChannel | ||
vibrationPattern : Array [write-only]
Sets the vibration pattern for notifications posted to this channel. | NotificationChannel |
Method | Defined By | ||
---|---|---|---|
NotificationChannel($id:String, $name:String)
Creates a notification channel. | NotificationChannel |
Constant | Defined By | ||
---|---|---|---|
NOTIFICATION_IMPORTANCE_DEFAULT : int = 3 [static] Default notification importance: shows everywhere, makes noise, but does not visually intrude. | NotificationChannel | ||
NOTIFICATION_IMPORTANCE_HIGH : int = 4 [static] Higher notification importance: shows everywhere, makes noise and peeks. | NotificationChannel | ||
NOTIFICATION_IMPORTANCE_LOW : int = 2 [static] Low notification importance: shows everywhere, but is not intrusive. | NotificationChannel | ||
NOTIFICATION_IMPORTANCE_MAX : int = 5 [static] unused | NotificationChannel | ||
NOTIFICATION_IMPORTANCE_MIN : int = 1 [static] Min notification importance: only shows in the shade, below the fold. | NotificationChannel | ||
NOTIFICATION_IMPORTANCE_NONE : int = 0 [static] A notification with no importance: does not show in the shade. | NotificationChannel | ||
VISIBILITY_PRIVATE : int = 0 [static]
Notification visibility: Show this notification on all lockscreens, but conceal sensitive or private
information on secure lockscreens. | NotificationChannel | ||
VISIBILITY_PUBLIC : int = 1 [static]
Notification visibility: Show this notification in its entirety on all lockscreens. | NotificationChannel | ||
VISIBILITY_SECRET : int = -1 [static]
Notification visibility: Do not reveal any part of this notification on a secure lockscreen. | NotificationChannel |
bypassDnd | property |
bypassDnd:Boolean
[write-only] Sets whether or not notifications posted to this channel can interrupt the user in android.app.NotificationManager.Policy#INTERRUPTION_FILTER_PRIORITY mode.
public function set bypassDnd(value:Boolean):void
description | property |
description:String
[write-only] Sets the user visible description of this channel.
public function set description(value:String):void
groupId | property |
groupId:String
[write-only] Sets what group this channel belongs to. Group information is only used for presentation, not for behavior. Only modifiable before the channel is submitted.
public function set groupId(value:String):void
importance | property |
importance:int
[write-only] The importance of the channel. This controls how interruptive notifications posted to this channel are.
public function set importance(value:int):void
isLightsEnabled | property |
isLightsEnabled:Boolean
[write-only] Sets whether notifications posted to this channel should display notification lights, on devices that support that feature. Only modifiable before the channel is submitted.
public function set isLightsEnabled(value:Boolean):void
isVibrationEnabled | property |
isVibrationEnabled:Boolean
[write-only]
Sets whether notification posted to this channel should vibrate. The vibration pattern can be set with
vibrationPattern
public function set isVibrationEnabled(value:Boolean):void
lightColor | property |
lightColor:String
[write-only] Sets the notification light color for notifications posted to this channel, if lights are on this channel and the device supports that feature.
public function set lightColor(value:String):void
lockscreenVisibility | property |
lockscreenVisibility:int
[write-only] Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form. See e.g. NotificationChannel.VISIBILITY_SECRET. Only modifiable by the system and notification ranker.
public function set lockscreenVisibility(value:int):void
rawSound | property |
rawSound:String
[write-only]
name of the sound resource placed in "res/raw
" folder of this ANE.
public function set rawSound(value:String):void
showBadge | property |
showBadge:Boolean
[write-only] Sets whether notifications posted to this channel can appear as application icon badges in a Launcher. Only modifiable before the channel is submitted.
public function set showBadge(value:Boolean):void
vibrationPattern | property |
vibrationPattern:Array
[write-only] Sets the vibration pattern for notifications posted to this channel.
public function set vibrationPattern(value:Array):void
NotificationChannel | () | Constructor |
public function NotificationChannel($id:String, $name:String)
Creates a notification channel.
Parameters$id:String — The id of the channel. Must be unique per package. The value may be truncated if it is too long.
| |
$name:String — The user visible name of the channel. The recommended maximum length is 40 characters; the
value may be truncated if it is too long.
|
NOTIFICATION_IMPORTANCE_DEFAULT | Constant |
public static const NOTIFICATION_IMPORTANCE_DEFAULT:int = 3
Default notification importance: shows everywhere, makes noise, but does not visually intrude.
NOTIFICATION_IMPORTANCE_HIGH | Constant |
public static const NOTIFICATION_IMPORTANCE_HIGH:int = 4
Higher notification importance: shows everywhere, makes noise and peeks. May use full screen intents.
NOTIFICATION_IMPORTANCE_LOW | Constant |
public static const NOTIFICATION_IMPORTANCE_LOW:int = 2
Low notification importance: shows everywhere, but is not intrusive.
NOTIFICATION_IMPORTANCE_MAX | Constant |
public static const NOTIFICATION_IMPORTANCE_MAX:int = 5
unused
NOTIFICATION_IMPORTANCE_MIN | Constant |
public static const NOTIFICATION_IMPORTANCE_MIN:int = 1
Min notification importance: only shows in the shade, below the fold.
NOTIFICATION_IMPORTANCE_NONE | Constant |
public static const NOTIFICATION_IMPORTANCE_NONE:int = 0
A notification with no importance: does not show in the shade.
VISIBILITY_PRIVATE | Constant |
public static const VISIBILITY_PRIVATE:int = 0
Notification visibility: Show this notification on all lockscreens, but conceal sensitive or private information on secure lockscreens.
VISIBILITY_PUBLIC | Constant |
public static const VISIBILITY_PUBLIC:int = 1
Notification visibility: Show this notification in its entirety on all lockscreens.
VISIBILITY_SECRET | Constant |
public static const VISIBILITY_SECRET:int = -1
Notification visibility: Do not reveal any part of this notification on a secure lockscreen.