Titanium.App.iOS

Used to create a URL that you can pass to the openURL method. When you open the URL built from this string, the system launches the Settings app and displays the app's custom settings, if it has any.

var settingsURL = Ti.App.iOS.applicationOpenSettingsURL;
if (Ti.Platform.canOpenURL(settingsURL)) {
    Ti.Platform.openURL(settingsURL);
}

Used to obtain a list of the NSUserActivityTypes keys defined in your Titanium project's tiapp.xml file. These NSUserActivityTypes keys are the keys which you can use working with iOS Titanium User Activities. NSUserActivityTypes must be defined at build time in your tiapp.xml file as shown below:

<ios>
  <plist>
  <dict>
    <key>NSUserActivityTypes</key>
      <array>
        [string](api:Global.String)com.setdirection.home</string>
        [string](api:Global.String)com.setdirection.shelf</string>
        [string](api:Global.String)com.setdirection.item</string>
      </array>
    </dict>
    </plist>
  </ios>

Used in the userInterfaceStyle property.

Used in the userInterfaceStyle property.

Used in the userInterfaceStyle property.

Used to check the alertStyle attribute received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check the alertStyle attribute received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check the alertStyle attribute received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check the authorizationStatus attribute received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check the authorizationStatus attribute received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check the authorizationStatus attribute received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check the authorizationStatus attribute received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Use with the behavior property.

The user input will be passed to the typedText field of the object passed to the callback handling the localnotification event.

Use with the behavior property.

Used in the options attribute when creating a Titanium.App.iOS.UserNotificationCategory.

Used in the options attribute when creating a Titanium.App.iOS.UserNotificationCategory.

Used in the options attribute when creating a Titanium.App.iOS.UserNotificationCategory.

Used in the options attribute when creating a Titanium.App.iOS.UserNotificationCategory.

Used in the options attribute when creating a Titanium.App.iOS.UserNotificationCategory.

Used to check application-wide enabled notification settings received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check application-wide enabled notification settings received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Used to check application-wide enabled notification settings received in Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings.

Use this property to determine whether your interface should be configured with a dark or light appearance. The default value of this trait is set to the corresponding appearance setting on the user's device.

When calling this method, pass in the handlerID value that initiated the background state. You must call this handler after initiating the download operation and should do so as soon as possible.

Call this method at application start up. If the application needs to register for remote notifications, call this method before calling Titanium.Network.registerForPushNotifications.

This method must be called after your Titanium application has finished processing the watchkitextensionrequest event. Optional information can be provided in the userInfo argument will be provided back to the WatchKit extension as part of the reply method. If no userInfo is provide nil will be sent to the WatchKit extension to during the reply callback.

This method should be used as part of the watchkitextensionrequest event as shown below.

Ti.App.iOS.addEventListener("watchkitextensionrequest", function(e) {
    var replyContent = {foo: "bar"};
    Ti.App.iOS.sendWatchExtensionReply(e.handlerId,replyContent);
});

This property has no effect for apps that do not have the UIBackgroundModes key with the fetch value in its Info.plist file. The default fetch interval for apps is Titanium.App.iOS.BACKGROUNDFETCHINTERVAL_NEVER. Therefore, you must call this method and set a fetch interval before your app is given background execution time.

Add this event if your app supports the fetch UIBackground mode. When an opportunity arises to download data, the system fires this event to give your app a chance to download any data it needs. Your callback of this event should download the data, prepare that data for use, and call the endBackgroundHandler method with the handlerID parameter from this event.

When this event is fired, your app has up to 30 seconds of wall-clock time to perform the download operation and call the endBackgroundHandler method. In practice, your app should call the endBackgroundHandler method as soon as possible after initiating the download. If you do not call the endBackgroundHandler method in time, your app is suspended. More importantly, the system uses the elapsed time to calculate power usage and data costs for your app's background downloads. If your app takes a long time to call endBackgroundHandler method, it may be given fewer future opportunities to fetch data in the future.

If you are downloading large content, initiate the download using a urlSession background download task, then call the endBackgroundHandler method. Listen for the downloadcompleted event to prepare the data for use.

The event returns the dictionary containing the handlerID property, which is a unique handler ID for the current event. This identifier should be passed as the argument to the endBackgroundHandler method.

The app fires this events when all background transfers associated with a urlSession object have finished or failed. Use this method to reconnect any urlSessions and to update your app's user interface. For example, you might use this method to update progress indicators or to incorporate new content into your views. After processing the events, call the endBackgroundHandler method with the handlerID parameter. If a urlSession finishes its work when your app is not running, the system launches your app in the background so that it can process the event. In that situation, use the provided identifier to create a new urlSessionConfiguration and urlSession objects. Upon creating urlSession object, that object calls the appropriate delegate methods to process the events.

