Titanium.Android.RemoteViews

The Titanium binding of Android RemoteViews.

RemoteViews is an API for referencing and updating a remote view hierarchy that lives in another process, for example, in a Notification.

To create a remote view hierarchy, you must define an Android XML layout for the views you want to display, and place the XML file in the platform/android/res/layout inside your project folder. See the examples for a sample XML layout and sample code for creating a remote view.

To use a remote view hierarchy in a notification, see Notification.contentView.

Because the remote view hierarchy belongs to another process, you cannot call methods on it directly, but you can call methods on the RemoteViews object to update views in the hierarchy by ID. To reference a view inside the layout, use the Titanium.App.Android.R object to reference the view's ID. For example, if you have a view with the ID notify_imageview, you can refer to it using:

Ti.App.Android.R.id.notify_imageview

Properties #

apiName#

extended

Type: String

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.

bubbleParent#

extended

Type: Boolean

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.

layoutId#

creation only

Type: Number

Android layout resource ID for the view to display. Required.

To define a custom layout resource in your application, the XML layout file
should be placed in platform/android/res/layout folder inside your project folder.

Use Titanium.App.Android.R to reference the ID of the layout.

lifecycleContainer#

extended

Type: Titanium.UI.Window, Titanium.UI.TabGroup

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.

packageName#

creation only

Type: String

Package name that the resource ID lives in. Optional.

Methods #

addEventListener #

extended

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

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to invoke when the event is fired.	No

applyProperties #

extended

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.

Parameters:

Name	Type	Summary	Optional
`props`	`Dictionary`	A dictionary of properties to apply.	No

fireEvent #

extended

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`event`	`Dictionary`	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

removeEventListener #

extended

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	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to remove. Must be the same function passed to `addEventListener`.	No

setBoolean #

