Used to enable data and file transfers between a watchOS and iOS application.
WatchSession enables data and file transfers between a WatchKit application and a Titanium application using the iOS Watch Connectivity framework introduced in iOS 9 and watchOS 2.
The watch is currently activated.
Requires: iOS 9.3 and later
The watch is currently inactive.
Requires: iOS 9.3 and later
The watch is currently not activated.
Requires: iOS 9.3 and later
Returns the current activation state of the watch.
Requires: iOS 9.3 and later
This API can be assigned the following constants:
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.
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
Returns true if there is more content for the session to deliver.
Requires: iOS 10.0 and later
Returns true if the watch is currently activated.
Requires: iOS 9.3 and later
Returns true if complication is enabled on the installed watch app.
Requires: iOS 9.0 and later
Returns true if the device is paired with a watch.
Requires: iOS 9.0 and later
Returns true if the watch is currently reachable.
Requires: iOS 9.0 and later
Returns true if the device supports watch connectivity.
Requires: iOS 9.0 and later
Returns true if the accompanying watch app is installed.
Requires: iOS 9.0 and later
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.
The most recent application context sent to the watch app.
Requires: iOS 9.0 and later
The number of calls remaining to transferCurrentComplication before the system starts
transferring the complicationUserInfo as regular userInfos.
Requires: iOS 10.0 and later
Default: 0
Activates the watch session
Requires: iOS 9.0 and later
Activates the watch session to make the app ready to receive messages from the watch app.
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.
Cancels all incomplete file transfers to the apple watch.
Requires: iOS 9.0 and later
Cancels all incomplete file transfers to the apple watch.
Cancels all incomplete transfers to the apple watch.
Requires: iOS 9.0 and later
Cancels all incomplete transfers to the apple watch, including user info, complication and file.
Cancels all incomplete user info and complication transfers to the apple watch.
Requires: iOS 9.0 and later
Cancels all incomplete user info and complication transfers to the apple watch.
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.
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.
Sends a message to the apple watch.
Requires: iOS 9.0 and later
Sends a message to the installed watchapp on the apple watch in the foreground.
Message to send to apple watch. This property is required and the key of the dictionary needs to be a String.
Function to be called upon receiving a reply from the watch app.
Since Release 5.1.0
This function is used to process the direct reply from the watch app after sending one.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Transfers complication data to the watch application.
Requires: iOS 9.0 and later
Transfers complication data to the installed watch app. This is only for watch apps with complications enabled.
Complication to be transferred to watch app.
Transfers a file to the apple watch.
Requires: iOS 9.0 and later
Transfers a file to the installed watchapp on the apple watch in the background. Subsequent transfers are queued.
Pass an object with the following key-value pairs:
fileURL (String) (required): Local filesystem path of file to send to the watch app.metaData (Dictionary) (optional): Additional information about the file to send to the watch app.Transfers an user info to the apple watch.
Requires: iOS 9.0 and later
Transfers an user info object to the installed watchapp on the apple watch in the background. Subsequent transfers are queued.
userInfo to be transferred to apple watch.
Sends an app context update to the apple watch.
Requires: iOS 9.0 and later
Sends an app context update to the apple watch. If watchapp is in background during transfer, watchapp will fire the receiveapplicationcontext event immediately when it becomes active. Only one app context is stored at any one time. Subsequent updates will simply replace the earlier one sent.
App context to be updated in apple watch.
Called when the session has completed activation. If session state is ACTIVATION_STATE_NOT_ACTIVATED there will be an error with more details.
Requires: iOS 9.3 and later
If the device is paired with the apple watch.
If apple watch is currently reachable.
If the watch app is installed in the apple watch.
If the complication is enabled in the apple watch.
If the apple watch is currently activated. Only available on iOS 9.3
and later. See
Returns the current activation state of the watch. Only available on iOS 9.3
and later. See
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Called when all events for the previously selected watch has occurred. The session can be re-activated for the now selected watch using activateSession.
Requires: iOS 9.3 and later
If the device is paired with the apple watch.
If apple watch is currently reachable.
If the watch app is installed in the apple watch.
If the complication is enabled in the apple watch.
If the apple watch is currently activated. Only available on iOS 9.3
and later. See
If the apple watch has currently content pending. Only available on iOS 10.0
and later. See
If the apple watch has complication userInfo transfers left. Only available on iOS 10.0
and later. See
Returns the current activation state of the watch. Only available on iOS 9.3
and later. See
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
App completed file transfer to watch app.
URL of the file transferred.
meta data of the file transferred.
If the transfer was successful.
Error code if transfer failed.
Error message if any.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the application completed user info transfer to the watch app.
The downloaded data as a Titanium.Blob object.
If the transfer was successful.
Error code if transfer failed.
Error message if any.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Called when the session can no longer be used to modify or add any new transfers and, all interactive messages will be cancelled, but events for background transfers can still fire. This will happen when the selected watch is being changed.
Requires: iOS 9.3 and later
If the device is paired with the apple watch.
If apple watch is currently reachable.
If the watch app is installed in the apple watch.
If the complication is enabled in the apple watch.
If the apple watch is currently activated. Only available on iOS 9.3
and later. See
Returns the current activation state of the watch. Only available on iOS 9.3
and later. See
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
The watch reachability state has changed.
If the device is paired with the apple watch.
If apple watch is currently reachable.
If the watch app is installed in the apple watch.
If the complication is enabled in the apple watch.
If the apple watch is currently activated. Only available on iOS 9.3
and later. See
Returns the current activation state of the watch. Only available on iOS 9.3
and later. See
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
App received app context from apple watch. Will be called on startup if an applicationContext is available.
The application Context
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
App received file from apple watch in background.
The downloaded data as a Titanium.Blob object.
Information about the file.
If the transfer was successful.
Error code if transfer failed.
Error message if any.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
App received message from apple watch in foreground. Will be called on startup if the incoming message caused the receiver to launch.
The message content
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
App received user info from apple watch in background. Will be called on startup if the user info finished transferring when the receiver was not running.
The user info content
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
The watch state has changed.
If the device is paired with the apple watch.
If apple watch is currently reachable.
If the watch app is installed in the apple watch.
If the complication is enabled in the apple watch.
If the apple watch is currently activated. Only available on iOS 9.3
and later. See
Returns the current activation state of the watch. Only available on iOS 9.3
and later. See
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.