Module for notification channels.
Requires: Android 8.0 and later
You can create a notification channel for each distinct type of notification you need to send.
To create a notification channel, use the Titanium.Android.createNotificationChannel method.
Further Reading:
The following example shows how to create a notification with a channel.
var channel = Ti.Android.NotificationManager.createNotificationChannel({
id: 'my_channel',
name: 'TEST CHANNEL',
importance: Ti.Android.IMPORTANCE_DEFAULT
}),
notification = Ti.Android.createNotification({
icon: Ti.Android.R.drawable.ic_dialog_info,
contentTitle: 'TITLE',
contentText : 'This is a test',
channelId: channel.getId()
});
Ti.Android.NotificationManager.notify(100, notification);
The name of the API that this proxy corresponds to.
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button
.
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
Whether or not notifications posted to this channel can interrupt the user.
Whether or not notifications posted to this channel can interrupt the user.
User visible description of this channel.
User visible description of this channel.
Whether notifications posted to this channel should display notification lights
Whether notifications posted to this channel should display notification lights
Whether notification posted to this channel should vibrate.
Whether notification posted to this channel should vibrate.
The channel id specified for the notification channel.
The channel id specified for the notification channel.
The audio stream type to use when playing the sound.
The audio stream type to use when playing the sound.
Specify one of the IMPORTANCE
constants from Titanium.Android.
This API can be assigned the following constants:
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
The notification light color for notifications posted to this channel.
The notification light color for notifications posted to this channel.
Whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.
This API can be assigned the following constants:
Whether notifications posted to this channel can appear as application icon badges in a Launcher.
Whether notifications posted to this channel can appear as application icon badges in a Launcher.
The vibration pattern for notifications posted to this channel.
The vibration pattern for notifications posted to this channel.
Specify the pattern in milliseconds as an array. (e.g [100, 100, 100, 400, 400, 100, 100, 100])
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback
parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener
.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the bypassDnd property.
New value for the property.
Sets the value of the description property.
New value for the property.
Sets the value of the enableLights property.
New value for the property.
Sets the value of the enableVibration property.
New value for the property.
Sets the value of the groupId property.
New value for the property.
Sets the value of the importance property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of the lightColor property.
New value for the property.
Sets the value of the lockscreenVisibility property.
New value for the property.
Sets the value of the showBadge property.
New value for the property.
Sets the value of the vibratePattern property.
New value for the property.