Titanium.Android.Notification

Specify one of the STREAM constants from Titanium.Android.

If your notification falls into one of the predefined categories, assign it accordingly. Aspects of the system UI such as the notification shade may use this information to make ranking and filtering decisions. This property only works for devices running Android 5.0 (API 21) and greater.

Accent color of the circle used behind icon. The Icon will be stenciled in white on top of a cicle of the color set. For information about color values, see the "Colors" section of Titanium.UI.

See Android Reference for the color property.

Calling setLatestEventInfo or setting the contentText or contentTitle properties causes the notification to use the default notification layout, overriding any custom layout set through contentView.

If you use a custom layout, you can use the RemoteViews methods to update the displayed notification.

Specify the bitwise OR of the desired values: Titanium.Android.DEFAULT_LIGHTS, Titanium.Android.DEFAULT_SOUND, and Titanium.Android.DEFAULT_VIBRATE. Use Titanium.Android.DEFAULT_ALL to specify that all values should be taken from the defaults.

If specified as a URL, the icon must be placed in one of the density-specific folders under Resources/android/images. For example, if your icon is called my_icon.png, you would create high- and medium-density versions of the icons with the following paths:

Resources/android/images/res-hdpi/my_icon.png
Resources/android/images/res-mdpi/my_icon.png

To access this icon, you'd use the URL '/images/my_icon.png'.

To access the same icon using an Android resource ID, place the icon in:

platform/android/res/drawable/my_icon.png

This icon's resource ID can be referenced through the Titanium.App.Android.R object:

icon: Ti.App.Android.R.drawable.my_icon,

See Titanium.App.Android.R for more information on accessing Android resources by ID.

If specified as a URL, the icon must be placed in one of the density-specific folders under Resources/android/images. For example, if your icon is called my_large_icon.png, you would create high- and medium-density versions of the icons with the following paths:

Resources/android/images/res-hdpi/my_large_icon.png
Resources/android/images/res-mdpi/my_large_icon.png

To access this large icon, you'd use the URL '/images/my_large_icon.png'.

To access the same large icon using an Android resource ID, place the icon in:

platform/android/res/drawable/my_large_icon.png

This large icon's resource ID can be referenced through the Titanium.App.Android.R object:

icon: Ti.App.Android.R.drawable.my_large_icon,

See Titanium.App.Android.R for more information on accessing Android resources by ID.

This property only works for devices running Android 4.1 (API 16) and greater.

The URL cannot refer to a file in the Resources directory, but it can refer to a file in the raw resources directory (Filesystem.resRawDirectory) or the external storage directory (Filesystem.externalStorageDirectory).

Note that this sound property is ignored on Android 8.0 and above. On these OS versions, you must use the NotificationChannel.sound property and that sound will play for any notification posted under that channel. Also, you will still need to set this notification's sound property for OS versions older than Android 8.0 too, meaning that the sound URL needs to be set in both places.

To play a raw resource file, place the audio file in the platform/android/res/raw folder and reference it as:

notification.sound = Ti.Filesystem.resRawDirectory + audioFileName;

To play a file from the Resources directory, first copy it to external storage. For example, you could define the following function:

// Copy resource file to SD card, and return a native path.
// Return undefined if we can't copy the file.
function getOrCopyAudioFile(resourceFilename) {
    var outFile = Ti.Filesystem.getFile(Ti.Filesystem.externalStorageDirectory, 'sound', 'cricket.wav');
    var outPath = outFile.nativePath;

    if (! outFile.exists()) {
        var outDir = Ti.Filesystem.getFile(Ti.Filesystem.externalStorageDirectory, 'sound');
        if (! outDir.isDirectory()) {
            if (! outDir.createDirectory()) {
                Ti.API.debug("Failed to create directory.");
                outDir = null;
                return undefined;
            }
        }
        outDir = null;

        var inFile = Ti.Filesystem.getFile(Ti.Filesystem.resourcesDirectory, 'cricket.wav');
        try {
            inFile.copy(outPath);
        } catch (ex) {
            Ti.API.debug("Failed to copy file.");
            inFile = null;
            return undefined;
        }
        inFile = null;
    }
    outFile = null;
    return outPath;
}

Then when creating a notification, specify the sound like this:

var sound = getOrCopyAudioFile();
if (sound) {
    notification.sound = sound;
}

Notifications in the notification drawer appear in two main visual styles, normal view and big view. The big view of a notification only appears when the notification is expanded. This happens when the notification is at the top of the drawer, or the user clicks the notification. On platform versions that don't offer expanded notifications, styles that depend on expanded notifications have no effect.

For devices running Android 5.0 (API 21) and greater, the ticket text is no longer displayed in the status bar. However, this property is used as an audible notification if accessibility services are enabled.

This property only works on devices running Android 5.0 (API 21) and greater.

If the timestamp is set to 0, no time is displayed in the notification window for this notification.

Up to three actions buttons can be added, additional buttons will be ignored.