Version13.2.0

You are reading 13.2.0. See this page in 13.4.1.

Titanium.Android.BigPictureStyle

proxyAndroidsince 5.4.0

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

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 8

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

bigContentTitle

String

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

Default: <Titanium.Android.Notification.contentTitle>

bigLargeIcon

Number | String

Override the Titanium.Android.Notification.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 Titanium.App.Android.R object:

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

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

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 Titanium.App.Android.R object:

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

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

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

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

Default: true

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

lifecycleContainer

Titanium.UI.Window | Titanium.UI.TabGroupsince 3.6.0

Inherited from Titanium.Proxy

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

summaryText

String

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

Methods 4

addEventListener

Inherited from Titanium.Proxy

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

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

applyProperties

since 3.0.0

Inherited from Titanium.Proxy

Applies the properties to the proxy.

Parameters
Parameters	Type	Description
props	Dictionary	A dictionary of properties to apply.

fireEvent

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
Parameters	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.

removeEventListener

Inherited from Titanium.Proxy

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

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.