Titanium Mobile

# Titanium.Android.NotificationChannel

Module for notification channels.

Availability
7.0.0
Extends
Titanium.Proxy

# 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

# bypassDnd

Availability
7.0.0
bypassDnd :Boolean

Whether or not notifications posted to this channel can interrupt the user.

# description

Availability
7.0.0
description :String

User visible description of this channel.

# enableLights

Availability
7.0.0
enableLights :Boolean

Whether notifications posted to this channel should display notification lights

# enableVibration

Availability
7.0.0
enableVibration :Boolean

Whether notification posted to this channel should vibrate.

# groupId

Availability
7.0.0
groupId :String

Group id this channel belongs to.

# id

Availability
7.0.0
id :String

The channel id specified for the notification channel.

# importance

Availability
7.0.0
importance :Number

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:

# lightColor

Availability
7.0.0
lightColor :Number

The notification light color for notifications posted to this channel.

# lockscreenVisibility

Availability
7.0.0
lockscreenVisibility :Number

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:

# name

Availability
7.0.0
name :String

The visible name of this channel. The recommended maximum length is 40 characters; the value may be truncated if it is too long.

# showBadge

Availability
7.0.0
showBadge :Boolean

Whether notifications posted to this channel can appear as application icon badges in a Launcher.

# sound

Availability
7.5.0
sound :String

A 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

Availability
7.0.0
vibratePattern :Array<Number>

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])

Contents