Titanium Mobile

# Titanium.Android.BigPictureStyle

Helper object for generating large-format notifications that include a large image attachment.

Availability
5.4.0
Extends
Titanium.Proxy

# Overview

If the platform does not provide large-format notifications, this style helper has no effect. The user will always see the normal notification view.

This style object attaches to a Titanium.UI.Notification object and modifies its behavior.

# Examples

# Big picture style Example

This example will be use image that placed in one of the density-specific folder under Resources/android/images

var bigPictureStyle = Titanium.Android.createBigPictureStyle({
    bigPicture: "/images/bigPicture.png",
    bigContentTitle: "Title for big picture",
    summaryText: "Summary for big picture"
});

Create big image style notification

var notification = Titanium.Android.createNotification({
    contentTitle: 'Something Happened',
    contentText : 'Click to return to the application.',
    style: bigPictureStyle,
    time: Date.now()
});

Send the notification.

Titanium.Android.NotificationManager.notify(1, notification);

# Properties

# bigContentTitle

Availability
5.4.0
bigContentTitle :String

Overrides contentTitle in the big form of the notification. This defaults to the value passed to contentTitle.

Default: Titanium.Android.Notification.contentTitle

# bigLargeIcon

Availability
5.4.0
bigLargeIcon :Number | String

Override the largeIcon when the big notification is shown.

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_big_large_icon.png, you would create high- and medium-density versions of the icons with the following paths:

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

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

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

platform/android/res/drawable/my_big_large_icon.png

This icon's resource ID can be referenced through the R object:

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

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

# bigPicture

Availability
5.4.0
bigPicture :Number | String | Titanium.Blob | Titanium.Filesystem.File

Provide the bitmap to be used as the payload for the BigPicture notification.

Image to display, defined using a local filesystem path, a File object, a remote URL, or a Blob object containing image data.

If there is a redirect and change in protocol, it will not follow. For example, from http to https and vice versa. See Java Bug Database for more information.

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

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

To access this bigPicture, you'd use the URL '/images/my_big_picture.png'.

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

platform/android/res/drawable/my_big_picture.png

This bigPicture's resource ID can be referenced through the R object:

bigPicture: Ti.App.Android.R.drawable.my_big_picture,

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

# decodeRetries

Availability
5.4.0
decodeRetries :Number

Number of times to retry decoding the bitmap at bigPicture URL.

Defaults to 2 on Titanium 10.1.0 and higher. Defaults to 5 on older SDK versions.

Default: 2

# summaryText

Availability
5.4.0
summaryText :String

Set the first line of text after the detail section in the big form of the notification.

Contents