Titanium SDK # Titanium.Android.NotificationChannel
Module for notification channels.
7.0.0# Overview
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:
# Examples
# Notification Channel Example
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);
# Properties
# apiName READONLY
7.0.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
7.0.0Indicates 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
# bypassDnd
7.0.0Whether or not notifications posted to this channel can interrupt the user.
# enableLights
7.0.0Whether notifications posted to this channel should display notification lights
# enableVibration
7.0.0Whether notification posted to this channel should vibrate.
# importance
7.0.0The audio stream type to use when playing the sound.
Specify one of the IMPORTANCE constants from Titanium.Android.
# lifecycleContainer
7.0.0The 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.
# lightColor
7.0.0The notification light color for notifications posted to this channel.
# lockscreenVisibility
7.0.0Whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.
# name
7.0.0The visible name of this channel. The recommended maximum length is 40 characters; the value may be truncated if it is too long.
# showBadge
7.0.0Whether notifications posted to this channel can appear as application icon badges in a Launcher.
# sound
7.5.0A URL to the sound to play.
The URL cannot refer to a file in the Resources directory, but it can refer to a file in the raw resources directory (resRawDirectory).
To create a raw resource, place the audio file in the platform/android/res/raw
folder and reference it as:
notificationChannel.sound = Ti.Filesystem.resRawDirectory + 'my_sound.wav';
# vibratePattern
7.0.0The 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])
# Methods
# addEventListener
7.0.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
7.0.0Applies 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.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
7.0.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# removeEventListener
7.0.0Removes 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);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void