Calls a method taking a single boolean argument on a view in the remote view
hierarchy. See Android's documentation for
[setBoolean](https://developer.android.com/reference/android/widget/RemoteViews.html#setBoolean(int, java.lang.String, boolean)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to invoke the method on. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`methodName`	`String`	Name of the method to call.	No
`value`	`Boolean`	Value to pass to the method.	No

setChronometer #

Sets the base time, format string, and started flag for a chronometer
in the remote view hierarchy.

See Android's documentation for
[setChronometer](https://developer.android.com/reference/android/widget/RemoteViews.html#setChronometer(int, long, java.lang.String, boolean)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the Chronometer to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`base`	`Date`	Time at which the timer would have read 0:00.	No
`format`	`String`	Chronometer format string, or `null` to simply display the timer value.	No
`started`	`Boolean`	True if you want the clock to be started, false if not.	No

setDouble #

Calls a method taking a single double argument on a view in the remote view
hierarchy.

See Android's documentation for
[setDouble](https://developer.android.com/reference/android/widget/RemoteViews.html#setDouble(int, java.lang.String, double)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`methodName`	`String`	Name of the method to call.	No
`value`	`Number`	Value to pass to the method.	No

setImageViewResource #

Sets the image for an image view in the remote view hierarchy using an Android drawable resource.

See Android's documentation for
[setImageViewResource](https://developer.android.com/reference/android/widget/RemoteViews.html#setImageViewResource(int, int)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the `ImageView` to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`srcId`	`Number`	Resource ID of the new image. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No

setImageViewUri #

Sets the image for an image view in the remote view hierarchy using a URI.

This method supports supports both Android and Titanium URLs.

See Android's documentation for
[setImageViewUri](https://developer.android.com/reference/android/widget/RemoteViews.html#setImageViewUri(int, android.net.Uri)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the `ImageView` to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`uri`	`String`	URI of the image (both Android and Titanium URLs are supported).	No

setInt #

Calls a method taking a single int argument on a view in the remote view hierarchy.

See Android's documentation for [setInt](https://developer.android.com/reference/android/widget/RemoteViews.html#setInt(int, java.lang.String, int))

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`methodName`	`String`	Name of the method to call.	No
`value`	`Number`	Value to pass to the method.	No

setOnClickPendingIntent #

Launches a Titanium.Android.PendingIntent when the specified view is clicked.

See Android's documentation for
[setOnClickPendingIntent](https://developer.android.com/reference/android/widget/RemoteViews.html#setOnClickPendingIntent(int, android.app.PendingIntent)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to add a click listener to. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`pendingIntent`	`Titanium.Android.PendingIntent`	The `PendingIntent` to execute when this view is clicked.	No

setProgressBar #

Sets the progress, max value, and indeterminate flag of a progress bar in the
remote view hierarchy.

See Android's documentation for
[setProgressBar](https://developer.android.com/reference/android/widget/RemoteViews.html#setProgressBar(int, int, int, boolean)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the progress bar to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`max`	`Number`	The new maximum value of the progress bar.	No
`progress`	`Number`	The new progress value of the progress bar (from 0..`max`).	No
`indeterminate`	`Boolean`	Determines whether the progress bar is indeterminate. If `true`, the progress bar displays an infinite looping animation.	No

setString #

Calls a method taking a single String argument on a view in the remote view
hierarchy.

See Android's documentation for
[setString](https://developer.android.com/reference/android/widget/RemoteViews.html#setString(int, java.lang.String, java.lang.String)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`methodName`	`String`	Name of the method to call.	No
`value`	`String`	String to pass to the method.	No

setTextColor #

Sets the text color of a view in the remote view hierarchy.

See Android's documentation for
[setTextColor](https://developer.android.com/reference/android/widget/RemoteViews.html#setTextColor(int, int)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`color`	`Number`	Color as an integer.	No

setTextViewText #

Sets the text of a text view in the remote view hierarchy.

See Android's documentation for
[setTextViewText](https://developer.android.com/reference/android/widget/RemoteViews.html#setTextViewText(int, java.lang.CharSequence)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the text view to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`text`	`String`	New text for the text view.	No

setUri #

Calls a method taking one URI on a view in the remote view hierarchy.

See Android's documentation for
[setUri](https://developer.android.com/reference/android/widget/RemoteViews.html#setUri(int, java.lang.String, android.net.Uri)).

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to update. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`methodName`	`String`	Name of the method to call.	No
`value`	`String`	URI (as a string) to pass to the method.	No

setViewVisibility #

Sets the visibility of a view in the remote view hierarchy.

See Android's documentation for [setViewVisibility](https://developer.android.com/reference/android/widget/RemoteViews.html#setViewVisibility(int, int))

Parameters:

Name	Type	Summary	Optional
`viewId`	`Number`	Resource ID of the view to show or hide. Application-specific resource IDs can be specified using Titanium.App.Android.R.	No
`visibility`	`Number`	The visibility. Either `0` (VISIBLE), `4` (INVISIBLE) or `8` (GONE).	No

Examples #

Create a Remote View

The following code excerpt creates a `RemoteViews` object based on a custom layout called `custom_layout.xml`, and set a label's text.

var AppR = Ti.App.Android.R;
var customLayout = Ti.Android.createRemoteViews({ layoutId: AppR.layout.custom_layout });
customLayout.setTextViewText(AppR.id.custom_text, "Click Me!");

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="fill_parent" 
        android:layout_height="fill_parent" 
        android:orientation="vertical" >
    <TextView android:id="@+id/custom_text"
            android:layout_width="fill_parent"
            android:layout_height="fill_parent"
            android:background="#ffffff"
            android:textColor="#aaff0000"
            android:textStyle="italic"
            android:gravity="center"
            android:text="Hello, I am a TextView" />
</LinearLayout>

Notificationchannels

Launchoptionstype

Notificationparams

Usernotificationattachment

Usernotificationsettings

Mediascannerresponse

Clipboarditemstype

Systemimageparameters

Titanium.Android.RemoteViews ​

Properties #

apiName#

bubbleParent#

layoutId#

lifecycleContainer#

packageName#

Methods #

addEventListener #

applyProperties #

fireEvent #

removeEventListener #

setBoolean #

setChronometer #

setDouble #

setImageViewResource #

setImageViewUri #

setInt #

setOnClickPendingIntent #

setProgressBar #

setString #

setTextColor #

setTextViewText #

setUri #

setViewVisibility #

Examples #

Create a Remote View

Titanium.Android.RemoteViews