If your app already has a session object with the specified identifier and is running or suspended, you do not need to create a new session object using this method. Suspended apps are moved into the background. As soon as the app is running again, the urlSession object with the identifier receives the events and processes them normally.

At launch time, the app does not call this method if there are uploads or downloads in progress. If you want to display the current progress of those transfers in your app's user interface, you must recreate the session object yourself. In that situation, cache the session identifier value persistently and use it to recreate your session object.

Add this event if your Titanium application if you are responding to an iOS Handoff or Core Spotlight continueUserActivity request. This event will fire when a user taps on the handoff icon or the Core Spotlight search item. Your Titanium application will be opened in the background and provides your Titanium app the information from the NSUserActivity. When this event is fired you should implement logic within your application to allow the user to pick-up from where they left off on their other device.

Ti.App.iOS.addEventListener("continueactivity", function(e) {
    console.log('activityType: '' + e.activityType);
});

This event only needs to be used if your app is using the urlSession module to download data.

This event only needs to be used if your app is using the urlSession module to download data.

Incoming URL's can either be triggered by an external application or links inside your Titanium.UI.WebView / <Modules.SafariDialog>.

This event only needs to be used if your app is using the urlSession module to download or upload data.

Server errors are not reported through the error parameter. The only error events sent through the error parameter are client-side errors, such as being unable to resolve the hostname or connect to the host.

This event only needs to be used if your app is using the urlSession module to download data.

In iOS, when a background transfer completes and if your app is no longer running, your app is automatically relaunched in the background, and the app fires the backgroundtransfer event. This event should contain the identifier of the session that caused your app to be launched. Your app should then store that handlerID before creating a background session configuration object with the same identifier, and creating a URL session object with that configuration. The newly created session is automatically reassociated with ongoing background activity.

When your app later receives a sessioneventscompleted event, this indicates that all messages previously enqueued for this session have been delivered, and that it is now safe to invoke endBackgroundHandler method with the handlerID or to begin any internal updates that may result in invoking this method.

Add this event if your app supports the remote-notification UIBackground mode. This event is intended as a means for apps to minimize the time that elapses between the user seeing a push notification and the app displaying the associated data. When a push notification arrives, the system displays the notification to the user and launches the app in the background (if needed) so that it can call this event. Use this event to download any data related to the push notification. When your method is done, call the endBackgroundHandler method with handlerID parameter from this event.

The system fires this event regardless of the state of your app. If your app is suspended or not running, the system wakes up or launches your app and puts it into the background running state before firing the event.

When this event is fired, your app has up to 30 seconds of wall-clock time to perform the download operation and call the endBackgroundHandler method. In practice, your app should call the endBackgroundHandler method as soon as possible after initiating the download. If you do not call the endBackgroundHandler method in time, your app is suspended. More importantly, the system uses the elapsed time to calculate power usage and data costs for your app's background downloads. If your app takes a long time to call endBackgroundHandler method, it may be given fewer future opportunities to fetch data in the future.

If you are downloading large content, initiate the download using a urlSession background download task, then call the endBackgroundHandler method. Listen for the downloadcompleted event to prepare the data for use.

The event returns the dictionary containing the handlerID property, which is a unique handler ID for the current event. This identifier should be passed as the argument to the endBackgroundHandler method.

You can send extra information with a silent push using extra:

{
  aps: {
    'content-available': 1
  },
  extra: {
    foo: 'bar'
  }
}

In the event handler for silentpush, your code may look something like this:

{
  "handlerId": "SilentPush-1415976886.375816",
  "aps": {
    "content-available": 1,
  },
  "extra": {
    "foo": "bar"
  },
  "bubbles": true,
  "type": "silentpush",
  "source": {},
  "cancelBubble": false
}

This event only needs to be used if your app is using the urlSession module to upload data.

Add this event if your Titanium application if you are using a WatchKit extension. When your WatchKit extension uses the openParentApplication:reply method your Titanium application will be opened in the background and provides your Titanium app the information from the extension. When this event is fired you must provide a reply by calling the sendWatchExtensionReply method with the handlerID parameter from this event.

The event returns the dictionary containing the handlerID property, which is a unique handler ID for the current event and the userInfo property, containing the dictionary passed from the WatchKit extension. The handlerID identifier must be passed as the an argument to the sendWatchExtensionReply method.

Ti.App.iOS.addEventListener("watchkitextensionrequest",function(e){
    var replyContent = {foo:"bar"};
    Ti.App.iOS.sendWatchExtensionReply(e.handlerId,replyContent);
});