Titanium.Android.NotificationChannel
> Titanium.Android.NotificationChannel

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:

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);
  • 7.0.0
Defined By

Properties

apiName : Stringreadonly

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.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.Android.NotificationChannel
bypassDnd : Boolean

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

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

Titanium.Android.NotificationChannel
description : String

User visible description of this channel.

User visible description of this channel.

Titanium.Android.NotificationChannel
enableLights : Boolean

Whether notifications posted to this channel should display notification lights

Whether notifications posted to this channel should display notification lights

Titanium.Android.NotificationChannel
enableVibration : Boolean

Whether notification posted to this channel should vibrate.

Whether notification posted to this channel should vibrate.

Titanium.Android.NotificationChannel
groupId : String

Group id this channel belongs to.

Group id this channel belongs to.

Titanium.Android.NotificationChannel
id : String

The channel id specified for the notification channel.

The channel id specified for the notification channel.

Titanium.Android.NotificationChannel
importance : Number

The audio stream type to use when playing the sound.

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.

  • 3.6.0
Titanium.Android.NotificationChannel
lightColor : Number

The notification light color for notifications posted to this channel.

The notification light color for notifications posted to this channel.

Titanium.Android.NotificationChannel
: Number
Whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form. ...

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:

Titanium.Android.NotificationChannel
showBadge : Boolean

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.

Titanium.Android.NotificationChannel
vibratePattern : Number[]

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

Defined By

Methods

Adds the specified callback as an event listener for the named event. ...

Adds the specified callback as an event listener for the named event.

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Titanium.Android.NotificationChannel
( ) : Boolean
Gets the value of the bypassDnd property. ...

Gets the value of the bypassDnd property.

Returns

  • Boolean
Titanium.Android.NotificationChannel
( ) : String
Gets the value of the description property. ...

Gets the value of the description property.

Returns

  • String
Titanium.Android.NotificationChannel
( ) : Boolean
Gets the value of the enableLights property. ...

Gets the value of the enableLights property.

Returns

  • Boolean
Titanium.Android.NotificationChannel
( ) : Boolean
Gets the value of the enableVibration property. ...

Gets the value of the enableVibration property.

Returns

  • Boolean
Titanium.Android.NotificationChannel
( ) : String
Gets the value of the groupId property. ...

Gets the value of the groupId property.

Returns

  • String
Titanium.Android.NotificationChannel
( ) : String
Gets the value of the id property. ...

Gets the value of the id property.

Returns

  • String
Titanium.Android.NotificationChannel
( ) : Number
Gets the value of the importance property. ...

Gets the value of the importance property.

Returns

  • Number
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Android.NotificationChannel
( ) : Number
Gets the value of the lightColor property. ...

Gets the value of the lightColor property.

Returns

  • Number
Titanium.Android.NotificationChannel
( ) : Number
Gets the value of the lockscreenVisibility property. ...

Gets the value of the lockscreenVisibility property.

Returns

  • Number
Titanium.Android.NotificationChannel
( ) : Boolean
Gets the value of the showBadge property. ...

Gets the value of the showBadge property.

Returns

  • Boolean
Titanium.Android.NotificationChannel
( ) : Number[]
Gets the value of the vibratePattern property. ...

Gets the value of the vibratePattern property.

Returns

  • Number[]
Removes the specified callback as an event listener for the named event. ...

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( bypassDnd )
Sets the value of the bypassDnd property. ...

Sets the value of the bypassDnd property.

Parameters

  • bypassDnd : Boolean

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( description )
Sets the value of the description property. ...

Sets the value of the description property.

Parameters

  • description : String

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( enableLights )
Sets the value of the enableLights property. ...

Sets the value of the enableLights property.

Parameters

  • enableLights : Boolean

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( enableVibration )
Sets the value of the enableVibration property. ...

Sets the value of the enableVibration property.

Parameters

  • enableVibration : Boolean

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( groupId )
Sets the value of the groupId property. ...

Sets the value of the groupId property.

Parameters

  • groupId : String

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( id )
Sets the value of the id property. ...

Sets the value of the id property.

Parameters

  • id : String

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( importance )
Sets the value of the importance property. ...

Sets the value of the importance property.

Parameters

  • importance : Number

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.Android.NotificationChannel
( lightColor )
Sets the value of the lightColor property. ...

Sets the value of the lightColor property.

Parameters

  • lightColor : Number

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( lockscreenVisibility )
Sets the value of the lockscreenVisibility property. ...

Sets the value of the lockscreenVisibility property.

Parameters

  • lockscreenVisibility : Number

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( showBadge )
Sets the value of the showBadge property. ...

Sets the value of the showBadge property.

Parameters

  • showBadge : Boolean

    New value for the property.

Returns

  • void
Titanium.Android.NotificationChannel
( vibratePattern )
Sets the value of the vibratePattern property. ...

Sets the value of the vibratePattern property.

Parameters

  • vibratePattern : Array<Number>

    New value for the property.

Returns

  • void