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.
// 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);
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.
Overrides Titanium.Android.Notification.contentTitle in the big form of the notification. This defaults to the value passed to Titanium.Android.Notification.contentTitle.
Override the Titanium.Android.Notification.largeIcon when the big notification is shown.
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.
Provide the bitmap to be used as the payload for the BigPicture notification.
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.
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
Number of times to retry decoding the bitmap at bigPicture URL.
Default: 5
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.
Set the first line of text after the detail section in the big form of the notification.
Set the first line of text after the detail section in the big form of the notification.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Gets the value of the bigPicture property.
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);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Sets the value of the bigContentTitle property.
New value for the property.
Sets the value of the bigLargeIcon property.
New value for the property.
Sets the value of the bigPicture property.
New value for the property.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the decodeRetries property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of the summaryText property.
New value for the property.