Last active
November 22, 2019 16:26
-
-
Save drauggres/2ecc6ad79e7e66d1e9d3203a16d67a32 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* @fileoverview Generated externs. DO NOT EDIT! | |
* @externs | |
*/ | |
/** | |
* An extension of the [NSURLConnectionDelegate](https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLConnectionDelegate_Protocol/Reference/Reference.html#//apple_ref/occ/intf/NSURLConnectionDelegate) protocol to allow users to participate in authentication and resource management for this HTTPClient. | |
* @typedef {{ | |
* }} | |
*/ | |
var APSConnectionDelegate = {}; | |
/** | |
* Options object for the [accept](Titanium.Network.Socket.TCP.accept) method. | |
* - timeout Timeout, in milliseconds, for all `write` operations. | |
* - error Callback to be fired when the socket enters the [ERROR](Titanium.Network.Socket.ERROR) state. | |
* @typedef {{ | |
* timeout: Number, | |
* error: Callback<ErrorCallbackArgs> | |
* }} | |
*/ | |
var AcceptDict = {}; | |
/** | |
* Argument object passed to the [accepted](Titanium.Network.Socket.TCP.accepted) | |
* callback when a listener accepts a connection. | |
* | |
* - socket Socket which received the connection. | |
* - inbound Socket which represents the inbound connection. | |
* @typedef {{ | |
* socket: Titanium.Network.Socket.TCP, | |
* inbound: Titanium.Network.Socket.TCP | |
* }} | |
*/ | |
var AcceptedCallbackArgs = {}; | |
/** | |
* Simple object passed to the | |
* [startActivityForResult](Titanium.Android.Activity.startActivityForResult) callback. | |
* | |
* - requestCode Unique, automatically generated integer request code. | |
* | |
* - resultCode Integer result code that the started activity passed to | |
* [setResult](Titanium.Android.Activity.setResult). | |
* | |
* - intent Intent that can contain data returned to the caller. Data can be attached to | |
* the intent as "extras"). | |
* | |
* @typedef {{ | |
* requestCode: Number, | |
* resultCode: Number, | |
* intent: Titanium.Android.Intent | |
* }} | |
*/ | |
var ActivityResult = {}; | |
/** | |
* Optional parameter to enable animation to [hide](Titanium.UI.View.hide) and [show](Titanium.UI.View.show). | |
* - animated Determines whether to enable a circular reveal animation. | |
* @typedef {{ | |
* animated: Boolean | |
* }} | |
*/ | |
var AnimationOption = {}; | |
/** | |
* An abstract datatype for specifying an attributed string attribute. | |
* - type Attribute to apply to the text. | |
* - value Attribute value. | |
* - range Attribute range. | |
* @typedef {{ | |
* type: Number, | |
* value: Number, | |
* range: Array<Number> | |
* }} | |
*/ | |
var Attribute = {}; | |
/** | |
* The object returned to the <Titanium.UI.WebView.backForwardList> method. | |
* - currentItem The current item. | |
* - backItem The item immediately preceding the current item. | |
* - forwardItem The item immediately following the current item. | |
* - backList The portion of the list preceding the current item. | |
* - forwardList The portion of the list following the current item. | |
* @typedef {{ | |
* currentItem: BackForwardListItem, | |
* backItem: BackForwardListItem, | |
* forwardItem: BackForwardListItem, | |
* backList: Array<BackForwardListItem>, | |
* forwardList: Array<BackForwardListItem> | |
* }} | |
*/ | |
var BackForwardList = {}; | |
/** | |
* The object represents a webpage in the back-forward of a web view. | |
* - url The URL of the webpage represented by this item. | |
* - initialUrl The URL of the initial request that created this item. | |
* - title The title of the webpage represented by this item. | |
* @typedef {{ | |
* url: String, | |
* initialUrl: String, | |
* title: String | |
* }} | |
*/ | |
var BackForwardListItem = {}; | |
/** | |
* Object describing a button bar or tabbed bar item. | |
* - title Button title, used if no `image` is specified. | |
* - image Button icon. If specified, takes precedence over `title`. | |
* - width Width for this button. | |
* - enabled Whether the button is enabled initially. | |
* - accessibilityLabel A succint label associated with the bar item for the device's accessibility service. | |
* @typedef {{ | |
* title: String, | |
* image: (String|Titanium.Blob|Titanium.Filesystem.File), | |
* width: Number, | |
* enabled: Boolean, | |
* accessibilityLabel: String | |
* }} | |
*/ | |
var BarItemType = {}; | |
/** | |
* Simple `Error` instance thrown from the | |
* [executeAll](Titanium.Database.DB.executeAll) method in case of failure | |
* | |
* - index Index of the failed query | |
* - results partial `ResultSet`s of any successful queries before the failure | |
* @typedef {{ | |
* index: Number, | |
* results: Array<Titanium.Database.ResultSet> | |
* }} | |
*/ | |
var BatchQueryError = {}; | |
/** | |
* Dictionary to specify a boundary identifier for <Titanium.UI.iOS.CollisionBehavior.addBoundary>. | |
* - identifier Arbitrary identifier for the boundary | |
* - point1 Start point for the boundary | |
* - point2 End point for the boundary | |
* @typedef {{ | |
* identifier: String, | |
* point1: Point, | |
* point2: Point | |
* }} | |
*/ | |
var BoundaryIdentifier = {}; | |
/** | |
* Simple object holding the data for a logical cpu. | |
* - model General description of the CPU | |
* - speed Speed of the CPU in MHz | |
* - times A collection of timings for this logical CPU. | |
* @typedef {{ | |
* model: String, | |
* speed: Number, | |
* times: CPUTimes | |
* }} | |
*/ | |
var CPU = {}; | |
/** | |
* Simple object holding the data for a logical cpu execution times. | |
* - user The number of milliseconds the CPU has spent in user mode. | |
* - nice The number of milliseconds the CPU has spent in nice mode. | |
* - sys The number of milliseconds the CPU has spent in sys mode. | |
* - idle The number of milliseconds the CPU has spent in idle mode. | |
* - irq The number of milliseconds the CPU has spent in irq mode. | |
* @typedef {{ | |
* user: Number, | |
* nice: Number, | |
* sys: Number, | |
* idle: Number, | |
* irq: Number | |
* }} | |
*/ | |
var CPUTimes = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Error message, if any returned. | |
* - code Error code, if any returned. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var CalendarPermissionResponse = {}; | |
/** | |
* A media object from the camera or photo gallery. | |
* - success Indicates if the operation succeeded. Returns `true`. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0. | |
* - media The media object, as a [Blob](Titanium.Blob). | |
* - mediaType The type of media, either `MEDIA_TYPE_PHOTO`, `MEDIA_TYPE_LIVEPHOTO` or `MEDIA_TYPE_VIDEO` defined in <Titanium.Media>. | |
* - cropRect Simple object defining the user's selected crop rectangle, or `null` if the user has not edited the photo. | |
* - previewRect Simple object defining the preview image size. | |
* - livePhoto The live photo object, as a <Titanium.UI.iOS.LivePhoto> and | |
* `undefined` if no live photo is selected. | |
* | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* media: Titanium.Blob, | |
* mediaType: String, | |
* cropRect: CropRectType, | |
* previewRect: PreviewRectType, | |
* livePhoto: Titanium.UI.iOS.LivePhoto | |
* }} | |
*/ | |
var CameraMediaItemType = {}; | |
/** | |
* Simple object for specifying options to [showCamera](Titanium.Media.showCamera). | |
* - success Function to call when the camera is closed after a successful capture/selection. | |
* - error Function to call upon receiving an error. | |
* - cancel Function to call if the user presses the cancel button. | |
* - autohide Specifies if the camera should be hidden automatically after the media capture is completed. | |
* - animated Specifies if the dialog should be animated upon showing and hiding. | |
* - saveToPhotoGallery Specifies if the media should be saved to the photo gallery upon successful capture. | |
* - allowEditing Specifies if the media should be editable after capture/selection. | |
* - mediaTypes Array of media type constants to allow. Note: If you want to select live photos, iOS only allows | |
* you to select existing live photos from the gallery, capturing new live photos is not supported by | |
* iOS public API, yet. | |
* | |
* - videoMaximumDuration Maximum duration (in milliseconds) to allow video capture before completing. | |
* - videoQuality Constant to indicate the video quality during capture. | |
* - whichCamera Opens the camera with the specified camera direction. | |
* - showControls Indicates if the built-in camera controls should be displayed. | |
* - overlay View to added as an overlay to the camera UI (on top). | |
* - transform Transformation matrix to apply to the camera or photogallery view. | |
* - inPopOver Show the camera in a popover. | |
* - popoverView View to position the camera or photo gallery popover on top of. | |
* - arrowDirection Controls the type of arrow and position of the popover. | |
* - autorotate Determines if the camera preview should rotate or not. | |
* @typedef {{ | |
* success: Callback<CameraMediaItemType>, | |
* error: Callback<FailureResponse>, | |
* cancel: Callback<FailureResponse>, | |
* autohide: Boolean, | |
* animated: Boolean, | |
* saveToPhotoGallery: Boolean, | |
* allowEditing: Boolean, | |
* mediaTypes: Array<String>, | |
* videoMaximumDuration: Number, | |
* videoQuality: Number, | |
* whichCamera: Number, | |
* showControls: Boolean, | |
* overlay: Titanium.UI.View, | |
* transform: Titanium.UI.Matrix2D, | |
* inPopOver: Boolean, | |
* popoverView: Titanium.UI.View, | |
* arrowDirection: Number, | |
* autorotate: Boolean | |
* }} | |
*/ | |
var CameraOptionsType = {}; | |
/** | |
* Dictionary describing the items for <Titanium.UI.Clipboard.setItems>. | |
* - items An array of key-value items to add to the clipboard. The key must a valid mime-type | |
* matching the mime-type of the value. | |
* | |
* - options The privacy options to apply to all the items on the clipboard. The available options are | |
* described in `Ti.UI.CLIPBOARD_OPTION_*`. Depending on the key, the value can be a Date or | |
* Boolean. | |
* | |
* @typedef {{ | |
* items: Array<Dictionary>, | |
* options: Dictionary | |
* }} | |
*/ | |
var ClipboardItemsType = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - permission Dictionary of permissions. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* permission: Dictionary | |
* }} | |
*/ | |
var CloudACLsCheckResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - acls Set of ACL objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* acls: Array<Dictionary> | |
* }} | |
*/ | |
var CloudACLsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - chat_groups Set of `chat_groups` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* chat_groups: Array<Dictionary> | |
* }} | |
*/ | |
var CloudChatGroupsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - chats Set of `chats` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* chats: Array<Dictionary> | |
* }} | |
*/ | |
var CloudChatsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - checkins Set of `checkins` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* checkins: Array<Dictionary> | |
* }} | |
*/ | |
var CloudCheckinsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - ip_address IP address of client. | |
* - location Location of client. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* ip_address: String, | |
* location: Dictionary | |
* }} | |
*/ | |
var CloudClientsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String | |
* }} | |
*/ | |
var CloudEmailsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - event_occurrences Set of `event` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* event_occurrences: Array<Dictionary> | |
* }} | |
*/ | |
var CloudEventOccurrencesResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - events Set of `event` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* events: Array<Dictionary> | |
* }} | |
*/ | |
var CloudEventsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - files Set of `file` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* files: Array<Dictionary> | |
* }} | |
*/ | |
var CloudFilesResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - friend_requests Set of `user` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* friend_requests: Array<Dictionary> | |
* }} | |
*/ | |
var CloudFriendRequestsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - users Set of `user` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* users: Array<Dictionary> | |
* }} | |
*/ | |
var CloudFriendsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - geo_fences Set of geo-fence objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* geo_fences: Array<Dictionary> | |
* }} | |
*/ | |
var CloudGeoFenceResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - keyvalues Set of `keyvalues` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* keyvalues: Array<Dictionary> | |
* }} | |
*/ | |
var CloudKeyValuesResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - likes Set of `like` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* likes: Array<Dictionary> | |
* }} | |
*/ | |
var CloudLikesResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - messages Set of `message` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* messages: Array<Dictionary> | |
* }} | |
*/ | |
var CloudMessagesResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - classname Set of `classname` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* classname: Array<Dictionary> | |
* }} | |
*/ | |
var CloudObjectsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - photos Set of `photos` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* photos: Array<Dictionary> | |
* }} | |
*/ | |
var CloudPhotoCollectionsPhotosResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - collections Set of `collections` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* collections: Array<Dictionary> | |
* }} | |
*/ | |
var CloudPhotoCollectionsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - photos Set of `photos` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* photos: Array<Dictionary> | |
* }} | |
*/ | |
var CloudPhotosResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - places Set of `places` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* places: Array<Dictionary> | |
* }} | |
*/ | |
var CloudPlacesResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - posts Set of `posts` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* posts: Array<Dictionary> | |
* }} | |
*/ | |
var CloudPostsResponse = {}; | |
/** | |
* Simple object for specifying token retrieval options to [retrieveDeviceToken](Modules.CloudPush.retrieveDeviceToken). | |
* | |
* - success Callback function called when the push registration is successfully completed. | |
* | |
* - error Callback function called when an error occurs during registration. | |
* | |
* @typedef {{ | |
* success: Callback<CloudPushNotificationSuccessArg>, | |
* error: Callback<CloudPushNotificationErrorArg> | |
* }} | |
*/ | |
var CloudPushNotificationConfig = {}; | |
/** | |
* A simple object passed to the [retrieveDeviceToken](Modules.CloudPush.retrieveDeviceToken) error callback. | |
* | |
* - error Description of the error. | |
* @typedef {{ | |
* error: String | |
* }} | |
*/ | |
var CloudPushNotificationErrorArg = {}; | |
/** | |
* A simple object passed to the [retrieveDeviceToken](Modules.CloudPush.retrieveDeviceToken) success callback. | |
* | |
* - deviceToken The device token which this device was registered for. | |
* @typedef {{ | |
* deviceToken: String | |
* }} | |
*/ | |
var CloudPushNotificationSuccessArg = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - push_channels Array of `push_channel` names, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* push_channels: Array<String> | |
* }} | |
*/ | |
var CloudPushNotificationsQueryChannelResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - subscriptions Set of `subscription` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* subscriptions: Array<Dictionary> | |
* }} | |
*/ | |
var CloudPushNotificationsQueryResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String | |
* }} | |
*/ | |
var CloudPushNotificationsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - devices Dictionary containing counts of devices subscribed to a push channel, grouped by platform. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* devices: Dictionary | |
* }} | |
*/ | |
var CloudPushNotificationsShowChannelResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - push_schedules Array of [schedules push notifications](https://docs.appcelerator.com/arrowdb/latest/#!/api/PushSchedules), if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* push_schedules: Array<Object> | |
* }} | |
*/ | |
var CloudPushSchedulesResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String | |
* }} | |
*/ | |
var CloudResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - reviews Set of `reviews` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* reviews: Array<Dictionary> | |
* }} | |
*/ | |
var CloudReviewsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - users Set of `users` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* users: Array<Dictionary> | |
* }} | |
*/ | |
var CloudSocialIntegrationsResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - statuses Set of `statuses` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* statuses: Array<Dictionary> | |
* }} | |
*/ | |
var CloudStatusesResponse = {}; | |
/** | |
* Argument passed to the callback as a request is transmitted or received. | |
* - progress A value from 0.0-1.0 with the progress of the exchange. | |
* - url The URL for the request, to help identify it. | |
* @typedef {{ | |
* progress: Number, | |
* url: String | |
* }} | |
*/ | |
var CloudStreamProgress = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - users Set of `user` objects, if any exist. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* users: Array<Dictionary> | |
* }} | |
*/ | |
var CloudUsersResponse = {}; | |
/** | |
* Properties for the modal dialog used in 3-Legged OAuth | |
* - title Defines the title for the dialog. | |
* @typedef {{ | |
* title: String | |
* }} | |
*/ | |
var CloudUsersSecureDialog = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Indicates whether the request failed. | |
* - meta Meta data, if any returned. | |
* - code Error code, if any returned. | |
* - message Error message, if any returned. | |
* - accessToken Identifies the current access token when using 3-Legged OAuth. | |
* - expiresIn Indicates the number of seconds before the access token expires. | |
* @typedef {{ | |
* success: Boolean, | |
* error: Boolean, | |
* meta: Dictionary, | |
* code: Number, | |
* message: String, | |
* accessToken: String, | |
* expiresIn: Number | |
* }} | |
*/ | |
var CloudUsersSecureResponse = {}; | |
/** | |
* Argument object passed to the [connected](Titanium.Network.Socket.TCP.connected) callback when the socket connects. | |
* - socket Socket instance that has been connected. | |
* @typedef {{ | |
* socket: Titanium.Network.Socket.TCP | |
* }} | |
*/ | |
var ConnectedCallbackArgs = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var ContactsAuthorizationResponse = {}; | |
/** | |
* Simple object for defining a single image in a cover flow view. | |
* - image Image to use, as a local file URL, `Blob`, or `File`. | |
* - width Display width for the image, in Apple points. | |
* - height Display height of the image, in Apple points. | |
* @typedef {{ | |
* image: (String|Titanium.Blob|Titanium.Filesystem.File), | |
* width: Number, | |
* height: Number | |
* }} | |
*/ | |
var CoverFlowImageType = {}; | |
/** | |
* Arguments to be passed to createBuffer | |
* - value An initial value which will be encoded and placed in the buffer. If value is a Number, type must also be set. (this is simply a convenient way of calling <Titanium.Codec.encodeString> or <Titanium.Codec.encodeNumber> and placing the encoded value in the returned buffer.) | |
* - length The length of the buffer. | |
* - type The type of data encoding to use with `value`. | |
* - byteOrder The byte order of this buffer. | |
* @typedef {{ | |
* value: (String|Number), | |
* length: Number, | |
* type: String, | |
* byteOrder: Number | |
* }} | |
*/ | |
var CreateBufferArgs = {}; | |
/** | |
* Argument passed to [createStream](Titanium.Stream.createStream). | |
* - source Object that the stream will read from or write to. | |
* - mode Mode to open the stream in. | |
* @typedef {{ | |
* source: (Titanium.Blob|Titanium.Buffer), | |
* mode: Number | |
* }} | |
*/ | |
var CreateStreamArgs = {}; | |
/** | |
* Simple object for describing the crop rectangle for an image. | |
* - x X coordinate of the crop rectangle's upper-left corner. | |
* - y Y coordinate of the crop rectangle's upper-left corner. | |
* - width Width of the crop rectangle, in pixels. | |
* - height Height of the crop rectangle, in pixels. | |
* @typedef {{ | |
* x: Number, | |
* y: Number, | |
* width: Number, | |
* height: Number | |
* }} | |
*/ | |
var CropRectType = {}; | |
/** | |
* Named parameters for <Titanium.Codec.decodeNumber>. | |
* - source Buffer to decode. | |
* - type The encoding type to use. | |
* - position Index in the `source` buffer of the first byte of data to decode. | |
* - byteOrder byte order to decode with. | |
* @typedef {{ | |
* source: Titanium.Buffer, | |
* type: String, | |
* position: Number, | |
* byteOrder: Number | |
* }} | |
*/ | |
var DecodeNumberDict = {}; | |
/** | |
* Named parameters for <Titanium.Codec.decodeString>. | |
* - source Buffer to decode. | |
* - position Index in the `source` buffer of the first byte of data to decode. | |
* - length Number of bytes to decode. | |
* - charset Character set to use when encoding this string to bytes. | |
* @typedef {{ | |
* source: Titanium.Buffer, | |
* position: Number, | |
* length: Number, | |
* charset: String | |
* }} | |
*/ | |
var DecodeStringDict = {}; | |
/** | |
* Plain JavaScript object. | |
* @typedef {{ | |
* }} | |
*/ | |
var Dictionary = {}; | |
/** | |
* A simple object consisting of the position and size measurements. | |
* - height The height measurement. | |
* - width The width measurement. | |
* - x The x-axis coordinate of the position. | |
* - y The y-axis coordinate of the position. | |
* @typedef {{ | |
* height: Number, | |
* width: Number, | |
* x: Number, | |
* y: Number | |
* }} | |
*/ | |
var Dimension = {}; | |
/** | |
* A simple object for specifying options when showing or dismissing a <Titanium.UI.iOS.DocumentViewer>. | |
* - animated Indicates whether to animate the transition. | |
* - view Anchors the options menu to the specified view. | |
* @typedef {{ | |
* animated: Boolean, | |
* view: Titanium.UI.View | |
* }} | |
*/ | |
var DocumentViewerOptions = {}; | |
/** | |
* Named parameters for <Titanium.Codec.encodeNumber>. | |
* - source Number to encode. | |
* - dest Destination buffer. | |
* - type Encoding type to use. | |
* - position Index in the `dest` buffer of the first byte of encoded data. | |
* - byteOrder Byte order to encode with. | |
* @typedef {{ | |
* source: Number, | |
* dest: Titanium.Buffer, | |
* type: String, | |
* position: Number, | |
* byteOrder: Number | |
* }} | |
*/ | |
var EncodeNumberDict = {}; | |
/** | |
* Named parameters for <Titanium.Codec.encodeString>. | |
* - source Source string to encode. | |
* - dest Destination buffer. | |
* - destPosition Index in the `dest` buffer of the first byte of the encoded string. | |
* - sourcePosition Position in `source` to start encoding. | |
* - sourceLength Number of characters in `source` to encode. | |
* - charset Character encoding to use when encoding this string to bytes. | |
* @typedef {{ | |
* source: String, | |
* dest: Titanium.Buffer, | |
* destPosition: Number, | |
* sourcePosition: Number, | |
* sourceLength: Number, | |
* charset: String | |
* }} | |
*/ | |
var EncodeStringDict = {}; | |
/** | |
* Object passed to the error callback when the socket enters the [ERROR](Titanium.Network.Socket.ERROR) state. | |
* - success Indicates if the operation succeeded. Returns `false`. | |
* - error Error message, if any returned. | |
* - code Error code. Returns a non-zero value. | |
* - socket Socket that experienced the error. | |
* - errorCode The error code of the error (potentially system-dependent). | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* socket: Titanium.Network.Socket.TCP, | |
* errorCode: Number | |
* }} | |
*/ | |
var ErrorCallbackArgs = {}; | |
/** | |
* Properties used in any event or callback which needs to report a success or failure. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var ErrorResponse = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates whether the request succeeded. | |
* - error Error message, if any returned. | |
* - code Error code, if any returned. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var EventsAuthorizationResponse = {}; | |
/** | |
* Properties used in any event or callback which needs to report a failure. | |
* - success Indicates if the operation succeeded. Returns `false`. | |
* - error Error message, if any returned. | |
* - code Error code. Returns a non-zero value. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var FailureResponse = {}; | |
/** | |
* An abstract datatype for specifying a text font. | |
* - fontFamily Specifies the font family or specific font to use. | |
* - fontSize Font size, in platform-dependent units. | |
* - fontWeight Font weight. Valid values are "bold", "semibold", "normal", "thin", | |
* "light" and "ultralight". | |
* | |
* - fontStyle Font style. Valid values are "italic" or "normal". | |
* - textStyle The text style for the font. | |
* @typedef {{ | |
* fontFamily: String, | |
* fontSize: (Number|String), | |
* fontWeight: String, | |
* fontStyle: String, | |
* textStyle: String | |
* }} | |
*/ | |
var Font = {}; | |
/** | |
* Simple object returned in the callback from the | |
* [forwardGeocoder](Titanium.Geolocation.forwardGeocoder) method. | |
* | |
* Note that Android includes a number of extra fields. | |
* | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* - accuracy Estimated accuracy of the geocoding, in meters. | |
* - longitude Longitude of the geocoded address. | |
* - latitude Latitude of the geocoded address. | |
* - street Street name, without street address. | |
* - street1 Street name. | |
* - city City name. | |
* - region1 First line of region. | |
* - region2 Not used. | |
* - postalCode Postal code. | |
* - country Country name. | |
* - countryCode Country code. | |
* - country_code Country code. Same as `countryCode`. | |
* - displayAddress Display address. Identical to `address`. | |
* - address Full address. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* accuracy: Number, | |
* longitude: String, | |
* latitude: String, | |
* street: String, | |
* street1: String, | |
* city: String, | |
* region1: String, | |
* region2: String, | |
* postalCode: String, | |
* country: String, | |
* countryCode: String, | |
* country_code: String, | |
* displayAddress: String, | |
* address: String | |
* }} | |
*/ | |
var ForwardGeocodeResponse = {}; | |
/** | |
* Simple object representing a place, returned in the callback from the | |
* [reverseGeocoder](Titanium.Geolocation.reverseGeocoder) method. | |
* | |
* - street Street name, without street address. | |
* - street1 Street name. | |
* - city City name. | |
* - region1 First line of region. | |
* - region2 Not used. | |
* - postalCode Postal code | |
* - zipcode Postal code. To be replaced by `postalCode` | |
* - country Country name. | |
* - countryCode Country code. | |
* - country_code Country code. To be replaced by `countryCode`. | |
* - longitude Longitude of the geocoded point. | |
* - latitude Latitude of the geocoded point. | |
* - displayAddress Display address. Identical to `address`. | |
* - address Full address. | |
* @typedef {{ | |
* street: String, | |
* street1: String, | |
* city: String, | |
* region1: String, | |
* region2: String, | |
* postalCode: String, | |
* zipcode: String, | |
* country: String, | |
* countryCode: String, | |
* country_code: String, | |
* longitude: Number, | |
* latitude: Number, | |
* displayAddress: String, | |
* address: String | |
* }} | |
*/ | |
var GeocodedAddress = {}; | |
/** | |
* Dictionary object of parameters used to register the application with local notifications using | |
* the <Titanium.App.iOS.registerUserNotificationSettings> method. | |
* | |
* - types Notification types to use. | |
* - categories Set of categories of user notification actions required by the applicaiton to use. | |
* - authorizationStatus The current authorization status for using notifications. | |
* - soundSetting The current sound settings. | |
* - badgeSetting The current badge settings. | |
* - alertSetting The current alert settings. | |
* - notificationCenterSetting The current notication-center settings. | |
* - lockScreenSetting The current lock-screen settings. | |
* - carPlaySetting The current CarPlay settings. | |
* - criticalAlertSetting The authorization status to play sounds for critical alerts. | |
* Available in Titanium SDK 7.4.0 and later. | |
* | |
* - providesAppNotificationSettings A Boolean value indicating the system displays a button for in-app notification settings. | |
* Available in Titanium SDK 7.4.0 and later. | |
* | |
* - alertStyle The current alert style used to display notifications. | |
* @typedef {{ | |
* types: Array<Number>, | |
* categories: Array<Titanium.App.iOS.UserNotificationCategory>, | |
* authorizationStatus: Number, | |
* soundSetting: Number, | |
* badgeSetting: Number, | |
* alertSetting: Number, | |
* notificationCenterSetting: Number, | |
* lockScreenSetting: Number, | |
* carPlaySetting: Number, | |
* criticalAlertSetting: Number, | |
* providesAppNotificationSettings: Number, | |
* alertStyle: Number | |
* }} | |
*/ | |
var GetUserNotificationSettings = {}; | |
/** | |
* The APIs that reside in the global scope, which may be called without a namespace prefix. | |
* @description Titanium provides a number of global built-in objects, detailed below. | |
* | |
* #### JSON | |
* | |
* Titanium provides a built-in [JSON](Global.JSON) object two functions, `parse` and `stringify`. | |
* | |
* #### String Utilities | |
* | |
* Titanium includes several extra utility functions for formatting text, attached to the | |
* global [String](Global.String) object. | |
* | |
* #### console | |
* | |
* Titanium provides [console](Global.console) support familiar to many javascript developers | |
* for logging at the toplevel, in addition to the [Titanium](Titanium.API) logging facilities. | |
* | |
* #### Timers | |
* | |
* Titanium has built-in support for one-off and repeating timers: | |
* | |
* * Use [setTimeout](Global.setTimeout) to start a one-off timer. | |
* | |
* * Use [setInterval](Global.setInterval) to start a repeating timer. | |
* | |
* #### Alert | |
* | |
* Titanium has a built-in convenience function [alert](Global.alert) which can be used as an alias | |
* for the [AlertDialog](Titanium.UI.AlertDialog) module. | |
* | |
* #### Locale | |
* | |
* The `L` macro can also be used as an alias for the <Titanium.Locale.getString> method. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
/** | |
* Displays a pop-up alert dialog with the passed in `message`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} message Alert message. | |
*/ | |
var alert = function(message) {}; | |
/** | |
* Cancels an interval timer. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} timerId Unique timer identifier returned by [setInterval](Global.setInterval). | |
*/ | |
var clearInterval = function(timerId) {}; | |
/** | |
* Cancels a one-time timer. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} timerId Unique timer identifier returned by [setTimeout](Global.setTimeout). | |
*/ | |
var clearTimeout = function(timerId) {}; | |
/** | |
* Replaces each escape sequence in the specified string, created using the `encodedURI` | |
* method, with the character that it represents. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} encodedURI Text that optionally contains encoded escape sequences. | |
* @return {String} | |
*/ | |
var decodeURIComponent = function(encodedURI) {}; | |
/** | |
* Replaces each special character in the specified string with the equivalent URI escape | |
* sequence. Useful for encoding URIs. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} string Text that optionally contains special characters. | |
* @return {String} | |
*/ | |
var encodeURIComponent = function(string) {}; | |
/** | |
* An alias for [Titanium.Locale.getString](Titanium.Locale.getString). | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} key Key used to lookup the localized string. | |
* @param {String=} hint Text to return if `key` is not found. | |
* @return {String} | |
*/ | |
var L = function(key, hint) {}; | |
/** | |
* Loads either a native Titanium module or a CommonJS module. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} moduleId Native module ID or local path to a JavaScript file *minus* the `.js` extension. | |
* @return {Object} | |
*/ | |
var require = function(moduleId) {}; | |
/** | |
* Executes a function repeatedly with a fixed time delay between each call to that function. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Callback} function_ Function to call. | |
* @param {Number} delay Time in milliseconds to wait between calls to function. | |
* @return {Number} | |
*/ | |
var setInterval = function(function_, delay) {}; | |
/** | |
* Executes code or a function after a delay. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Callback} function_ Code or function to call. | |
* @param {Number} delay Time in milliseconds to wait before the function is called. | |
* @return {Number} | |
*/ | |
var setTimeout = function(function_, delay) {}; | |
/** | |
* Global JSON object providing the [parse](Global.JSON.parse) and [stringify](Global.JSON.stringify) methods. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
var JSON = function() {}; | |
/** | |
* Produces a JSON text from a JavaScript value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Object} value Any JavaScript value, usually an object or array. | |
* @param {Callback|Array<String>=} replacer Determines how object values are stringified for objects. See main text for usage. | |
* | |
* @param {Number|String=} space Specifies how nested structures are indented. If it is a number, it specifies the number of spaces to indent at each level. If it is a string (such as '\\t' or '&nbsp;'), it specifies the characters used to indent at each level. | |
* @return {String} | |
*/ | |
JSON.stringify = function(value, replacer, space) {}; | |
/** | |
* Parses a JSON text to produce an object or array. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} text JSON text to parse. | |
* @param {Callback} reviver Function to filter and transform the results. | |
* @return {Object} | |
*/ | |
JSON.parse = function(text, reviver) {}; | |
/** | |
* The JavaScript built-in String type. | |
* @description This module contains Titanium-only extensions for formatting data into locale-specific strings. | |
* The target locale is configured by the user in the device's system Settings. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
var String = function() {}; | |
/** | |
* Formats a string using `printf`-style substitution. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} formatString An IEEE `printf`-style string, containing zero or more conversion specifications. | |
* @param {...String|Number} value Values to substitute into the `formatString`. The method expects a variable number | |
* of `value` arguments, one for each `%` conversion specification in the format | |
* string. Optional on Android. | |
* | |
* @return {String} | |
*/ | |
String.format = function(formatString, value) {}; | |
/** | |
* Formats a number into the currency format, including currency symbol, of the locale | |
* configured for the system. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} value Currency value. | |
* @return {String} | |
*/ | |
String.formatCurrency = function(value) {}; | |
/** | |
* Formats a date into the date format of the locale configured for the system. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Date} date Date to format. | |
* @param {String=} format Date format to use. One of 'short', 'medium', 'long' or 'full'. | |
* @return {String} | |
*/ | |
String.formatDate = function(date, format) {}; | |
/** | |
* Formats a number into the decimal format, including decimal symbol, of the locale | |
* configured for the system. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} value Value to format. | |
* @param {String=} locale Locale string. For example, `en-US` for US English. | |
* @param {String=} pattern Format pattern. | |
* @return {String} | |
*/ | |
String.formatDecimal = function(value, locale, pattern) {}; | |
/** | |
* Formats a date into the time format of the locale configured for the system. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Date} date Date to format. | |
* @param {String=} format Date format to use. One of 'short', 'medium', or 'long' (iOS only.) | |
* @return {String} | |
*/ | |
String.formatTime = function(date, format) {}; | |
/** | |
* Console logging facilities. | |
* @description The toplevel `console` support is intended to supplement <Titanium.API> | |
* and make it easier for developers to port existing javascript code | |
* (especially CommonJS modules) to Titanium. | |
* | |
* Note that `console` does not currently implement the complete | |
* [Console](https://developer.mozilla.org/de/docs/Web/API/Console) specification. | |
* See the following supported methods for details and submit a pull request to add more! | |
* | |
* @since 2.1.0 (Android), 2.1.0 (iPhone), 2.1.0 (iPad) | |
*/ | |
var console = function() {}; | |
/** | |
* Log a message at the `info` level. | |
* @since 2.1.0 (Android), 2.1.0 (iPhone), 2.1.0 (iPad) | |
* @param {Object} message The message(s) to log. | |
*/ | |
console.log = function(message) {}; | |
/** | |
* Log a message at the `info` level. | |
* @since 2.1.0 (Android), 2.1.0 (iPhone), 2.1.0 (iPad) | |
* @param {Object} message The message(s) to log. | |
*/ | |
console.info = function(message) {}; | |
/** | |
* Log a message at the `warn` level. | |
* @since 2.1.0 (Android), 2.1.0 (iPhone), 2.1.0 (iPad) | |
* @param {Object} message The message(s) to log. | |
*/ | |
console.warn = function(message) {}; | |
/** | |
* Log a message at the `error` level. | |
* @since 2.1.0 (Android), 2.1.0 (iPhone), 2.1.0 (iPad) | |
* @param {Object} message The message(s) to log. | |
*/ | |
console.error = function(message) {}; | |
/** | |
* Log a message at the `debug` level. | |
* @since 2.1.0 (Android), 2.1.0 (iPhone), 2.1.0 (iPad) | |
* @param {Object} message The message(s) to log. | |
*/ | |
console.debug = function(message) {}; | |
/** | |
* Start a timer to track duration of an operation. | |
* @since 7.3.0 (Android), 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {String=} label The label to track the timer by | |
*/ | |
console.time = function(label) {}; | |
/** | |
* Stop a timer that was previously started. | |
* @since 7.3.0 (Android), 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {String=} label The label to track the timer by | |
*/ | |
console.timeEnd = function(label) {}; | |
/** | |
* Log duration taken so far for an operation. | |
* @since 7.5.0 (Android), 7.5.0 (iPhone), 7.5.0 (iPad) | |
* @param {String=} label The label to track the timer by | |
* @param {Object=} data Extra log data to be provided when logging, can be a single argument or any number of arguments. | |
*/ | |
console.timeLog = function(label, data) {}; | |
/** | |
* A simple object defining a color gradient. | |
* - type Type of gradient, either 'linear' or 'radial'. | |
* - startPoint Start point for the gradient. | |
* - endPoint End point for the gradient. | |
* - startRadius For a radial gradient, the radius at the `startPoint`. | |
* - endRadius For a radial gradient, the radius at the `endPoint`. | |
* - colors An array of colors, as a color name or hex triplet. | |
* | |
* - backfillStart Set to `true` to continue filling with the starting color beyond the `startPoint`. | |
* - backfillEnd Set to `true` to continue filling with the final color beyond the `endPoint`. | |
* @typedef {{ | |
* type: String, | |
* startPoint: Point, | |
* endPoint: Point, | |
* startRadius: Number, | |
* endRadius: Number, | |
* colors: (Array<String>|Array<GradientColorRef>), | |
* backfillStart: Boolean, | |
* backfillEnd: Boolean | |
* }} | |
*/ | |
var Gradient = {}; | |
/** | |
* A simple object consisting of a color and an offset. | |
* - color Color value at this point in the gradient, as a color name or hex triplet. | |
* | |
* - offset The color's normalized position within the gradient, ranging from 0 (start) to 1 (end). | |
* @typedef {{ | |
* color: String, | |
* offset: Number | |
* }} | |
*/ | |
var GradientColorRef = {}; | |
/** | |
* Simple object holding compass heading data. | |
* - accuracy Accuracy of the compass heading, in platform-specific units. | |
* - magneticHeading Declination in degrees from magnetic North. | |
* - trueHeading Declination in degrees from true North. | |
* - timestamp Timestamp for the heading data, in milliseconds. | |
* - x Raw geomagnetic data for the X axis. | |
* - y Raw geomagnetic data for the Y axis. | |
* - z Raw geomagnetic data for the Z axis. | |
* @typedef {{ | |
* accuracy: Number, | |
* magneticHeading: Number, | |
* trueHeading: Number, | |
* timestamp: Number, | |
* x: Number, | |
* y: Number, | |
* z: Number | |
* }} | |
*/ | |
var HeadingData = {}; | |
/** | |
* Argument passed to the [getCurrentHeading](Titanium.Geolocation.getCurrentHeading) callback. | |
* | |
* - success Indicates a successful operation. | |
* - error Error message, if any returned. | |
* - code Error code. | |
* - heading If `success` is true, the actual heading data. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* heading: HeadingData | |
* }} | |
*/ | |
var HeadingResponse = {}; | |
/** | |
* Simple object used to specify options for [imageAsCropped](Titanium.Blob.imageAsCropped). | |
* - width Width to crop this image to. | |
* - height Height to crop this image to. | |
* - x Left coordinate of the cropped rectangle within the source image. | |
* - y Top coordinate of the cropped rectangle within the source image. | |
* @typedef {{ | |
* width: Number, | |
* height: Number, | |
* x: Number, | |
* y: Number | |
* }} | |
*/ | |
var ImageAsCroppedDict = {}; | |
/** | |
* Template that represents the basic appearance of a list item. | |
* - properties Contains key-value pairs of view properties and their values that are applied to the ListItem. | |
* - events Contains key-value pairs of view events and their listeners that are applied to the ListItem. | |
* - childTemplates Contains an array of subview templates to be added (in order) as children to this view. | |
* | |
* @typedef {{ | |
* properties: Titanium.UI._Dictionary_ListItem, | |
* events: Dictionary, | |
* childTemplates: Array<ViewTemplate> | |
* }} | |
*/ | |
var ItemTemplate = {}; | |
/** | |
* Dictionary object of parameters used to identify an incoming URL that is handled | |
* by the application. | |
* | |
* - source The application or service that triggered the handled URL. | |
* - url The url that was triggered by the application or service. | |
* @typedef {{ | |
* source: String, | |
* url: String | |
* }} | |
*/ | |
var LaunchOptionsType = {}; | |
/** | |
* Represents displayed item data. | |
* - template Template ID configured with the <Titanium.UI.ListView.templates> property or | |
* <Titanium.UI.LIST_ITEM_TEMPLATE_DEFAULT>. | |
* | |
* - properties Contains key-value pairs of view properties and their values that are applied to the | |
* `ListItem`. | |
* | |
* @typedef {{ | |
* template: (String|Number), | |
* properties: Titanium.UI._Dictionary_ListItem | |
* }} | |
*/ | |
var ListDataItem = {}; | |
/** | |
* The arguments for the <Titanium.UI.ListView.prefetch> and <Titanium.UI.ListView.cancelprefetch> events. | |
* - section List section if the item is contained in a list section. | |
* - sectionIndex Section index. | |
* - itemIndex Item index. | |
* - itemId The item ID bound to the list item that generated the event. | |
* @typedef {{ | |
* section: Titanium.UI.ListSection, | |
* sectionIndex: Number, | |
* itemIndex: Number, | |
* itemId: String | |
* }} | |
*/ | |
var ListItemEventType = {}; | |
/** | |
* A simple object for specifying the animation properties to use when inserting or deleting | |
* sections or cells, or scrolling the list. | |
* | |
* - animated Whether this list change should be animated. Ignored if any `animationStyle` value is specified. | |
* - animationStyle Type of animation to use for cell insertions and deletions. | |
* - position Specifies what position to scroll the selected cell to. | |
* @typedef {{ | |
* animated: Boolean, | |
* animationStyle: Number, | |
* position: Number | |
* }} | |
*/ | |
var ListViewAnimationProperties = {}; | |
/** | |
* Optional parameter for [setContentInsets](Titanium.UI.ListView.setContentInsets) method. | |
* - animated Determines whether the list view's content inset change is animated. | |
* - duration The duration in `milliseconds` for animation while the content inset is being changed. | |
* @typedef {{ | |
* animated: Boolean, | |
* duration: Number | |
* }} | |
*/ | |
var ListViewContentInsetOption = {}; | |
/** | |
* The parameter for [setContentInsets](Titanium.UI.TableView.setContentInsets) method. | |
* - top Value specifying the top insets for the enclosing scroll view of the list view. | |
* - left Value specifying the left insets for the enclosing scroll view of the list view. | |
* - right Value specifying the right insets for the enclosing scroll view of the list view. | |
* - bottom Value specifying the bottom insets for the enclosing scroll view of the list view. | |
* @typedef {{ | |
* top: Number, | |
* left: Number, | |
* right: Number, | |
* bottom: Number | |
* }} | |
*/ | |
var ListViewEdgeInsets = {}; | |
/** | |
* A simple object that represents an index entry in a `ListView`. | |
* - title Title to display in the index bar. | |
* - index Section index associated with this title. | |
* @typedef {{ | |
* title: String, | |
* index: Number | |
* }} | |
*/ | |
var ListViewIndexEntry = {}; | |
/** | |
* The parameter for [setMarker](Titanium.UI.ListView.setMarker) and [addMarker](Titanium.UI.ListView.addMarker) methods. | |
* - sectionIndex The sectionIndex of the reference item. | |
* - itemIndex The itemIndex of the reference item. | |
* @typedef {{ | |
* sectionIndex: Number, | |
* itemIndex: Number | |
* }} | |
*/ | |
var ListViewMarkerProps = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var LocationAuthorizationResponse = {}; | |
/** | |
* Simple object holding the data for a location update. | |
* - latitude Latitude of the location update, in decimal degrees. | |
* - longitude Longitude of the location update, in decimal degrees. | |
* - altitude Altitude of the location update, in meters. | |
* - accuracy Accuracy of the location update, in meters. | |
* - altitudeAccuracy Vertical accuracy of the location update, in meters. | |
* - heading Compass heading, in degrees. May be unknown if device is not moving. On | |
* iOS, a negative value indicates that the heading data is not valid. | |
* | |
* - speed Current speed in meters/second. On iOS, a negative value indicates that the | |
* heading data is not valid or the accuracy is configured incorrectly. | |
* Note: Due to the Apple Geolocation API, set the <Titanium.Geolocation.accuracy> | |
* property to <Titanium.Geolocation.ACCURACY_BEST_FOR_NAVIGATION> in order to properly | |
* measure speed changes and prevent the app from returning negative values. | |
* | |
* - timestamp Timestamp for this location update, in milliseconds. | |
* - floor The floor of the building on which the user is located. | |
* @typedef {{ | |
* latitude: Number, | |
* longitude: Number, | |
* altitude: Number, | |
* accuracy: Number, | |
* altitudeAccuracy: Number, | |
* heading: Number, | |
* speed: Number, | |
* timestamp: Number, | |
* floor: LocationCoordinatesFloor | |
* }} | |
*/ | |
var LocationCoordinates = {}; | |
/** | |
* Simple object holding floor of the building on which the user is located. | |
* | |
* - level The logical floor of the building. | |
* @typedef {{ | |
* level: Number | |
* }} | |
*/ | |
var LocationCoordinatesFloor = {}; | |
/** | |
* Simple object describing a location provider. | |
* - accuracy Accuracy of the location provider, either fine (1) or coarse (2). | |
* | |
* - name Name of the location provider. | |
* - power Power consumption for this provider, either low (1), medium (2), or high (3). | |
* | |
* @typedef {{ | |
* accuracy: Number, | |
* name: String, | |
* power: Number | |
* }} | |
*/ | |
var LocationProviderDict = {}; | |
/** | |
* Argument passed to the [getCurrentPosition](Titanium.Geolocation.getCurrentPosition) callback. | |
* | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* - provider If `success` is true, object describing the location provider generating this update. | |
* - coords If `success` is true, actual location data for this update. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* provider: LocationProviderDict, | |
* coords: LocationCoordinates | |
* }} | |
*/ | |
var LocationResults = {}; | |
/** | |
* Simple object passed to <Titanium.UI.createMatrix2D> to initialize a matrix. | |
* - scale Scale the matrix by the specified scaling factor. The same scaling factor is used | |
* for both horizontal and vertical scaling. | |
* | |
* - rotate Rotation angle, in degrees. See the [rotate](Titanium.UI.Matrix2D.rotate) method | |
* for a discussion of rotation. | |
* | |
* - anchorPoint Point to rotate around, specified as a dictionary object with `x` and `y` | |
* properties, where { x: 0.5, y: 0.5 } represents the center of whatever is being | |
* rotated. | |
* | |
* @typedef {{ | |
* scale: Number, | |
* rotate: Number, | |
* anchorPoint: Dictionary | |
* }} | |
*/ | |
var Matrix2DCreationDict = {}; | |
/** | |
* Simple object passed to <Titanium.UI.createMatrix3D> to initialize a matrix. | |
* - scale Scale the matrix by the specified scaling factor. | |
* | |
* @typedef {{ | |
* scale: Number | |
* }} | |
*/ | |
var Matrix3DCreationDict = {}; | |
/** | |
* Simple object passed to <Titanium.UI.create2DMatrix> to initialize a matrix. | |
* - scale Scale the matrix by the specified scaling factor. The same scaling factor is used | |
* for both horizontal and vertical scaling. | |
* | |
* - rotate Rotation angle, in degrees. See the [rotate](Titanium.UI.2DMatrix.rotate) method | |
* for a discussion of rotation. | |
* | |
* - anchorPoint Point to rotate around, specified as a dictionary object with `x` and `y` | |
* properties, where { x: 0.5, y: 0.5 } represents the center of whatever is being | |
* rotated. | |
* | |
* @typedef {{ | |
* scale: Number, | |
* rotate: Number, | |
* anchorPoint: Dictionary | |
* }} | |
*/ | |
var MatrixCreationDict = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var MediaAuthorizationResponse = {}; | |
/** | |
* A full query descriptor for a filtering predicate. | |
* - value The value for the given predicate. See the descriptions in <MediaQueryType> for information about which properties require which values. | |
* - exact Whether or not the predicate is for an exact match. The default is `true`. | |
* @typedef {{ | |
* value: (Number|String|Boolean), | |
* exact: Boolean | |
* }} | |
*/ | |
var MediaQueryInfoType = {}; | |
/** | |
* A specifier for a media library query. By default, filters perform an exact match. | |
* - grouping A constant that specifies the ordering of the result array. | |
* - mediaType The media type to filter on. | |
* - title The title to filter on. Value should be a String. | |
* - albumTitle The album title to filter on. Value should be a String. | |
* - artist The artist to filter on. Value should be a String. | |
* - albumArtist The album artist to filter on. Value should be a String. | |
* - genre The genre to filter on. Value should be a String. | |
* - composer The composer to filter on. Value should be a String. | |
* - isCompilation Filter by whether or not the item is a compilation. | |
* The value should be a Boolean. | |
* | |
* - playCount The play count to filter on. Value should be a Number. | |
* - persistentID The persistent ID to filter on. Value should be a Number. | |
* - albumPersistentID The album persistent ID to filter on. Value should be a Number. | |
* - albumArtistPersistentID The album artist persistent ID to filter on. Value should be a Number. | |
* - genrePersistentID The genre persistent ID to filter on. Value should be a Number. | |
* - composerPersistentID The composer persistent ID to filter on. Value should be a Number. | |
* - isCloudItem Filter by whether or not the item is a cloud item. | |
* Value should be a Boolean. | |
* | |
* - hasProtectedAsset Filter by whether or not the item is a protected asset. | |
* Value should be a Boolean. | |
* | |
* - podcastTitle The podcast title to filter on. Value should be a String. | |
* - podcastPersistentID The podcast persistent ID to filter on. Value should be a Number. | |
* @typedef {{ | |
* grouping: Number, | |
* mediaType: (MediaQueryInfoType|Number), | |
* title: (MediaQueryInfoType|String), | |
* albumTitle: (MediaQueryInfoType|String), | |
* artist: (MediaQueryInfoType|String), | |
* albumArtist: (MediaQueryInfoType|String), | |
* genre: (MediaQueryInfoType|String), | |
* composer: (MediaQueryInfoType|String), | |
* isCompilation: (MediaQueryInfoType|Boolean), | |
* playCount: (MediaQueryInfoType|Number), | |
* persistentID: (MediaQueryInfoType|Number), | |
* albumPersistentID: (MediaQueryInfoType|Number), | |
* albumArtistPersistentID: (MediaQueryInfoType|Number), | |
* genrePersistentID: (MediaQueryInfoType|Number), | |
* composerPersistentID: (MediaQueryInfoType|Number), | |
* isCloudItem: (MediaQueryInfoType|Boolean), | |
* hasProtectedAsset: (MediaQueryInfoType|Boolean), | |
* podcastTitle: (MediaQueryInfoType|String), | |
* podcastPersistentID: (MediaQueryInfoType|Number) | |
* }} | |
*/ | |
var MediaQueryType = {}; | |
/** | |
* Simple object passed to the [scanMediaFiles](Titanium.Media.Android.scanMediaFiles) callback. | |
* - path Path to the media file that was scanned. | |
* - uri URI to the file if it was scanned and added to the media library, or `null` | |
* if the file was not added. | |
* | |
* @typedef {{ | |
* path: String, | |
* uri: String | |
* }} | |
*/ | |
var MediaScannerResponse = {}; | |
/** | |
* Dictionary of options for hiding a menu popup with <Titanium.UI.iOS.MenuPopup.hide>. | |
* - animated Determines whether the menu popup should be opened or closed animated. | |
* @typedef {{ | |
* animated: Boolean | |
* }} | |
*/ | |
var MenuPopupHideParams = {}; | |
/** | |
* Dictionary of options for showing a menu popup with <Titanium.UI.iOS.MenuPopup.show>. | |
* - view The view where the menu pop is shown at. | |
* - animated Determines whether the menu popup should be opened or closed animated. | |
* - arrowDirection Indicates the arrow direction of the menu popup. | |
* @typedef {{ | |
* view: Titanium.UI.View, | |
* animated: Boolean, | |
* arrowDirection: Number | |
* }} | |
*/ | |
var MenuPopupShowParams = {}; | |
/** | |
* Reply message received from watch app. | |
* - message Reply message from watchapp. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* message: Dictionary, | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var MessageReply = {}; | |
/** | |
* Optional Titanium modules. | |
* @typedef {{ | |
* }} | |
*/ | |
var Modules = {}; | |
/** | |
* The top level Cloud module for making calls to ArrowDB and Arrow Push. | |
* @extends {Titanium.Module} | |
* @description Appcelerator DB and Arrow Push provides a wide array of automatically-scaled data storage | |
* and web services, such as user logins, photo uploads, checkins, status updates, and push | |
* notifications, without the need to learn multiple third-party SDKs or do any | |
* server-side programming. Remote calls to ArrowDB are done using REST APIs, which may be used with any | |
* client technology that supports HTTP. | |
* | |
* The Cloud module's specialized objects, such as `Users`, make accessing | |
* ArrowDB as simple as using any of Titanium's other APIs, due to their familiar and intuitive API schemas. | |
* You can also use the <Modules.Cloud.sendRequest> method to invoke | |
* ArrowDB REST APIs directly. This approach requires some additional configuration for each method call, | |
* but it lets you use new ArrowDB APIs as soon as they are available. | |
* | |
* For a more detailed overview of ArrowDB and how to configure an application to use it, refer to the | |
* [Integrate with Mobile Backend Services](https://docs.appcelerator.com/platform/latest/#!/guide/Integrate_with_Mobile_Backend_Services). | |
* | |
* #### Using the Modules.Cloud Module | |
* | |
* The Modules.Cloud module is bundled with the Titanium SDK as an optional CommonJS module. | |
* To use it, import the module with `require('ti.cloud')`, and then begin calling the methods | |
* on its various objects. For example, the following code uses the `Modules.Cloud.Users.login` | |
* method to login the user with the specified login and password: | |
* | |
* var Cloud = require('ti.cloud'); | |
* | |
* Cloud.Users.login({ | |
* login: '[email protected]', | |
* password: 'test_password' | |
* }, function (e) { | |
* if (e.success) { | |
* var user = e.users[0]; | |
* alert('Success:\n' + | |
* 'id: ' + user.id + '\n' + | |
* 'sessionId: ' + Cloud.sessionId + '\n' + | |
* 'first name: ' + user.first_name + '\n' + | |
* 'last name: ' + user.last_name); | |
* } else { | |
* alert('Error:\n' + | |
* ((e.error && e.message) || JSON.stringify(e))); | |
* } | |
* }); | |
* | |
* #### Invoking ArrowDB REST APIs Directly with sendRequest() | |
* | |
* The `Modules.Cloud.sendRequest` method lets you directly invoke ArrowDB REST APIs. The following example, | |
* equivalent to the previous one, invokes the [users/login.json](https://docs.appcelerator.com/arrowdb/latest/#!/api/Users-method-login) | |
* method directly to login a user. | |
* | |
* Cloud.sendRequest({ | |
* url : "users/login.json", | |
* method : "POST", | |
* data : { | |
* login : '[email protected]', | |
* password : 'test_password' | |
* } | |
* }, function(e) {// The callback called when the request completes | |
* if (e.success) { | |
* var user = e.users[0]; | |
* alert('Success:\n' + | |
* 'id: ' + user.id + '\n' + | |
* 'sessionId: ' + Cloud.sessionId + '\n' + | |
* 'first name: ' + user.first_name + '\n' + | |
* 'last name: ' + user.last_name); | |
* } else { | |
* alert('Error:\n' + ((e.error && e.message) || JSON.stringify(e))); | |
* } | |
* }); | |
* | |
* | |
* #### tiapp.xml Properties | |
* | |
* Studio will create a pair of API keys (Development and Production) for each Titanium | |
* application depending on the user preference specified when creating the proejct. These keys | |
* will be stored in the `tiapp.xml` file. One of the keys will be used during application | |
* builds depending on the build type (development or production). | |
* | |
* The supported properties in the `tiapp.xml` file are: | |
* | |
* <property name="acs-api-key-development" type="string">YOUR DEVELOPMENT API KEY HERE</property> | |
* <property name="acs-api-key-production" type="string">YOUR PRODUCTION API KEY HERE</property> | |
* <property name="acs-api-key" type="string">YOUR API KEY HERE</property> | |
* | |
* If a deployment-specific setting is provided (production or development) then that value will | |
* be used for the current deployment environment. | |
* | |
* There is also an optional setting to allow you to change the base URL for ArrowDB requests. You | |
* will most likely never need to specify this. It can be specified deployment-specific, or | |
* generic: | |
* | |
* <property name="acs-base-url-development" type="string">DEVELOPMENT API URL HERE</property> | |
* <property name="acs-base-url-production" type="string">PRODUCTION API URL HERE</property> | |
* <property name="acs-base-url" type="string">API URL HERE</property> | |
* | |
* By default, Ti.Cloud always uses SSL for communicating with the ArrowDB servers. This behavior can be overridden | |
* by setting the URLs with their non-SSL counterpart. | |
* | |
* <property name="acs-base-url" type="string">https://api.cloud.appcelerator.com</property> | |
* | |
* To disable SSL, add this line to the application code: | |
* | |
* Cloud.useSecure = false; | |
* | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
*/ | |
Modules.Cloud = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.prototype.lifecycleContainer; | |
/** | |
* Indicates whether internal debug logging should be output to the console. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @type {Boolean} debug | |
*/ | |
Modules.Cloud.prototype.debug; | |
/** | |
* Function to be called at regular intervals as the request data is being received. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @type {Callback<CloudStreamProgress>} ondatastream | |
*/ | |
Modules.Cloud.prototype.ondatastream; | |
/** | |
* Function to be called at regular intervals as the request data is being transmitted. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @type {Callback<CloudStreamProgress>} onsendstream | |
*/ | |
Modules.Cloud.prototype.onsendstream; | |
/** | |
* Indicates whether to use SSL when sending requests to ArrowDB. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @type {Boolean} useSecure | |
*/ | |
Modules.Cloud.prototype.useSecure; | |
/** | |
* Identifies the current session | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @type {String} sessionId | |
*/ | |
Modules.Cloud.prototype.sessionId; | |
/** | |
* Identifies the current access token when using 3-Legged OAuth | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @type {String} accessToken | |
*/ | |
Modules.Cloud.prototype.accessToken; | |
/** | |
* Indicates the number of seconds before the access token expires | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @readonly | |
* @type {Number} expiresIn | |
*/ | |
Modules.Cloud.prototype.expiresIn; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.applyProperties = function(props) {}; | |
/** | |
* Checks if there is a stored user session. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.hasStoredSession = function() {}; | |
/** | |
* Returns the stored user session identifier. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.retrieveStoredSession = function() {}; | |
/** | |
* Makes a REST API call to the ArrowDB server. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {Dictionary} parameters A Dictionary containing the parameters to send with the request. It must contain the following | |
* key-value pairs: | |
* | |
* * **url** -- A string specifying the last fragment of the request URL. | |
* * **method** -- A string specifying the HTTP method to use: "GET", "POST", "PUT", or "DELETE". | |
* * **data** -- A Dictionary containing name-value pairs to send in the request. | |
* | |
* @param {Callback<CloudResponse>} callback Callback function to execute when a response is received. | |
* @return {void} | |
*/ | |
Modules.Cloud.sendRequest = function(parameters, callback) {}; | |
/** | |
* creates a security manager to authenticate specified HTTPS URLs. | |
* @since 4.1.0 (Android), 4.1.0 (iPhone), 4.1.0 (iPad) | |
* @param {Array<Dictionary>} params Server URLs with the corresponding certificate to authenticate, specified as an | |
* array of dictionaries that must contain the following keys: | |
* | |
* * `url`: HTTPS URL pinned to the public key in the server certificate | |
* * `serverCertificate`: X.509 certificate file in DER binary format | |
* | |
* @return {SecurityManagerProtocol} | |
*/ | |
Modules.Cloud.createX509CertificatePinningSecurityManager = function(params) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.debug> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.getDebug = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.debug> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {Boolean} debug New value for the property. | |
*/ | |
Modules.Cloud.setDebug = function(debug) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.ondatastream> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @return {Callback<CloudStreamProgress>} | |
*/ | |
Modules.Cloud.getOndatastream = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.ondatastream> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {Callback<CloudStreamProgress>} ondatastream New value for the property. | |
*/ | |
Modules.Cloud.setOndatastream = function(ondatastream) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.onsendstream> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @return {Callback<CloudStreamProgress>} | |
*/ | |
Modules.Cloud.getOnsendstream = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.onsendstream> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {Callback<CloudStreamProgress>} onsendstream New value for the property. | |
*/ | |
Modules.Cloud.setOnsendstream = function(onsendstream) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.useSecure> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.getUseSecure = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.useSecure> property. | |
* @since 2.0 (Android), 2.0 (iPhone), 2.0 (iPad) | |
* @param {Boolean} useSecure New value for the property. | |
*/ | |
Modules.Cloud.setUseSecure = function(useSecure) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.sessionId> property. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.getSessionId = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.sessionId> property. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @param {String} sessionId New value for the property. | |
*/ | |
Modules.Cloud.setSessionId = function(sessionId) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.accessToken> property. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.getAccessToken = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.accessToken> property. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @param {String} accessToken New value for the property. | |
*/ | |
Modules.Cloud.setAccessToken = function(accessToken) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.expiresIn> property. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @return {Number} | |
*/ | |
Modules.Cloud.getExpiresIn = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* debug: Boolean, | |
* ondatastream: Callback<CloudStreamProgress>, | |
* onsendstream: Callback<CloudStreamProgress>, | |
* useSecure: Boolean, | |
* sessionId: String, | |
* accessToken: String | |
* }} | |
*/ | |
Modules._Dictionary_Cloud; | |
/** | |
* Provides methods for accessing ArrowDB access control lists (ACLs). | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.ACLs = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.ACLs.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.ACLs.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.ACLs.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.ACLs.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.ACLs.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.ACLs.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.ACLs.applyProperties = function(props) {}; | |
/** | |
* Creates an ACL object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudACLsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.ACLs.create = function(parameters, callback) {}; | |
/** | |
* Updates an ACL object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudACLsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.ACLs.update = function(parameters, callback) {}; | |
/** | |
* Shows an ACL object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudACLsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.ACLs.show = function(parameters, callback) {}; | |
/** | |
* Deletes an ACL object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudACLsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.ACLs.remove = function(parameters, callback) {}; | |
/** | |
* Adds one or more users to an ACL object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudACLsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.ACLs.addUser = function(parameters, callback) {}; | |
/** | |
* Removes one or more users from an ACL object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudACLsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.ACLs.removeUser = function(parameters, callback) {}; | |
/** | |
* Checks a user's permission in an ACL object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudACLsCheckResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.ACLs.checkUser = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.ACLs.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.ACLs.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.ACLs.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.ACLs.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.ACLs.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.ACLs.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.ACLs.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.ACLs.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.ACLs.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.ACLs.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_ACLs; | |
/** | |
* Provides methods for accessing ArrowDB chat messages. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Chats = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Chats.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Chats.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Chats.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Chats.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Chats.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Chats.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Chats.applyProperties = function(props) {}; | |
/** | |
* Send a chat message to another user or a group of users. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudChatsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Chats.create = function(parameters, callback) {}; | |
/** | |
* Deletes a chat message. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Chats.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of chat groups the current user belongs to. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudChatGroupsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Chats.getChatGroups = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of chat groups with sorting and pagination. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudChatGroupsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Chats.queryChatGroups = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of chat messages with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudChatsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Chats.query = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Chats.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Chats.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Chats.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Chats.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Chats.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Chats.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Chats.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Chats.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Chats.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Chats.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Chats; | |
/** | |
* Provides methods for accessing ArrowDB checkins. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Checkins = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Checkins.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Checkins.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Checkins.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Checkins.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Checkins.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Checkins.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Checkins.applyProperties = function(props) {}; | |
/** | |
* Check in to a place or event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudCheckinsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Checkins.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of checkins with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudCheckinsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Checkins.query = function(parameters, callback) {}; | |
/** | |
* Delete a checkin. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudCheckinsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Checkins.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve a checkin. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudCheckinsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Checkins.show = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Checkins.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Checkins.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Checkins.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Checkins.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Checkins.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Checkins.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Checkins.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Checkins.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Checkins.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Checkins.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Checkins; | |
/** | |
* Provides methods for accessing ArrowDB clients. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Clients = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Clients.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Clients.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Clients.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Clients.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Clients.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Clients.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Clients.applyProperties = function(props) {}; | |
/** | |
* Locate a mobile device based on the IP address of the device. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudClientsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Clients.geolocate = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Clients.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Clients.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Clients.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Clients.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Clients.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Clients.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Clients.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Clients.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Clients.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Clients.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Clients; | |
/** | |
* Provides methods for accessing ArrowDB Email service. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Emails = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Emails.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Emails.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Emails.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Emails.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Emails.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Emails.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Emails.applyProperties = function(props) {}; | |
/** | |
* Send an email to a list of email adresses. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudEmailsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Emails.send = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Emails.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Emails.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Emails.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Emails.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Emails.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Emails.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Emails.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Emails.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Emails.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Emails.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Emails; | |
/** | |
* Provides methods for accessing ArrowDB events. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Events = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Events.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Events.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Events.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Events.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Events.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Events.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Events.applyProperties = function(props) {}; | |
/** | |
* Create a new event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of events. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.show = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of event occurrences for a given event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventOccurrencesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.showOccurrences = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of events with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.query = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of event occurrences with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventOccurrencesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.queryOccurrences = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of events with full text search. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.search = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of event occurrences with full text search. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventOccurrencesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.searchOccurrences = function(parameters, callback) {}; | |
/** | |
* Delete a event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.remove = function(parameters, callback) {}; | |
/** | |
* Update information about a event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudEventsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Events.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Events.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Events.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Events.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Events.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Events.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Events.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Events.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Events.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Events.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Events.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Events; | |
/** | |
* Provides methods for accessing ArrowDB files. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Files = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Files.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Files.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Files.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Files.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Files.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Files.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Files.applyProperties = function(props) {}; | |
/** | |
* Create a file. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFilesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Files.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of files with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudFilesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Files.query = function(parameters, callback) {}; | |
/** | |
* Delete a file. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFilesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Files.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve information about a file. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFilesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Files.show = function(parameters, callback) {}; | |
/** | |
* Update the information for a file. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFilesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Files.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Files.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Files.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Files.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Files.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Files.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Files.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Files.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Files.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Files.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Files.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Files; | |
/** | |
* Provides methods for accessing ArrowDB friends. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Friends = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Friends.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Friends.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Friends.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Friends.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Friends.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Friends.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Friends.applyProperties = function(props) {}; | |
/** | |
* Add friends to the current user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFriendsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Friends.add = function(parameters, callback) {}; | |
/** | |
* View pending friend requests. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFriendRequestsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Friends.requests = function(parameters, callback) {}; | |
/** | |
* Approve existing friend requests. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFriendsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Friends.approve = function(parameters, callback) {}; | |
/** | |
* Removes one or more friends from the current user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFriendsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Friends.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of friends. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudFriendsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Friends.search = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Friends.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Friends.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Friends.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Friends.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Friends.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Friends.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Friends.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Friends.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Friends.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Friends.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Friends; | |
/** | |
* Provides methods for accessing ArrowDB geo-fence objects. | |
* @extends {Titanium.Module} | |
* @description This feature is only available for **enterprise users**, and the current user must be an **application | |
* admin** to create, update or remove geo-fence objects. | |
* | |
* The ArrowDB GeoFences API lets you manage geographic regions with an associated JSON data payload. | |
* Use this API to have the device query the ArrowDB server to retrieve data based on a location. | |
* | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
*/ | |
Modules.Cloud.GeoFences = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.GeoFences.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.GeoFences.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.GeoFences.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.GeoFences.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.GeoFences.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.GeoFences.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.GeoFences.applyProperties = function(props) {}; | |
/** | |
* Create a new geofence object. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudGeoFenceResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.GeoFences.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of places with sorting and pagination. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudGeoFenceResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.GeoFences.query = function(parameters, callback) {}; | |
/** | |
* Delete a place. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudGeoFenceResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.GeoFences.remove = function(parameters, callback) {}; | |
/** | |
* Update information about a place. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudGeoFenceResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.GeoFences.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.GeoFences.bubbleParent> property. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.GeoFences.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.GeoFences.bubbleParent> property. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.GeoFences.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.GeoFences.apiName> property. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.GeoFences.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.GeoFences.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.GeoFences.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.GeoFences.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.GeoFences.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_GeoFences; | |
/** | |
* Provides methods for accessing ArrowDB Key-Values storage. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.KeyValues = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.KeyValues.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.KeyValues.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.KeyValues.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.KeyValues.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.KeyValues.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.KeyValues.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.KeyValues.applyProperties = function(props) {}; | |
/** | |
* Add the given value to the end of an existing value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudKeyValuesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.KeyValues.append = function(parameters, callback) {}; | |
/** | |
* Retrieve a string or binary value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudKeyValuesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.KeyValues.get = function(parameters, callback) {}; | |
/** | |
* Increment the value by the given value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudKeyValuesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.KeyValues.increment = function(parameters, callback) {}; | |
/** | |
* Delete a value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudKeyValuesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.KeyValues.remove = function(parameters, callback) {}; | |
/** | |
* Sets a string or binary value referenced by the key name. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudKeyValuesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.KeyValues.set = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.KeyValues.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.KeyValues.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.KeyValues.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.KeyValues.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.KeyValues.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.KeyValues.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.KeyValues.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.KeyValues.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.KeyValues.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.KeyValues.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_KeyValues; | |
/** | |
* Provides methods for accessing ArrowDB likes. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Likes = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Likes.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Likes.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Likes.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Likes.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Likes.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Likes.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Likes.applyProperties = function(props) {}; | |
/** | |
* Create a like. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudLikesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Likes.create = function(parameters, callback) {}; | |
/** | |
* Delete a like. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudLikesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Likes.remove = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Likes.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Likes.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Likes.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Likes.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Likes.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Likes.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Likes.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Likes.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Likes.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Likes.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Likes; | |
/** | |
* Provides methods for accessing ArrowDB messages. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Messages = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Messages.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Messages.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Messages.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Messages.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Messages.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Messages.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Messages.applyProperties = function(props) {}; | |
/** | |
* Create a message. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.create = function(parameters, callback) {}; | |
/** | |
* Reply to all recipients of a message. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.reply = function(parameters, callback) {}; | |
/** | |
* Retrieve information about a message. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.show = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of messages in the current user's inbox. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.showInbox = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of messages in the current user's inbox. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.showSent = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of message threads in the current users' inbox. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.showThreads = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of messages in a thread from the current user's inbox. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.showThread = function(parameters, callback) {}; | |
/** | |
* Delete a message. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.remove = function(parameters, callback) {}; | |
/** | |
* Delete all messages in a thread. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudMessagesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Messages.removeThread = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Messages.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Messages.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Messages.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Messages.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Messages.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Messages.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Messages.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Messages.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Messages.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Messages.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Messages; | |
/** | |
* Provides methods for accessing ArrowDB custom objects. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Objects = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Objects.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Objects.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Objects.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Objects.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Objects.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Objects.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Objects.applyProperties = function(props) {}; | |
/** | |
* Create a custom object of type `classname`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. A `classname` property is required. | |
* @param {Callback<CloudObjectsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Objects.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of custom objects of type `classname`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. A `classname` property is required. | |
* @param {Callback<CloudObjectsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Objects.query = function(parameters, callback) {}; | |
/** | |
* Delete a custom object of type `classname`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. A `classname` property is required. | |
* @param {Callback<CloudObjectsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Objects.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of custom objects of type `classname`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. A `classname` property is required. | |
* @param {Callback<CloudObjectsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Objects.show = function(parameters, callback) {}; | |
/** | |
* Update the fields of a custom object of type `classname`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. A `classname` property is required. | |
* @param {Callback<CloudObjectsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Objects.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Objects.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Objects.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Objects.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Objects.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Objects.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Objects.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Objects.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Objects.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Objects.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Objects.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Objects; | |
/** | |
* Provides methods for ArrowDB photo collections. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.PhotoCollections = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.PhotoCollections.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.PhotoCollections.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.PhotoCollections.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.PhotoCollections.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.PhotoCollections.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.PhotoCollections.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.PhotoCollections.applyProperties = function(props) {}; | |
/** | |
* Creates a photo collection. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotoCollectionsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PhotoCollections.create = function(parameters, callback) {}; | |
/** | |
* Deletes an empty collection. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotoCollectionsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PhotoCollections.remove = function(parameters, callback) {}; | |
/** | |
* Retrieves a list of top-level collections owned by a user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotoCollectionsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PhotoCollections.search = function(parameters, callback) {}; | |
/** | |
* Retrieves details about a photo collection. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotoCollectionsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PhotoCollections.show = function(parameters, callback) {}; | |
/** | |
* Retrieves photos in a collection. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotoCollectionsPhotosResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PhotoCollections.showPhotos = function(parameters, callback) {}; | |
/** | |
* Retrieves a list of subcollections of a collection. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotoCollectionsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PhotoCollections.showSubCollections = function(parameters, callback) {}; | |
/** | |
* Updates a photo collection. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotoCollectionsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PhotoCollections.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PhotoCollections.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.PhotoCollections.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.PhotoCollections.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.PhotoCollections.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PhotoCollections.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.PhotoCollections.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PhotoCollections.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.PhotoCollections.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.PhotoCollections.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.PhotoCollections.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_PhotoCollections; | |
/** | |
* Provides methods for accessing ArrowDB photos. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Photos = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Photos.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Photos.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Photos.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Photos.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Photos.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Photos.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Photos.applyProperties = function(props) {}; | |
/** | |
* Create or upload a new photo. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotosResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Photos.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of photos with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotosResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Photos.query = function(parameters, callback) {}; | |
/** | |
* Delete a photo. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotosResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Photos.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of photos. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotosResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Photos.search = function(parameters, callback) {}; | |
/** | |
* Retrieve information about a photo. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotosResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Photos.show = function(parameters, callback) {}; | |
/** | |
* Update a photo. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPhotosResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Photos.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Photos.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Photos.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Photos.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Photos.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Photos.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Photos.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Photos.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Photos.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Photos.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Photos.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Photos; | |
/** | |
* Provides methods for accessing ArrowDB places. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Places = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Places.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Places.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Places.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Places.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Places.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Places.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Places.applyProperties = function(props) {}; | |
/** | |
* Create a new place. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPlacesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Places.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of places with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudPlacesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Places.query = function(parameters, callback) {}; | |
/** | |
* Delete a place. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPlacesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Places.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of places. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudPlacesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Places.search = function(parameters, callback) {}; | |
/** | |
* Retrieve information about a place. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPlacesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Places.show = function(parameters, callback) {}; | |
/** | |
* Update information about a place. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPlacesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Places.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Places.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Places.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Places.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Places.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Places.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Places.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Places.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Places.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Places.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Places.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Places; | |
/** | |
* Provides methods for accessing ArrowDB posts. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Posts = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Posts.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Posts.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Posts.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Posts.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Posts.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Posts.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Posts.applyProperties = function(props) {}; | |
/** | |
* Create a post. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPostsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Posts.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of posts with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudPostsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Posts.query = function(parameters, callback) {}; | |
/** | |
* Delete a post. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPostsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Posts.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve information about a post. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPostsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Posts.show = function(parameters, callback) {}; | |
/** | |
* Update the information for a post. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPostsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Posts.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Posts.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Posts.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Posts.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Posts.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Posts.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Posts.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Posts.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Posts.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Posts.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Posts.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Posts; | |
/** | |
* Provides methods for accessing Arrow push notification channels. | |
* @extends {Titanium.Module} | |
* @description For information on configuring and setting up push notifications, | |
* see the [Push Notifications guide](https://docs.appcelerator.com/platform/latest/#!/guide/Push_Notifications). | |
* | |
* The methods in this module are used to subscribe and unsubscribe from Arrow push notification | |
* channels, and to generate Arrow push notifications. Push notifications are received using | |
* platform-specific mechanisms: | |
* | |
* * On iOS, push notifications are received through the standard iOS push notification | |
* mechanism. When you register for push notifications, incoming push notifications | |
* are passed to the `callback` callback. See | |
* [Network.registerForPushNotifications](Titanium.Network.registerForPushNotifications) | |
* for details. | |
* * On Android, push notifications are received through the <Modules.CloudPush> module. | |
* Add a listener for the [callback](Modules.CloudPush.callback) event to receive push notifications. | |
* | |
* To register for push notifications, you need to obtain an application-specific _device | |
* token_. To obtain a device token: | |
* | |
* * On iOS, when you successfully register for push notifications, the device token is | |
* passed to the `success` callback. | |
* * On Android, use | |
* [CloudPush.retrieveDeviceToken](Modules.CloudPush.retrieveDeviceToken) to request | |
* a device token. The device token is passed to the `success` callback. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.PushNotifications = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.PushNotifications.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.PushNotifications.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.PushNotifications.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.PushNotifications.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.PushNotifications.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.PushNotifications.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.PushNotifications.applyProperties = function(props) {}; | |
/** | |
* Send a push notification to a channel. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.notify = function(parameters, callback) {}; | |
/** | |
* Send a push notification to a channel to the specified devices. | |
* @since 3.1.2 (Android), 3.1.2 (iPhone), 3.1.2 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.notifyTokens = function(parameters, callback) {}; | |
/** | |
* Resets the badge value to zero but does not update it on the device. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.resetBadge = function(parameters, callback) {}; | |
/** | |
* Sets the badge value but does not update it on the device. | |
* @since 3.2.1 (Android), 3.2.1 (iPhone), 3.2.1 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.setBadge = function(parameters, callback) {}; | |
/** | |
* Subscribe a mobile device to a push notification channel. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.subscribe = function(parameters, callback) {}; | |
/** | |
* Subscribe a mobile device to a push notification channel using a device token. | |
* @since 3.1.2 (Android), 3.1.2 (iPhone), 3.1.2 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.subscribeToken = function(parameters, callback) {}; | |
/** | |
* Unsubscribe a mobile device from a push notification channel. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.unsubscribe = function(parameters, callback) {}; | |
/** | |
* Unsubscribe a mobile device from a push notification channel using a device token. | |
* @since 3.1.2 (Android), 3.1.2 (iPhone), 3.1.2 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.unsubscribeToken = function(parameters, callback) {}; | |
/** | |
* Updates a user's notification subscription with the device's location. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.updateSubscription = function(parameters, callback) {}; | |
/** | |
* Returns a list of push notification channels the user is subscribed to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsQueryChannelResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.queryChannels = function(parameters, callback) {}; | |
/** | |
* Returns the number of devices subscribed to the specified channel. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsShowChannelResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.showChannels = function(parameters, callback) {}; | |
/** | |
* Custom query of push notification subscriptions with paginating. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushNotificationsQueryResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushNotifications.query = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PushNotifications.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.PushNotifications.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.PushNotifications.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.PushNotifications.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PushNotifications.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.PushNotifications.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PushNotifications.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.PushNotifications.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.PushNotifications.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.PushNotifications.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_PushNotifications; | |
/** | |
* Provides methods for scheduling Arrow push notifications | |
* @extends {Titanium.Module} | |
* @description The following APIs are only available for Appcelerator Platform customers. You must be an | |
* application admin to use these APIs. | |
* | |
* The PushSchedules API lets you schedule push notifications to be delivered to your application users | |
* on a recurring or one-time basis. | |
* | |
* You may create up to 100 scheduled push notifications for your application. | |
* Datetime fields use the ISO 8601 format, for example, `YYYY-MM-DDTHH:mm:ss+ZZZZ`. | |
* | |
* For information on configuring and setting up push notifications, | |
* see the [Push Notifications guide](https://docs.appcelerator.com/platform/latest/#!/guide/Push_Notifications). | |
* | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
*/ | |
Modules.Cloud.PushSchedules = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.PushSchedules.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.PushSchedules.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.PushSchedules.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.PushSchedules.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.PushSchedules.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.PushSchedules.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.PushSchedules.applyProperties = function(props) {}; | |
/** | |
* Schedules a push notification. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushSchedulesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushSchedules.create = function(parameters, callback) {}; | |
/** | |
* Deletes a scheduled push notification. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushSchedulesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushSchedules.remove = function(parameters, callback) {}; | |
/** | |
* Queries the list of scheduled push notifications. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudPushSchedulesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.PushSchedules.query = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PushSchedules.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.PushSchedules.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.PushSchedules.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.PushSchedules.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PushSchedules.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.PushSchedules.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.PushSchedules.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.PushSchedules.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.PushSchedules.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.PushSchedules.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_PushSchedules; | |
/** | |
* Provides methods for accessing ArrowDB reviews. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Reviews = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Reviews.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Reviews.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Reviews.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Reviews.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Reviews.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Reviews.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Reviews.applyProperties = function(props) {}; | |
/** | |
* Add a review, comment, rating, or like. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudReviewsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Reviews.create = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of reviews with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudReviewsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Reviews.query = function(parameters, callback) {}; | |
/** | |
* Delete a review. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudReviewsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Reviews.remove = function(parameters, callback) {}; | |
/** | |
* Retrieve details of a review. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudReviewsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Reviews.show = function(parameters, callback) {}; | |
/** | |
* Update a review. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudReviewsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Reviews.update = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Reviews.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Reviews.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Reviews.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Reviews.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Reviews.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Reviews.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Reviews.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Reviews.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Reviews.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Reviews.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Reviews; | |
/** | |
* Provides methods for access ArrowDB social integrations. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.SocialIntegrations = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.SocialIntegrations.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.SocialIntegrations.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.SocialIntegrations.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.SocialIntegrations.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.SocialIntegrations.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.SocialIntegrations.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.SocialIntegrations.applyProperties = function(props) {}; | |
/** | |
* Associate an external account with an existing ArrowDB user account. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudSocialIntegrationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.SocialIntegrations.externalAccountLink = function(parameters, callback) {}; | |
/** | |
* Login to ArrowDB using an external account such as Facebook, Twitter, LinkedIn, etc. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudSocialIntegrationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.SocialIntegrations.externalAccountLogin = function(parameters, callback) {}; | |
/** | |
* Disassociate an external account from a ArrowDB user account. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudSocialIntegrationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.SocialIntegrations.externalAccountUnlink = function(parameters, callback) {}; | |
/** | |
* Returns a list of the current user's Facebook friends who are also using this application. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Callback<CloudSocialIntegrationsResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.SocialIntegrations.searchFacebookFriends = function(callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.SocialIntegrations.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.SocialIntegrations.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.SocialIntegrations.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.SocialIntegrations.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.SocialIntegrations.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.SocialIntegrations.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.SocialIntegrations.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.SocialIntegrations.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.SocialIntegrations.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.SocialIntegrations.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_SocialIntegrations; | |
/** | |
* Provides methods for accessing ArrowDB Statuses. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Statuses = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Statuses.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Statuses.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Statuses.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Statuses.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Statuses.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Statuses.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Statuses.applyProperties = function(props) {}; | |
/** | |
* Creates a status for the currently logged in user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudStatusesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Statuses.create = function(parameters, callback) {}; | |
/** | |
* Updates a status. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudStatusesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Statuses.update = function(parameters, callback) {}; | |
/** | |
* Shows a status. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudStatusesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Statuses.show = function(parameters, callback) {}; | |
/** | |
* Deletes a status. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Statuses.delete = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of statuses with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudStatusesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Statuses.query = function(parameters, callback) {}; | |
/** | |
* Retrieve the statuses for a user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudStatusesResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Statuses.search = function(parameters, callback) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Statuses.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Statuses.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Statuses.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Statuses.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Statuses.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Statuses.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Statuses.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Statuses.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Statuses.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Statuses.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Statuses; | |
/** | |
* Provides methods for accessing ArrowDB user objects. | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Modules.Cloud.Users = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.Cloud.Users.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.Cloud.Users.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.Cloud.Users.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.Cloud.Users.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.Cloud.Users.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.Cloud.Users.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.Cloud.Users.applyProperties = function(props) {}; | |
/** | |
* Create a new user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.create = function(parameters, callback) {}; | |
/** | |
* Log in a user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.login = function(parameters, callback) {}; | |
/** | |
* Log out the current user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.logout = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of users with sorting and pagination. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.query = function(parameters, callback) {}; | |
/** | |
* Retrieve a list of users based on the specified search criteria. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary=} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.search = function(parameters, callback) {}; | |
/** | |
* Show public user information. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.show = function(parameters, callback) {}; | |
/** | |
* Show both public and private information about the user currently logged in. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.showMe = function(callback) {}; | |
/** | |
* Update the current user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.update = function(parameters, callback) {}; | |
/** | |
* Delete the current user. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.remove = function(parameters, callback) {}; | |
/** | |
* Send an email to user to recover lost password. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.requestResetPassword = function(parameters, callback) {}; | |
/** | |
* Re-send a user verification email. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} parameters Parameters to send in the request. | |
* @param {Callback<CloudUsersResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.resendConfirmation = function(parameters, callback) {}; | |
/** | |
* Create a new user using 3-Legged OAuth. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @param {Dictionary<CloudUsersSecureDialog>=} parameters A dictionary of properties for the request. | |
* @param {Callback<CloudUsersSecureResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.secureCreate = function(parameters, callback) {}; | |
/** | |
* Log in a user using 3-Legged OAuth. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @param {Dictionary<CloudUsersSecureDialog>=} parameters A dictionary of properties for the request. | |
* @param {Callback<CloudUsersSecureResponse>} callback Callback function to execute when the method completes. | |
*/ | |
Modules.Cloud.Users.secureLogin = function(parameters, callback) {}; | |
/** | |
* Checks if the user is authenticated with 3-Legged OAuth. | |
* @since 2.1.2 (Android), 2.1.2 (iPhone), 2.1.2 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Users.secureStatus = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Users.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Modules.Cloud.Users.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Users.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.Cloud.Users.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Users.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Modules.Cloud.Users.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.Cloud.Users.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.Cloud.Users.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.Cloud.Users.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.Cloud.Users.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Modules.Cloud._Dictionary_Users; | |
/** | |
* Provides support for Android push notifications. | |
* | |
* @extends {Titanium.Module} | |
* @description The CloudPush module supports Android push notifications for a device by providing a connection | |
* to the push notification server to the device to receive push notifications and to optionally | |
* present a tray notification to the user when a new push notification is received. | |
* | |
* This module is only used to receive push notifications. For information on configuring your | |
* project to send push notifications, see <Modules.Cloud.PushNotifications>. | |
* | |
* #### Push Protocols | |
* | |
* The CloudPush module only supports [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) (FCM) for push | |
* notifications. | |
* | |
* #### Getting Started | |
* | |
* To use the CloudPush module in your JavaScript code, you need to require it in and | |
* get a device token with the `retrieveDeviceToken` method to enable push notifications with Arrow Push. | |
* In your project's `tiapp.xml`, you need to add some keys to configure push notifications. | |
* | |
* Note that this module is not included in the Titanium namespace, but it is bundled with the Titanium SDK as of | |
* version 2.0.0. To use it, you must require it, like this: | |
* | |
* var CloudPush = require('ti.cloudpush'); | |
* | |
* Then, call the `retrieveDeviceToken` method to get a unique token specific to that device and | |
* Arrow DB application. This token is used with [Arrow PushNotifications calls](Modules.Cloud.PushNotifications) | |
* to subscribe and unsubscribe the device to push notification channels. | |
* | |
* Once the device is subscribed to at least one push channel, listen to the module's `callback`, | |
* `trayClickLaunchedApp`, and `trayClickFocusedApp` events to monitor for incoming push notifications. | |
* | |
* This module must also be added to the modules section in your tiapp.xml. This can be done using the Modules list in | |
* the Titanium Studio TiApp Editor, or by editing the XML directly and adding the following line to the modules | |
* element: | |
* | |
* <module platform="android">ti.cloudpush</module> | |
* | |
* Your app must prove that it is allowed to talk to Arrow. This keeps your data secure by preventing anyone from | |
* making requests to Arrow that impersonate your app. | |
* | |
* Titanium Studio creates a pair of keys (Development and Production) for each Titanium application depending on the | |
* user preference specified during new project creation. This pair of keys will be stored in `tiapp.xml` and one of the | |
* keys will be used during application build depending on the build type (development or production). | |
* | |
* To use push notifications, in the `tiapp.xml` file, you need to specify the Arrow Push keys and push | |
* type. The supported properties in `tiapp.xml` are: | |
* | |
* <!-- Property keys for Arrow Push (required) --> | |
* <property name="acs-api-key-development" type="string">YOUR DEVELOPMENT API KEY HERE</property> | |
* <property name="acs-api-key-production" type="string">YOUR PRODUCTION API KEY HERE</property> | |
* <property name="acs-api-key" type="string">YOUR API KEY HERE</property> | |
* | |
* If a deployment-specific setting is provided (production or development) then that value will be used for the current deployment environment. | |
* | |
* *WARNING*: The default properties of this module are used until you set a property for the first time. Because the | |
* properties are persisted to the device settings (via <Titanium.App.Properties>), the most recent value you set will | |
* always be used. | |
* | |
* #### Virtual Private Cloud Configuration | |
* | |
* If you are using a virtual private cloud (VPC), you need to configure your Arrow Push dispatcher | |
* URL in order to send push notifications with FCM. In the `tiapp.xml` file, add the `acs-push-api-url` | |
* application property and set the node text to the push dispatcher URL provided to you. The URL may | |
* be the same as your custom ArrowDB endpoint and have deployment-specific settings, that is, two | |
* URLs--one for production and another for the development environment. | |
* | |
* <ti:app> | |
* <property name="acs-push-api-url-production">https://api-prod.fooinc.com</property> | |
* <property name="acs-push-api-url-development">https://api-dev.fooinc.com</property> | |
* </ti:app> | |
* | |
* #### Grouped Notifications | |
* | |
* If the device receives multiple push notifications from the application, Android can group these | |
* notifications together as one notification. | |
* | |
* To use grouped notifications, add a grouped notification template to either the `tiapp.xml` file | |
* or the `i18n` folder for internationalized versions: | |
* | |
* `tiapp.xml`: | |
* | |
* <property name="acs-grouped-notification-message-development" type="string">You have $number$ unread messages.</property> | |
* <property name="acs-grouped-notification-message-production" type="string">You have $number$ unread messages.</property> | |
* -or- | |
* <property name="acs-grouped-notification-message" type="string">You have $number$ unread messages.</property> | |
* | |
* `i18n/es/strings.xml` (example for Spanish): | |
* | |
* <?xml version="1.0" encoding="utf-8"?> | |
* <resources> | |
* <string name="acs_grouped_notification_message">Tienes $number$ mensajes no leidos.</string> | |
* </resources> | |
* | |
* The `$number$` variable indicates the number of unread messages. | |
* | |
* @since 2.0.0 (Android) | |
*/ | |
Modules.CloudPush = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Modules.CloudPush.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Modules.CloudPush.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Modules.CloudPush.prototype.lifecycleContainer; | |
/** | |
* Whether or not this device will receive push notifications. | |
* @since 2.0.0 (Android) | |
* @type {Boolean} enabled | |
*/ | |
Modules.CloudPush.prototype.enabled; | |
/** | |
* Whether or not to show a tray notification when a new push is received. | |
* @since 2.0.0 (Android) | |
* @type {Boolean} showTrayNotification | |
*/ | |
Modules.CloudPush.prototype.showTrayNotification; | |
/** | |
* Whether or not clicking the tray notification will bring your application to the foreground. | |
* @since 2.0.0 (Android) | |
* @type {Boolean} showAppOnTrayClick | |
*/ | |
Modules.CloudPush.prototype.showAppOnTrayClick; | |
/** | |
* Whether or not to show tray notifications when your application is in the foreground. | |
* @since 2.0.0 (Android) | |
* @type {Boolean} showTrayNotificationsWhenFocused | |
*/ | |
Modules.CloudPush.prototype.showTrayNotificationsWhenFocused; | |
/** | |
* Whether or not your application is brought to the foreground whenever a new push is received. | |
* @since 2.0.0 (Android) | |
* @type {Boolean} focusAppOnPush | |
*/ | |
Modules.CloudPush.prototype.focusAppOnPush; | |
/** | |
* Set to true to trigger a single callback for the selected push notification when multiple push notifications are displayed in the tray. | |
* @since 2.0.0 (Android) | |
* @type {Boolean} singleCallback | |
*/ | |
Modules.CloudPush.prototype.singleCallback; | |
/** | |
* Code returned from <Modules.PlayServices.isGooglePlayServicesAvailable>. Google Play services is available, and the connection is successful. | |
* @since 3.4.1 (Android) | |
* @readonly | |
* @type {Number} SUCCESS | |
*/ | |
Modules.CloudPush.SUCCESS; | |
/** | |
* Code returned from <Modules.PlayServices.isGooglePlayServicesAvailable>. Google Play services is not installed on the device. | |
* @since 3.4.1 (Android) | |
* @readonly | |
* @type {Number} SERVICE_MISSING | |
*/ | |
Modules.CloudPush.SERVICE_MISSING; | |
/** | |
* Code returned from <Modules.PlayServices.isGooglePlayServicesAvailable>. Google Play services is out of date. | |
* @since 3.4.1 (Android) | |
* @readonly | |
* @type {Number} SERVICE_VERSION_UPDATE_REQUIRED | |
*/ | |
Modules.CloudPush.SERVICE_VERSION_UPDATE_REQUIRED; | |
/** | |
* Code returned from <Modules.PlayServices.isGooglePlayServicesAvailable>. Google Play services has been disabled on this device. | |
* @since 3.4.1 (Android) | |
* @readonly | |
* @type {Number} SERVICE_DISABLED | |
*/ | |
Modules.CloudPush.SERVICE_DISABLED; | |
/** | |
* Code returned from <Modules.PlayServices.isGooglePlayServicesAvailable>. The version of Google Play services installed on this device is not authentic. | |
* @since 3.4.1 (Android) | |
* @readonly | |
* @type {Number} SERVICE_INVALID | |
*/ | |
Modules.CloudPush.SERVICE_INVALID; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 2.0.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Modules.CloudPush.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 2.0.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Modules.CloudPush.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 2.0.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Modules.CloudPush.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Modules.CloudPush.applyProperties = function(props) {}; | |
/** | |
* Asynchronously retrieves the application specific device token. | |
* @since 2.0.0 (Android) | |
* @param {CloudPushNotificationConfig} config Dictionary specifying token retrieval related options. | |
*/ | |
Modules.CloudPush.retrieveDeviceToken = function(config) {}; | |
/** | |
* Clears the CloudPush module's stored status, including the push type, device token, GCM sender ID, etc. | |
* @since 3.1.2 (Android) | |
*/ | |
Modules.CloudPush.clearStatus = function() {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Modules.CloudPush.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Modules.CloudPush.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Modules.CloudPush.getApiName = function() {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Modules.CloudPush.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Modules.CloudPush.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.enabled> property. | |
* @since 2.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Modules.CloudPush.getEnabled = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.enabled> property. | |
* @since 2.0.0 (Android) | |
* @param {Boolean} enabled New value for the property. | |
*/ | |
Modules.CloudPush.setEnabled = function(enabled) {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.showTrayNotification> property. | |
* @since 2.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Modules.CloudPush.getShowTrayNotification = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.showTrayNotification> property. | |
* @since 2.0.0 (Android) | |
* @param {Boolean} showTrayNotification New value for the property. | |
*/ | |
Modules.CloudPush.setShowTrayNotification = function(showTrayNotification) {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.showAppOnTrayClick> property. | |
* @since 2.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Modules.CloudPush.getShowAppOnTrayClick = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.showAppOnTrayClick> property. | |
* @since 2.0.0 (Android) | |
* @param {Boolean} showAppOnTrayClick New value for the property. | |
*/ | |
Modules.CloudPush.setShowAppOnTrayClick = function(showAppOnTrayClick) {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.showTrayNotificationsWhenFocused> property. | |
* @since 2.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Modules.CloudPush.getShowTrayNotificationsWhenFocused = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.showTrayNotificationsWhenFocused> property. | |
* @since 2.0.0 (Android) | |
* @param {Boolean} showTrayNotificationsWhenFocused New value for the property. | |
*/ | |
Modules.CloudPush.setShowTrayNotificationsWhenFocused = function(showTrayNotificationsWhenFocused) {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.focusAppOnPush> property. | |
* @since 2.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Modules.CloudPush.getFocusAppOnPush = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.focusAppOnPush> property. | |
* @since 2.0.0 (Android) | |
* @param {Boolean} focusAppOnPush New value for the property. | |
*/ | |
Modules.CloudPush.setFocusAppOnPush = function(focusAppOnPush) {}; | |
/** | |
* Gets the value of the <Modules.CloudPush.singleCallback> property. | |
* @since 2.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Modules.CloudPush.getSingleCallback = function() {}; | |
/** | |
* Sets the value of the <Modules.CloudPush.singleCallback> property. | |
* @since 2.0.0 (Android) | |
* @param {Boolean} singleCallback New value for the property. | |
*/ | |
Modules.CloudPush.setSingleCallback = function(singleCallback) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* enabled: Boolean, | |
* showTrayNotification: Boolean, | |
* showAppOnTrayClick: Boolean, | |
* showTrayNotificationsWhenFocused: Boolean, | |
* focusAppOnPush: Boolean, | |
* singleCallback: Boolean | |
* }} | |
*/ | |
Modules._Dictionary_CloudPush; | |
/** | |
* Simple object used to describe the size of a movie. | |
* - width Width of the movie. | |
* - height Height of the movie. | |
* @typedef {{ | |
* width: Number, | |
* height: Number | |
* }} | |
*/ | |
var MovieSize = {}; | |
/** | |
* Simple object for specifying options to [openMusicLibrary](Titanium.Media.openMusicLibrary). | |
* - success Function to call when the music library selection is made. | |
* - error Function to call upon receiving an error. | |
* - cancel Function to call if the user presses the cancel button. | |
* - autohide Specifies that the library should be hidden automatically after media selection is completed. | |
* - animated Boolean if the dialog should be animated when showing and hiding. | |
* - mediaTypes An array of media type constants defining selectable media. | |
* - allowMultipleSelections Set to `true` to allow the user to select multiple items from the library. | |
* @typedef {{ | |
* success: Callback<MusicLibraryResponseType>, | |
* error: Callback<FailureResponse>, | |
* cancel: Callback<FailureResponse>, | |
* autohide: Boolean, | |
* animated: Boolean, | |
* mediaTypes: (Number|Array<Number>), | |
* allowMultipleSelections: Boolean | |
* }} | |
*/ | |
var MusicLibraryOptionsType = {}; | |
/** | |
* Simple object passed to the [openMusicLibrary](Titanium.Media.openMusicLibrary) | |
* `success` callback function. | |
* | |
* - representative A single representative of the selected items. | |
* - items A list of all the items chosen by the user. | |
* - types Media types in this collection, represented as the bitwise OR of the media type | |
* values for all media types represented in `items`. | |
* | |
* @typedef {{ | |
* representative: Titanium.Media.Item, | |
* items: Array<Titanium.Media.Item>, | |
* types: Number | |
* }} | |
*/ | |
var MusicLibraryResponseType = {}; | |
/** | |
* Dictionary object of parameters used to create a notification using | |
* <Titanium.App.iOS.scheduleLocalNotification>. | |
* | |
* - identifier The notification identifier. | |
* - alertAction Alert button text ('Open', by default) or home text ('Press Home to unlock', by default) | |
* to display. | |
* | |
* - alertBody Alert message to display. | |
* - alertTitle Alert title to display. | |
* - alertSubtitle Alert subtitle to display. | |
* - alertLaunchImage Image to display instead of `Default.png` when launching the application. | |
* - attachments Notification attachments to display. | |
* - badge Application badge value. | |
* - category String identifier of category of actions to be displayed for an interactive notification. | |
* | |
* - date Date and time for the notification to occur. | |
* - repeat Interval to repeat the notification. One of `weekly`, `daily`, `yearly,` `monthly`. | |
* - sound Path to the sound file to play when notification occurs, relative to the `Resources` folder. | |
* | |
* - timezone Timezone of the date configured for the notification. If not set, the system timezone is used. | |
* | |
* - userInfo Data to pass to the application with the notification event. | |
* - region Region the notification will be triggered in. Allowed parameter are: | |
* | |
* - `latitude`: Latitude of the location center, in decimal degrees (required). | |
* - `longitude`: Longitude of the location center, in decimal degrees (required). | |
* - `triggersOnce`: Whether or not the notification will only fire once (optional, default: true). | |
* | |
* - summaryArgument The string the notification adds to the category's summary format string. | |
* - summaryArgumentCount The number of items the notification adds to the category's summary format string. | |
* @typedef {{ | |
* identifier: String, | |
* alertAction: String, | |
* alertBody: String, | |
* alertTitle: String, | |
* alertSubtitle: String, | |
* alertLaunchImage: String, | |
* attachments: Array<UserNotificationAttachment>, | |
* badge: Number, | |
* category: String, | |
* date: Date, | |
* repeat: String, | |
* sound: String, | |
* timezone: String, | |
* userInfo: Dictionary, | |
* region: Dictionary, | |
* summaryArgument: String, | |
* summaryArgumentCount: String | |
* }} | |
*/ | |
var NotificationParams = {}; | |
/** | |
* An object returned when the <Titanium.UI.WebView.onlink> callback is fired. | |
* - url The url of the link that should be navigated to. | |
* @typedef {{ | |
* url: String | |
* }} | |
*/ | |
var OnLinkURLResponse = {}; | |
/** | |
* An abstract datatype for specifying an Paragraph style attribute. | |
* - alignment The text alignment of the receiver. | |
* - firstLineHeadIndent The indentation of the first line of the receiver. | |
* - headIndent The indentation of the lines of lines other than the first. | |
* - tailIndent The trailing indentation of the receiver. | |
* - lineBreakMode The mode that should be used to break lines in the receiver. | |
* - maximumLineHeight The maximum line height of receiver. | |
* - minimumLineHeight The minimum height of receiver. | |
* - lineSpacing The distance in points between the bottom of one line fragment and the top of the next. | |
* - paragraphSpacingAfter The space after the end of the paragraph. | |
* - paragraphSpacingBefore The distance between the top of paragraph and the beginning of its text content. | |
* - lineHeightMultiple The line height multiple. | |
* - hyphenationFactor The threshold of paragraph for hyphenation. | |
* - allowsDefaultTighteningForTruncation A Boolean value indicating whether the system may tighten inter-character spacing | |
* before truncating text. | |
* | |
* @typedef {{ | |
* alignment: Number, | |
* firstLineHeadIndent: (Number|String), | |
* headIndent: (Number|String), | |
* tailIndent: (Number|String), | |
* lineBreakMode: Number, | |
* maximumLineHeight: (Number|String), | |
* minimumLineHeight: (Number|String), | |
* lineSpacing: (Number|String), | |
* paragraphSpacingAfter: (Number|String), | |
* paragraphSpacingBefore: (Number|String), | |
* lineHeightMultiple: Number, | |
* hyphenationFactor: Number, | |
* allowsDefaultTighteningForTruncation: Boolean | |
* }} | |
*/ | |
var ParagraphAttribute = {}; | |
/** | |
* Simple object for specifying options to | |
* [openPhotoGallery](Titanium.Media.openPhotoGallery). | |
* | |
* - success Function to call when the photo gallery is closed after a successful selection. | |
* - error Function to call upon receiving an error. | |
* - cancel Function to call if the user presses the cancel button. | |
* - autohide Specifies if the photo gallery should be hidden automatically after the media | |
* selection is completed. | |
* | |
* - animated Specifies if the dialog should be animated upon showing and hiding. | |
* - allowEditing Specifies if the media should be editable after capture/selection. | |
* - mediaTypes Array of media type constants to allow. | |
* | |
* Live photos is only supported on the iOS platform, starting with iOS 9.1. If you want | |
* to allow live photos with <Titanium.Media.MEDIA_TYPE_LIVEPHOTO>, you also need to specify | |
* at least <Titanium.Media.MEDIA_TYPE_PHOTO> as a fallback. If you do not allow live | |
* photos, they still can be selected, but will be represented as a normal static photo. | |
* | |
* - popoverView View to position the photo gallery popover on top of. | |
* - arrowDirection Controls the type of arrow and position of the popover. | |
* - allowMultiple Specifies if the user should be able to select multiple photos. | |
* - allowTranscoding Specifies if the video should be transcoded (using highest quality preset) . If set to false no video transcoding will be performed. | |
* @typedef {{ | |
* success: Callback<CameraMediaItemType>, | |
* error: Callback<FailureResponse>, | |
* cancel: Callback<FailureResponse>, | |
* autohide: Boolean, | |
* animated: Boolean, | |
* allowEditing: Boolean, | |
* mediaTypes: Array<String>, | |
* popoverView: Titanium.UI.View, | |
* arrowDirection: Number, | |
* allowMultiple: Boolean, | |
* allowTranscoding: Boolean | |
* }} | |
*/ | |
var PhotoGalleryOptionsType = {}; | |
/** | |
* A pair of coordinates used to describe the location of a <Titanium.UI.View>. | |
* - x The x-axis coordinate of this point. | |
* - y The y-axis coordinate of this point. | |
* @typedef {{ | |
* x: (Number|String), | |
* y: (Number|String) | |
* }} | |
*/ | |
var Point = {}; | |
/** | |
* Dictionary of options for <Titanium.UI.iPad.Popover.show> and <Titanium.UI.iPad.Popover.hide>. | |
* - animated Indicates whether to animate showing or hiding the popover. | |
* - rect Sets the arrow position of the popover relative to the attached view object's dimensions | |
* when showing the popover. | |
* | |
* - view Attaches the popover to the specified view when showing the popover. | |
* @typedef {{ | |
* animated: Boolean, | |
* rect: Dimension, | |
* view: Titanium.UI.View | |
* }} | |
*/ | |
var PopoverParams = {}; | |
/** | |
* Simple `Error` argument provided to the callback from the | |
* [executeAllAsync](Titanium.Database.DB.executeAllAsync) method in case of failure | |
* | |
* - index Index of the failed query | |
* @typedef {{ | |
* index: Number | |
* }} | |
*/ | |
var PossibleBatchQueryError = {}; | |
/** | |
* The parameter passed to the `error` callback of <PreviewImageOptions>. | |
* - success Indicates if the operation succeeded. Returns `false`. | |
* - error Error message, if any returned. | |
* - code Error code, if applicable. | |
* - message Description of the error. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* message: String | |
* }} | |
*/ | |
var PreviewImageError = {}; | |
/** | |
* Options passed to <Titanium.Media.previewImage>. | |
* - image The image to preview. Must be a blob based on a file, such as from <Titanium.Filesystem.File.read>. | |
* - success Function to be called back if the preview succeeds. No info is passed. | |
* - error Function called back if the preview fails. Check the `message` property of passed back parameter. | |
* @typedef {{ | |
* image: Titanium.Blob, | |
* success: Callback<Object>, | |
* error: Callback<PreviewImageError> | |
* }} | |
*/ | |
var PreviewImageOptions = {}; | |
/** | |
* Simple object for describing the preview image rectangle. This will be undefined when custom camera overlay is not used. | |
* | |
* - width Width preview image, in pixels. | |
* - height Height preview image, in pixels. | |
* @typedef {{ | |
* width: Number, | |
* height: Number | |
* }} | |
*/ | |
var PreviewRectType = {}; | |
/** | |
* Argument passed to the callback each time the | |
* [pump](Titanium.Stream.pump) operation has new data to deliver. | |
* | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* - source Stream being read from. | |
* - buffer Buffer object holding the data currently being pumped to the handler method. | |
* - bytesProcessed Number of bytes being passed to this invocation of the handler, or | |
* -1 in the event of an error or end of stream. | |
* | |
* - totalBytesProcessed Total number of bytes read from the stream so far, | |
* including the data passed to this current invocation of the handler. | |
* | |
* - errorState Whether an error was encountered. Set to 1 in the case of an error, 0 | |
* otherwise. | |
* | |
* - errorDescription Text description of the error. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* source: Titanium.IOStream, | |
* buffer: Titanium.Buffer, | |
* bytesProcessed: Number, | |
* totalBytesProcessed: Number, | |
* errorState: Number, | |
* errorDescription: String | |
* }} | |
*/ | |
var PumpCallbackArgs = {}; | |
/** | |
* Simple object for specifying push notification options to | |
* [registerForPushNotifications](Titanium.Network.registerForPushNotifications). | |
* | |
* - types Array of `NOTIFICATION_TYPE` constants that the application would like to receive. | |
* - success Callback function called when the push registration is successfully completed. | |
* | |
* - error Callback function called when an error occurs during registration. | |
* | |
* - callback Callback function invoked upon receiving a new push notification. | |
* @typedef {{ | |
* types: Array<Number>, | |
* success: Callback<PushNotificationSuccessArg>, | |
* error: Callback<PushNotificationErrorArg>, | |
* callback: Callback<PushNotificationData> | |
* }} | |
*/ | |
var PushNotificationConfig = {}; | |
/** | |
* A simple object representing a push notification. | |
* - data The `userinfo` dictionary passed to the Apple Push Notification Service. | |
* - inBackground Boolean indicating if notification was received while app was in background. | |
* This property became available in Titanium Mobile 3.1.0 for iOS. | |
* | |
* @typedef {{ | |
* data: Dictionary, | |
* inBackground: Boolean | |
* }} | |
*/ | |
var PushNotificationData = {}; | |
/** | |
* A simple object passed to the | |
* [registerForPushNotifications](Titanium.Network.registerForPushNotifications) error callback. | |
* | |
* - success Indicates if the operation succeeded. Returns `false`. | |
* - error Error message, if any returned. | |
* - code Error code. Returns a non-zero value. | |
* - type The value of this string is always "remote". | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* type: String | |
* }} | |
*/ | |
var PushNotificationErrorArg = {}; | |
/** | |
* A simple object passed to the | |
* [registerForPushNotifications](Titanium.Network.registerForPushNotifications) success callback. | |
* | |
* - success Indicates if the operation succeeded. Returns `true`. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0. | |
* - type The value of this string is always "remote". | |
* - deviceToken The device token which this device was registered for. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* type: String, | |
* deviceToken: String | |
* }} | |
*/ | |
var PushNotificationSuccessArg = {}; | |
/** | |
* Argument passed to the read callback when an asynchronous [read](Titanium.Stream.read) operation | |
* finishes. | |
* | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* - source Stream being read. | |
* - bytesProcessed Number of bytes processed, or -1 in the event of an error or end of stream. | |
* - errorState Whether an error was encountered. Set to 1 in the case of an error, 0 | |
* otherwise. | |
* | |
* - errorDescription Text description of the error. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* source: Titanium.IOStream, | |
* bytesProcessed: Number, | |
* errorState: Number, | |
* errorDescription: String | |
* }} | |
*/ | |
var ReadCallbackArgs = {}; | |
/** | |
* An Object describing the current ready state. See [onreadystatechange](Titanium.Network.HTTPClient.onreadystatechange) for more information. | |
* - readyState The state for which `onreadystatechange` was invoked. Set to one of `Titanium.Network.HTTPClient` ready-state constants | |
* @typedef {{ | |
* readyState: Number | |
* }} | |
*/ | |
var ReadyStatePayload = {}; | |
/** | |
* Dictionary to specify edge insets for <Titanium.UI.iOS.CollisionBehavior.referenceInsets>. | |
* - top Top inset. | |
* - left Left inset. | |
* - right Right inset. | |
* - bottom Bottom inset. | |
* @typedef {{ | |
* top: Number, | |
* left: Number, | |
* right: Number, | |
* bottom: Number | |
* }} | |
*/ | |
var ReferenceInsets = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var RequestCameraAccessResult = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var RequestMusicLibraryAccessResult = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var RequestPermissionAccessResult = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var RequestPhotoGalleryAccessResult = {}; | |
/** | |
* Argument passed to the callback when a request finishes successfully or erroneously. | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var RequestStorageAccessResult = {}; | |
/** | |
* Simple object returned in the callback from the | |
* [reverseGeocoder](Titanium.Geolocation.reverseGeocoder) method. | |
* | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* - places An array of reverse-geocoded addresses matching the requested location. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* places: Array<GeocodedAddress> | |
* }} | |
*/ | |
var ReverseGeocodeResponse = {}; | |
/** | |
* An Object describing the current audio route. | |
* - inputs An Array of current input ports for the session. See the `AUDIO_SESSION_PORT` constants. | |
* - outputs An Array of current output ports for the session. See the `AUDIO_SESSION_PORT` constants. | |
* @typedef {{ | |
* inputs: Array<Object>, | |
* outputs: Array<Object> | |
* }} | |
*/ | |
var RouteDescription = {}; | |
/** | |
* Represents the custom edit action for a ListItem. | |
* - title The title of the row action. | |
* - identifier The [identifier](RowActionType. identifier) of the row action. Only included in the event | |
* if previously defined. Available in Titanium 6.0.0 and later. | |
* | |
* - style The style of the row action. | |
* - color The background color of the row action. | |
* @typedef {{ | |
* title: String, | |
* identifier: String, | |
* style: Number, | |
* color: String | |
* }} | |
*/ | |
var RowActionType = {}; | |
/** | |
* The parameter passed to the <Titanium.Media.takeScreenshot> callback. | |
* - media The screenshot image. | |
* @typedef {{ | |
* media: Titanium.Blob | |
* }} | |
*/ | |
var ScreenshotResult = {}; | |
/** | |
* A simple object for specifying the animation properties when scrolling the view. | |
* | |
* - animated When set to `true` it will scroll smoothly to the destination. | |
* @typedef {{ | |
* animated: Boolean | |
* }} | |
*/ | |
var ScrollViewAnimationProperties = {}; | |
/** | |
* The protocol that the <Titanium.Network.HTTPClient.securityManager> must implement. | |
* @typedef {{ | |
* }} | |
*/ | |
var SecurityManagerProtocol = {}; | |
/** | |
* The arguments for the <Titanium.UI.ListView.itemsselected> event. | |
* - section List section if the item is contained in a list section. | |
* - sectionIndex Section index. | |
* - itemIndex Item index. | |
* @typedef {{ | |
* section: Titanium.UI.ListSection, | |
* sectionIndex: Number, | |
* itemIndex: Number | |
* }} | |
*/ | |
var SelectedItem = {}; | |
/** | |
* The arguments for the <Titanium.UI.TableView.rowsselected> event. | |
* - index Row index. | |
* - row Table view row object. | |
* - rowData Properties of the row. Use this property rather than `row` to access any custom row properties. | |
* | |
* - section Table view section object, if the clicked row is contained in a section. | |
* @typedef {{ | |
* index: Number, | |
* row: Titanium.UI.TableViewRow, | |
* rowData: Titanium.UI._Dictionary_TableViewRow, | |
* section: Titanium.UI.TableViewSection | |
* }} | |
*/ | |
var SelectedRowObject = {}; | |
/** | |
* Options passed to <Titanium.Android.createServiceIntent>. | |
* - url URL for the service's JavaScript. | |
* - startMode One of the `START_*` constants from <Titanium.Android> to specify the "stickiness" of the Service when Android shuts down the host application. | |
* @typedef {{ | |
* url: String, | |
* startMode: Number | |
* }} | |
*/ | |
var ServiceIntentOptions = {}; | |
/** | |
* Object of options for <Titanium.UI.iOS.ApplicationShortcuts.addDynamicShortcut>. | |
* - itemtype The unique key for the application shortcut. | |
* - title The title of the application shortcut. | |
* - subtitle The subtitle displayed on the application shortcut. | |
* - icon The icon to be displayed on the application shortcut. You can either use one of the constants like | |
* <Titanium.UI.iOS.SHORTCUT_ICON_TYPE_COMPOSE>, a local image specified by the image path or a reference to a | |
* <Titanium.Contacts.Person>. | |
* | |
* - userInfo The userInfo of the application shortcut. | |
* @typedef {{ | |
* itemtype: String, | |
* title: String, | |
* subtitle: String, | |
* icon: (Number|String|Titanium.Contacts.Person), | |
* userInfo: Object | |
* }} | |
*/ | |
var ShortcutParams = {}; | |
/** | |
* The parameter passed to the <Titanium.UI.WebView.takeSnapshot> callback. | |
* - snapshot The snapshot image. | |
* - success Indicates if the snapshot taken. | |
* - error Error message, if any returned. | |
* @typedef {{ | |
* snapshot: Titanium.Blob, | |
* success: Boolean, | |
* error: String | |
* }} | |
*/ | |
var SnapshotResult = {}; | |
/** | |
* Properties used in any event or callback which needs to report a success. | |
* - success Indicates if the operation succeeded. Returns `true`. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number | |
* }} | |
*/ | |
var SuccessResponse = {}; | |
/** | |
* Dictionary to specify edge insets for <Titanium.UI.Tab.iconInsets>. | |
* - top Top inset. | |
* - left Left inset. | |
* @typedef {{ | |
* top: Number, | |
* left: Number | |
* }} | |
*/ | |
var TabIconInsets = {}; | |
/** | |
* A simple object for specifying the animation properties to use when inserting or deleting rows, or scrolling the table. | |
* - animated Whether this table change should be animated. Ignored if any `animationStyle` value is specified. | |
* - animationStyle Type of animation to use for row insertions and deletions. | |
* - position Specifies what position to scroll the selected row to. | |
* @typedef {{ | |
* animated: Boolean, | |
* animationStyle: Number, | |
* position: Number | |
* }} | |
*/ | |
var TableViewAnimationProperties = {}; | |
/** | |
* Optional parameter for [setContentInsets](Titanium.UI.TableView.setContentInsets) method. | |
* - animated Determines whether the table view's content inset change is animated. | |
* - duration The duration in `milleseconds` for animation while the content inset is being changed. | |
* @typedef {{ | |
* animated: Boolean, | |
* duration: Number | |
* }} | |
*/ | |
var TableViewContentInsetOption = {}; | |
/** | |
* The parameter for [setContentInsets](Titanium.UI.TableView.setContentInsets) method. | |
* - top Value specifying the top insets for the enclosing scroll view of the table. | |
* - left Value specifying the left insets for the enclosing scroll view of the table. | |
* - right Value specifying the right insets for the enclosing scroll view of the table. | |
* - bottom Value specifying the bottom insets for the enclosing scroll view of the table. | |
* @typedef {{ | |
* top: Number, | |
* left: Number, | |
* right: Number, | |
* bottom: Number | |
* }} | |
*/ | |
var TableViewEdgeInsets = {}; | |
/** | |
* A simple object that represents an index entry in a `TableView`. | |
* - title Title to display in the index bar for this item. | |
* - index Row index associated with this item. | |
* @typedef {{ | |
* title: String, | |
* index: Number | |
* }} | |
*/ | |
var TableViewIndexEntry = {}; | |
/** | |
* Dictionary object of parameters for the <Titanium.UI.TextField.padding> that describes the padding | |
* - left Left padding | |
* - right Right padding | |
* - top Top padding (Android only, since 6.1.0) | |
* - bottom Bottom padding (Android only, since 6.1.0) | |
* @typedef {{ | |
* left: Number, | |
* right: Number, | |
* top: Number, | |
* bottom: Number | |
* }} | |
*/ | |
var TextFieldPadding = {}; | |
/** | |
* Simple object passed to the thumbnail callback in response to the | |
* [requestThumbnailImagesAtTimes](Titanium.Media.VideoPlayer.requestThumbnailImagesAtTimes) | |
* method. | |
* | |
* - success Indicates if the operation succeeded. | |
* - error Error message, if any returned. | |
* - code Error code. Returns 0 if `success` is `true`. | |
* - image Thumbnail image, as a `Blob`. | |
* - time Time offset for the thumbnail, in seconds. | |
* @typedef {{ | |
* success: Boolean, | |
* error: String, | |
* code: Number, | |
* image: Titanium.Blob, | |
* time: Number | |
* }} | |
*/ | |
var ThumbnailResponse = {}; | |
/** | |
* An abstract type to represent a metadata item inside the `metadata` event (iOS only). | |
* - key The key of the metadata item, e.g. "title". | |
* - keySpace The key-path of the metadata item. | |
* - value The value of the metadata item. Can be represented as various types. | |
* - extraAttributes A dictionary of the additional attributes. | |
* @typedef {{ | |
* key: String, | |
* keySpace: String, | |
* value: (String|Number|Boolean), | |
* extraAttributes: Dictionary | |
* }} | |
*/ | |
var TiMetadataItemType = {}; | |
/** | |
* The top-level Titanium module. | |
* @extends {Titanium.Module} | |
* @description The Titanium module provides the Titanium Mobile API, allowing developers to access native | |
* features of each target environment. Currently, the Android and iOSenvironments are supported. | |
* | |
* #### Titanium Namespace | |
* | |
* The complete Titanium API is accessible from the `Titanium` namespace but, for convenience and | |
* brevity, the alias `Ti` is also provided. As the `Titanium` namespace is functionally-identical | |
* to its `Ti` alias, it is always recommended to use `Ti` in your code. | |
* | |
* For example, the following pairs of Titanium calls behave exactly the same. | |
* | |
* Titanium.API.info('Hello Titanium!'); | |
* Ti.API.info('Hello Titanium!'); | |
* | |
* Titanium.Utils.sha256('Hello Titanium!'); | |
* Ti.Utils.sha256('Hello Titanium!'); | |
* | |
* Titanium.App.Properties.setString('hello_msg','Hello Titanium!'); | |
* Ti.App.Properties.setString('hello_msg','Hello Titanium!'); | |
* | |
* Titanium.Database.open('mydb'); | |
* Ti.Database.open('mydb'); | |
* | |
* #### Global APIs | |
* | |
* Titanium includes a number of built-in JavaScript objects that are not part of the Titanium | |
* namespace, including JSON parsing, String formatting, timers, and the CommonJS `require` function. | |
* See [Global APIs](Global) for details. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
var Titanium = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.prototype.lifecycleContainer; | |
/** | |
* User-agent string used by Titanium. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} userAgent | |
*/ | |
Titanium.prototype.userAgent; | |
/** | |
* Version of Titanium that is executing. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} version | |
*/ | |
Titanium.prototype.version; | |
/** | |
* Date of the Titanium build. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} buildDate | |
*/ | |
Titanium.prototype.buildDate; | |
/** | |
* Git hash of the Titanium build. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} buildHash | |
*/ | |
Titanium.prototype.buildHash; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.applyProperties = function(props) {}; | |
/** | |
* Creates a new buffer based on the params. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {CreateBufferArgs} params creation arguments | |
* @return {Titanium.Buffer} | |
*/ | |
Titanium.createBuffer = function(params) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Proxy>. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Titanium._Dictionary_Proxy=} parameters Properties to set on a new object, including any defined by <Titanium.Proxy> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.Proxy} | |
*/ | |
Titanium.createProxy = function(parameters) {}; | |
/** | |
* Gets the value of the <Titanium.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.userAgent> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.getUserAgent = function() {}; | |
/** | |
* Sets the value of the <Titanium.userAgent> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} userAgent New value for the property. | |
*/ | |
Titanium.setUserAgent = function(userAgent) {}; | |
/** | |
* Gets the value of the <Titanium.version> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.getVersion = function() {}; | |
/** | |
* Gets the value of the <Titanium.buildDate> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.getBuildDate = function() {}; | |
/** | |
* Gets the value of the <Titanium.buildHash> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.getBuildHash = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* userAgent: String | |
* }} | |
*/ | |
var _Dictionary_Titanium; | |
/** | |
* The top-level API module, containing methods to output messages to the system log. | |
* | |
* @extends {Titanium.Module} | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.API = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.API.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.API.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.API.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.API.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.API.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.API.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.API.applyProperties = function(props) {}; | |
/** | |
* Logs messages with a `debug` severity-level. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Array<String>|String} message Message to log. Accepts an array on iOS only. | |
*/ | |
Titanium.API.debug = function(message) {}; | |
/** | |
* Logs messages with an `error` severity-level. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Array<String>|String} message Message to log. Accepts an array on iOS only. | |
*/ | |
Titanium.API.error = function(message) {}; | |
/** | |
* Logs messages with an `info` severity-level. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Array<String>|String} message Message to log. Accepts an array on iOS only. | |
*/ | |
Titanium.API.info = function(message) {}; | |
/** | |
* Logs messages with the specified severity-level. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} level Log level. One of `info`, `warn`, `error`, `debug` and `trace`. If the value is not | |
* recognized, an info-level message prefixed with the value is logged. | |
* | |
* @param {Array<String>|String} message Message to log. Accepts an array on iOS only. | |
*/ | |
Titanium.API.log = function(level, message) {}; | |
/** | |
* Logs messages with a `timestamp` severity-level, prefixed with a timestamp float number | |
* representing the number of seconds since January 1st, 2001. | |
* | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @param {Array<String>|String} message Message to log. Accepts an array on iOS only. | |
*/ | |
Titanium.API.timestamp = function(message) {}; | |
/** | |
* Logs messages with a `trace` severity-level. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Array<String>|String} message Message to log. Accepts an array on iOS only. | |
*/ | |
Titanium.API.trace = function(message) {}; | |
/** | |
* Logs messages with a `warn` severity-level. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Array<String>|String} message Message to log. Accepts an array on iOS only. | |
*/ | |
Titanium.API.warn = function(message) {}; | |
/** | |
* Gets the value of the <Titanium.API.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.API.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.API.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.API.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.API.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.API.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.API.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.API.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.API.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.API.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_API; | |
/** | |
* The top-level Accelerometer module, used to determine the device's physical position. | |
* | |
* @extends {Titanium.Module} | |
* @description An accelerometer is a hardware unit integrated into a mobile device, that detects when the | |
* device has moved, and returns its new orientation in a three-dimensional space. With its | |
* single `update` event, this module provides an interface to access the output positional data. | |
* | |
* An accelerometer needs to be switched on in order for it to report to the operating system, | |
* which consumes a lot of power that will deplete the battery over time. This is why it is | |
* recommended that the accelerometer is switched off when not in use. | |
* | |
* The accelerometer may be switched on and off by simply adding and removing the `update` | |
* event listener function. See the example for a demonstration. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.Accelerometer = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Accelerometer.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Accelerometer.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Accelerometer.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Accelerometer.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Accelerometer.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Accelerometer.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Accelerometer.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Accelerometer.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Accelerometer.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Accelerometer.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Accelerometer.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Accelerometer.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Accelerometer.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Accelerometer.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Accelerometer.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Accelerometer.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Accelerometer.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_Accelerometer; | |
/** | |
* Used for transmitting developer-defined Analytics events to the Appcelerator Analytics product. | |
* | |
* @extends {Titanium.Module} | |
* @description The Analytics module can be used to supply additional context or application-specific | |
* information which can then be accessed during analysis using Analytics. | |
* | |
* Use the [featureEvent](Titanium.Analytics.featureEvent) method to generate custom | |
* events that you can view through the Analytics product. You can specify a name for | |
* the feature event which is visible through Analytics. | |
* | |
* **NOTE** The Analytics module lets you transmit some data that is stored, but | |
* not made accessible through the Analytics UI. To access this data, you must | |
* sign up for the optional raw data export service. | |
* | |
* *The following types of data are stored but not made available through the Analytics UI:* | |
* | |
* * Navigation events. | |
* | |
* * Extra data added to feature events (the `data` parameter). | |
* | |
* Viewing navigation events in the Analytics UI will be supported in a future version | |
* of the Analytics product. There is no plan to support the other event types, and they | |
* should not be used. | |
* | |
* **GDPR Compliance** | |
* | |
* The Ti.Analytics namespace in Titanium is GDPR compliant since SDK 7.2.0. End users | |
* should be able to opt out of Analytics using the <Titanium.Analytics.optedOut> property. | |
* If a user opted out from Analytics and you still call Analytics events, they will be ignored. | |
* | |
* Note: This does not affect your app until you make use of the `optedOut` property. Once | |
* enabled for your users (e.g. by having a <Titanium.UI.Switch> in your settings), you | |
* should handle it within your app logic. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.Analytics = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Analytics.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Analytics.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Analytics.prototype.lifecycleContainer; | |
/** | |
* JSON representation of the last Analytics event generated. | |
* @since 3.1.2 (Android), 3.1.2 (iPhone), 3.1.2 (iPad) | |
* @readonly | |
* @type {String} lastEvent | |
*/ | |
Titanium.Analytics.prototype.lastEvent; | |
/** | |
* Allows the user to opt out from Analytics during runtime to comply to GPDR. | |
* @since 7.2.0 (Android), 7.2.0 (iPhone), 7.2.0 (iPad) | |
* @type {Boolean} optedOut | |
*/ | |
Titanium.Analytics.prototype.optedOut; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Analytics.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Analytics.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Analytics.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Analytics.applyProperties = function(props) {}; | |
/** | |
* Sends a generic event for this application session. | |
* **Not displayed in Analytics UI**. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} type Event type. | |
* @param {String} name Event name. | |
* @param {Object=} data Extra data related to the event. Must be serializable as JSON. | |
* | |
*/ | |
Titanium.Analytics.addEvent = function(type, name, data) {}; | |
/** | |
* Sends a feature event for this application session. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Event name, displayed in Analytics UI. | |
* @param {Object=} data Extra data related to the event. Must be serializable as JSON. | |
* | |
* @return {Number} | |
*/ | |
Titanium.Analytics.featureEvent = function(name, data) {}; | |
/** | |
* Sets a list of events that will not be sent to the Analytics server. | |
* @since 4.1.0 (Android), 4.1.0 (iPhone), 4.1.0 (iPad) | |
* @param {Array<String>} events List of events to be filtered. | |
*/ | |
Titanium.Analytics.filterEvents = function(events) {}; | |
/** | |
* Sends a navigation event for this application session. | |
* **Not displayed in Analytics UI**. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} from String describing the location the user navigated from. | |
* @param {String} to String describing the location the user navigated to. | |
* @param {String=} name Event name. | |
* @param {Object=} data Extra data related to the event. The object must be serializable as JSON. | |
*/ | |
Titanium.Analytics.navEvent = function(from, to, name, data) {}; | |
/** | |
* Sends a settings event for this application session. | |
* **Not displayed in Analytics UI**. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Event name. | |
* @param {Object=} data Extra data related to the event. Must be serializable as JSON. | |
*/ | |
Titanium.Analytics.settingsEvent = function(name, data) {}; | |
/** | |
* Send a timed event for this application session. | |
* **Not displayed in Analytics UI**. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Event name. | |
* @param {Date} start Event start as a Date object. | |
* @param {Date} stop Event end as a Date object. | |
* @param {Number} duration Event duration. | |
* @param {Object=} data Extra data related to the event. Must be serializable as JSON. | |
*/ | |
Titanium.Analytics.timedEvent = function(name, start, stop, duration, data) {}; | |
/** | |
* Sends a user event for this application session. **Not displayed in Analytics UI**. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Event name. | |
* @param {Object=} data Extra data related to the event. Must be serializable as JSON. | |
*/ | |
Titanium.Analytics.userEvent = function(name, data) {}; | |
/** | |
* Gets the value of the <Titanium.Analytics.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Analytics.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Analytics.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Analytics.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Analytics.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Analytics.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Analytics.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Analytics.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Analytics.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Analytics.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Analytics.lastEvent> property. | |
* @since 3.1.2 (Android), 3.1.2 (iPhone), 3.1.2 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Analytics.getLastEvent = function() {}; | |
/** | |
* Gets the value of the <Titanium.Analytics.optedOut> property. | |
* @since 7.2.0 (Android), 7.2.0 (iPhone), 7.2.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Analytics.getOptedOut = function() {}; | |
/** | |
* Sets the value of the <Titanium.Analytics.optedOut> property. | |
* @since 7.2.0 (Android), 7.2.0 (iPhone), 7.2.0 (iPad) | |
* @param {Boolean} optedOut New value for the property. | |
*/ | |
Titanium.Analytics.setOptedOut = function(optedOut) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* optedOut: Boolean | |
* }} | |
*/ | |
Titanium._Dictionary_Analytics; | |
/** | |
* The top-level Android module. | |
* @extends {Titanium.Module} | |
* @description The Android module allows the application to manage various Android components. | |
* | |
* #### Drawer Layout | |
* | |
* The drawer-layout components acts as a top-level container for window content that allows | |
* for interactive "drawer" views to be pulled out from one or both vertical edges of the window. | |
* It is represented by a `centerView` and optional `leftView` and `rightView` components that | |
* can be swiped in and out with additional configuration and transitions. Learn more about | |
* drawer-layouts in it's dedicated <Titanium.UI.Android.DrawerLayout> docs. | |
* | |
* #### Action Bar | |
* | |
* An action bar is a UI feature that identifies the application and user location, and | |
* provides user actions and navigation modes. | |
* | |
* The Titanium SDK lets you customize the look of the action bar and add action items. | |
* Action items are added using the <Titanium.Android.Menu> API. | |
* | |
* For more information about the action bar, see the | |
* [Titanium.Android.ActionBar API reference](Titanium.Android.ActionBar). | |
* | |
* #### Activities | |
* | |
* An Android application is made up of one or more activities. Each activity represents a single screen | |
* with a user interface. | |
* | |
* In Titanium, each `Window` or `TabGroup` has its own activity. The application | |
* can access the activity of a `Window` and `TabGroup` object and monitor its lifecycle events. | |
* Titanium also lets you launch new activities by creating intents to launch them. | |
* See the "Intents" section below. | |
* | |
* For more information about activities, see the | |
* [Titanium.Android.Activity API reference](Titanium.Android.Activity). | |
* | |
* #### Broadcast Intents and Receivers | |
* | |
* Broadcast Intents allow your application to send out a message to any application that sets up | |
* a Broadcast Receiver to listen to it. Your application can also register Broadcast Receivers | |
* to listen to system events sent by the Android OS, such as low battery warnings or airplane | |
* mode changes. | |
* | |
* For more information about broadcasts, see the | |
* [Android Broadcast Intents and Receivers guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Broadcast_Intents_and_Receivers) | |
* and [Titanium.Android.BroadcastReceiver API reference](Titanium.Android.BroadcastReceiver). | |
* | |
* #### Intents | |
* | |
* Intents are message objects that specify actions to perform which can start either activities, | |
* broadcasts or services. | |
* | |
* For more information about intents, see the | |
* [Titanium.Android.Intent API reference](Titanium.Android.Intent). | |
* | |
* #### Intent Filters | |
* | |
* Intent Filters advertise to the Android OS that your application handles certain actions and | |
* data types. For example, when another application wants to share an image or text, your application | |
* can define intent filters to let Android know your application can handle those data types. | |
* | |
* For more information about intent filters, see the | |
* [Android Intent Filters guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Intent_Filters). | |
* | |
* #### Notifications | |
* | |
* Notifications alert the user that something is happening to your application while it is | |
* in the background. Notifications appear in the notification drawer until the user | |
* clears them and on the lock screen for devices running Android 5.0 or greater. | |
* Note that the user can filter or turn notifications on and off from **Settings**. | |
* For more information about notifications, see the | |
* [Titanium.Android.Notification API reference](Titanium.Android.Notification). | |
* | |
* For Android toast notifications (pop-up notifications sent while the application is in the | |
* foreground), see <Titanium.UI.Notification>. | |
* | |
* #### Options Menu | |
* | |
* The options menu is a feature of older Android devices (prior to Android 3.0 (API 11)), and has been | |
* replaced by the action bar. The options menu is accessed by pressing the **Menu** and presents | |
* a pop-up menu of options the user can execute. | |
* | |
* The `Titanium.Android.Menu` API is used to construct both the options menu and action items for | |
* the action bar. | |
* | |
* For more information about the options menu, see the | |
* [Titanium.Android.Menu API reference](Titanium.Android.Menu). | |
* | |
* #### Services | |
* | |
* A service is a component started by an application that runs in the background. The service | |
* does not have any application UI associated with it, so the user does not directly interact | |
* with it, only your application. | |
* | |
* The Titanium SDK gives you the ability to write your own Android Services using JavaScript. | |
* The service executes your JavaScript code at intervals you specify. Note that the service | |
* will stop running when you back out of the app. So, if you want the service to continue running, | |
* then it's recommended that you set the root window's [exitOnClose](Titanium.UI.Window.exitOnClose) | |
* property to `false` so that the window will persist in the background like iOS. | |
* | |
* For more information about services, see the | |
* [Titanium.Android.Service API reference](Titanium.Android.Service). | |
* | |
* #### Permissions | |
* | |
* Starting from Android 6.0 (API level 23), users need to grant certain permissions to apps while the | |
* app is running. You can read it more [here](https://developer.android.com/training/permissions/requesting.html). | |
* | |
* In Titanium SDK, to support this, we have the <Titanium.Android.requestPermissions> method. It is used to | |
* request any permission you may need. An example of using it is shown below: | |
* | |
* var permissions = [ 'android.permission.CAMERA', 'android.permission.READ_EXTERNAL_STORAGE' ]; | |
* Ti.Android.requestPermissions(permissions, function (e) { | |
* if (e.success) { | |
* Ti.API.info('SUCCESS'); | |
* } else { | |
* Ti.API.info('ERROR: ' + e.error); | |
* } | |
* }); | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.prototype.lifecycleContainer; | |
/** | |
* User switched airplane mode on or off. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_AIRPLANE_MODE_CHANGED | |
*/ | |
Titanium.Android.ACTION_AIRPLANE_MODE_CHANGED; | |
/** | |
* List all applications. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_ALL_APPS | |
*/ | |
Titanium.Android.ACTION_ALL_APPS; | |
/** | |
* Handle an incoming phone call. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_ANSWER | |
*/ | |
Titanium.Android.ACTION_ANSWER; | |
/** | |
* Used to indicate that the data is an attachment. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_ATTACH_DATA | |
*/ | |
Titanium.Android.ACTION_ATTACH_DATA; | |
/** | |
* Listen to battery state change status. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_BATTERY_CHANGED | |
*/ | |
Titanium.Android.ACTION_BATTERY_CHANGED; | |
/** | |
* Indicates low battery condition on the device. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_BATTERY_LOW | |
*/ | |
Titanium.Android.ACTION_BATTERY_LOW; | |
/** | |
* Inidicates the battery is now okay after being low. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_BATTERY_OKAY | |
*/ | |
Titanium.Android.ACTION_BATTERY_OKAY; | |
/** | |
* Indicates the system has finished booting. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_BOOT_COMPLETED | |
*/ | |
Titanium.Android.ACTION_BOOT_COMPLETED; | |
/** | |
* Show activity for reporting a bug. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_BUG_REPORT | |
*/ | |
Titanium.Android.ACTION_BUG_REPORT; | |
/** | |
* Perform a call to someone specified by the `data` property. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_CALL | |
*/ | |
Titanium.Android.ACTION_CALL; | |
/** | |
* User pressed the call button. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_CALL_BUTTON | |
*/ | |
Titanium.Android.ACTION_CALL_BUTTON; | |
/** | |
* The camera button was pressed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_CAMERA_BUTTON | |
*/ | |
Titanium.Android.ACTION_CAMERA_BUTTON; | |
/** | |
* Display an activity chooser. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_CHOOSER | |
*/ | |
Titanium.Android.ACTION_CHOOSER; | |
/** | |
* User dismissed a temporary system dialog, such as the notification drawer or recent-app drawer. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_CLOSE_SYSTEM_DIALOGS | |
*/ | |
Titanium.Android.ACTION_CLOSE_SYSTEM_DIALOGS; | |
/** | |
* The device's configuration changed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_CONFIGURATION_CHANGED | |
*/ | |
Titanium.Android.ACTION_CONFIGURATION_CHANGED; | |
/** | |
* Create a shortcut. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_CREATE_SHORTCUT | |
*/ | |
Titanium.Android.ACTION_CREATE_SHORTCUT; | |
/** | |
* Date changed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_DATE_CHANGED | |
*/ | |
Titanium.Android.ACTION_DATE_CHANGED; | |
/** | |
* Default action, which is `Titanium.Android.ACTION_VIEW` | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_DEFAULT | |
*/ | |
Titanium.Android.ACTION_DEFAULT; | |
/** | |
* Delete the data specified by the Intent's `data` property. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_DELETE | |
*/ | |
Titanium.Android.ACTION_DELETE; | |
/** | |
* Indicates a low memory condition on the device. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_DEVICE_STORAGE_LOW | |
*/ | |
Titanium.Android.ACTION_DEVICE_STORAGE_LOW; | |
/** | |
* Dial a number specified by the Intent's `data` property. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_DIAL | |
*/ | |
Titanium.Android.ACTION_DIAL; | |
/** | |
* Provide editable access to the data specified by the Intent's `data` property. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_EDIT | |
*/ | |
Titanium.Android.ACTION_EDIT; | |
/** | |
* Allow the user to select a particular kind of data specified by the Intent's `type` property. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_GET_CONTENT | |
*/ | |
Titanium.Android.ACTION_GET_CONTENT; | |
/** | |
* GTalk connection has been established. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_GTALK_SERVICE_CONNECTED | |
*/ | |
Titanium.Android.ACTION_GTALK_SERVICE_CONNECTED; | |
/** | |
* GTalk connection has been disconnected. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_GTALK_SERVICE_DISCONNECTED | |
*/ | |
Titanium.Android.ACTION_GTALK_SERVICE_DISCONNECTED; | |
/** | |
* A wired headset has been plugged in or unplugged. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_HEADSET_PLUG | |
*/ | |
Titanium.Android.ACTION_HEADSET_PLUG; | |
/** | |
* An input method has been changed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_INPUT_METHOD_CHANGED | |
*/ | |
Titanium.Android.ACTION_INPUT_METHOD_CHANGED; | |
/** | |
* Insert an empty item into the given container. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_INSERT | |
*/ | |
Titanium.Android.ACTION_INSERT; | |
/** | |
* Pick an existing item or insert an empty item, then edit it. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_INSERT_OR_EDIT | |
*/ | |
Titanium.Android.ACTION_INSERT_OR_EDIT; | |
/** | |
* Start as the main entry point. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MAIN | |
*/ | |
Titanium.Android.ACTION_MAIN; | |
/** | |
* Indicates low memory condition notification acknowledged by user and package management should be started. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MANAGE_PACKAGE_STORAGE | |
*/ | |
Titanium.Android.ACTION_MANAGE_PACKAGE_STORAGE; | |
/** | |
* External media was removed from SD card slot, but mount point was not unmounted. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_BAD_REMOVAL | |
*/ | |
Titanium.Android.ACTION_MEDIA_BAD_REMOVAL; | |
/** | |
* The media button was pressed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_BUTTON | |
*/ | |
Titanium.Android.ACTION_MEDIA_BUTTON; | |
/** | |
* External media is present and being disk-checked. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_CHECKING | |
*/ | |
Titanium.Android.ACTION_MEDIA_CHECKING; | |
/** | |
* User has expressed the desire to remove the external storage media. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_EJECT | |
*/ | |
Titanium.Android.ACTION_MEDIA_EJECT; | |
/** | |
* External media is present and mounted at its mount point. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_MOUNTED | |
*/ | |
Titanium.Android.ACTION_MEDIA_MOUNTED; | |
/** | |
* External media is present, but is using an incompatible filesystem or is blank. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_NOFS | |
*/ | |
Titanium.Android.ACTION_MEDIA_NOFS; | |
/** | |
* External media has been removed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_REMOVED | |
*/ | |
Titanium.Android.ACTION_MEDIA_REMOVED; | |
/** | |
* The media scanner has finished scanning a directory. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_SCANNER_FINISHED | |
*/ | |
Titanium.Android.ACTION_MEDIA_SCANNER_FINISHED; | |
/** | |
* Request the media scanner to scan a file and add it to the media database. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_SCANNER_SCAN_FILE | |
*/ | |
Titanium.Android.ACTION_MEDIA_SCANNER_SCAN_FILE; | |
/** | |
* The media scanner has started scanning a directory. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_SCANNER_STARTED | |
*/ | |
Titanium.Android.ACTION_MEDIA_SCANNER_STARTED; | |
/** | |
* External media is unmounted because it is being shared via USB mass storage. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_SHARED | |
*/ | |
Titanium.Android.ACTION_MEDIA_SHARED; | |
/** | |
* Corresponds to the Android `Intent.ACTION_MEDIA_UNMOUNTABLE` constant. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_UNMOUNTABLE | |
*/ | |
Titanium.Android.ACTION_MEDIA_UNMOUNTABLE; | |
/** | |
* External media is present, but not mounted at its mount point. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_MEDIA_UNMOUNTED | |
*/ | |
Titanium.Android.ACTION_MEDIA_UNMOUNTED; | |
/** | |
* An outgoing call is about to be placed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_NEW_OUTGOING_CALL | |
*/ | |
Titanium.Android.ACTION_NEW_OUTGOING_CALL; | |
/** | |
* A new application package has been installed on the device. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PACKAGE_ADDED | |
*/ | |
Titanium.Android.ACTION_PACKAGE_ADDED; | |
/** | |
* An existing application package has been changed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PACKAGE_CHANGED | |
*/ | |
Titanium.Android.ACTION_PACKAGE_CHANGED; | |
/** | |
* The user has cleared the data of a package. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PACKAGE_DATA_CLEARED | |
*/ | |
Titanium.Android.ACTION_PACKAGE_DATA_CLEARED; | |
/** | |
* An existing application package has been removed from the device. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PACKAGE_REMOVED | |
*/ | |
Titanium.Android.ACTION_PACKAGE_REMOVED; | |
/** | |
* A new version of an application package has been installed, replacing an existing version that was previously installed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PACKAGE_REPLACED | |
*/ | |
Titanium.Android.ACTION_PACKAGE_REPLACED; | |
/** | |
* The user has restarted a package, and all of its processes have been killed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PACKAGE_RESTARTED | |
*/ | |
Titanium.Android.ACTION_PACKAGE_RESTARTED; | |
/** | |
* Pick an item from the directory indicated by the Intent's `data` property. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PICK | |
*/ | |
Titanium.Android.ACTION_PICK; | |
/** | |
* Pick an activity given an intent. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PICK_ACTIVITY | |
*/ | |
Titanium.Android.ACTION_PICK_ACTIVITY; | |
/** | |
* External power has been connected to the device. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_POWER_CONNECTED | |
*/ | |
Titanium.Android.ACTION_POWER_CONNECTED; | |
/** | |
* External power has been disconnected from the device. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_POWER_DISCONNECTED | |
*/ | |
Titanium.Android.ACTION_POWER_DISCONNECTED; | |
/** | |
* Show power usage information to the user. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_POWER_USAGE_SUMMARY | |
*/ | |
Titanium.Android.ACTION_POWER_USAGE_SUMMARY; | |
/** | |
* Content provider published new events or items. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_PROVIDER_CHANGED | |
*/ | |
Titanium.Android.ACTION_PROVIDER_CHANGED; | |
/** | |
* Device rebooted. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_REBOOT | |
*/ | |
Titanium.Android.ACTION_REBOOT; | |
/** | |
* Run the data. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_RUN | |
*/ | |
Titanium.Android.ACTION_RUN; | |
/** | |
* Sent when the device goes to sleep and becomes non-interactive. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SCREEN_OFF | |
*/ | |
Titanium.Android.ACTION_SCREEN_OFF; | |
/** | |
* Sent when the device wakes up and becomes interactive. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SCREEN_ON | |
*/ | |
Titanium.Android.ACTION_SCREEN_ON; | |
/** | |
* Perform a search. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SEARCH | |
*/ | |
Titanium.Android.ACTION_SEARCH; | |
/** | |
* Start action associated with long pressing on the search key. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SEARCH_LONG_PRESS | |
*/ | |
Titanium.Android.ACTION_SEARCH_LONG_PRESS; | |
/** | |
* Deliver data to another activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SEND | |
*/ | |
Titanium.Android.ACTION_SEND; | |
/** | |
* Deliver data to the recipient specified by the Intent's `data` property. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SENDTO | |
*/ | |
Titanium.Android.ACTION_SENDTO; | |
/** | |
* Deliver multiple data to another activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SEND_MULTIPLE | |
*/ | |
Titanium.Android.ACTION_SEND_MULTIPLE; | |
/** | |
* Show settings for choosing the system wallpaper. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SET_WALLPAPER | |
*/ | |
Titanium.Android.ACTION_SET_WALLPAPER; | |
/** | |
* Device is shutting down. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SHUTDOWN | |
*/ | |
Titanium.Android.ACTION_SHUTDOWN; | |
/** | |
* Perform data synchronization. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SYNC | |
*/ | |
Titanium.Android.ACTION_SYNC; | |
/** | |
* Start the platform-defined tutorial. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_SYSTEM_TUTORIAL | |
*/ | |
Titanium.Android.ACTION_SYSTEM_TUTORIAL; | |
/** | |
* The time was set. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_TIME_CHANGED | |
*/ | |
Titanium.Android.ACTION_TIME_CHANGED; | |
/** | |
* The current time changed. Sent every minute. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_TIME_TICK | |
*/ | |
Titanium.Android.ACTION_TIME_TICK; | |
/** | |
* A user ID was removed from the system. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_UID_REMOVED | |
*/ | |
Titanium.Android.ACTION_UID_REMOVED; | |
/** | |
* Sent when the user is present after device wakes up. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_USER_PRESENT | |
*/ | |
Titanium.Android.ACTION_USER_PRESENT; | |
/** | |
* Display data to the user. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_VIEW | |
*/ | |
Titanium.Android.ACTION_VIEW; | |
/** | |
* Start voice command. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_VOICE_COMMAND | |
*/ | |
Titanium.Android.ACTION_VOICE_COMMAND; | |
/** | |
* The current system wallpaper has changed. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_WALLPAPER_CHANGED | |
*/ | |
Titanium.Android.ACTION_WALLPAPER_CHANGED; | |
/** | |
* Perform a web search. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} ACTION_WEB_SEARCH | |
*/ | |
Titanium.Android.ACTION_WEB_SEARCH; | |
/** | |
* Set if the activity should be considered as an alternative action to the data the user is currently viewing. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_ALTERNATIVE | |
*/ | |
Titanium.Android.CATEGORY_ALTERNATIVE; | |
/** | |
* Activity can browse the Internet. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_BROWSABLE | |
*/ | |
Titanium.Android.CATEGORY_BROWSABLE; | |
/** | |
* Activity should be used as the default action to perform on a piece of data. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_DEFAULT | |
*/ | |
Titanium.Android.CATEGORY_DEFAULT; | |
/** | |
* Activity is in the development preference panel. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_DEVELOPMENT_PREFERENCE | |
*/ | |
Titanium.Android.CATEGORY_DEVELOPMENT_PREFERENCE; | |
/** | |
* Activity can run inside a parent activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_EMBED | |
*/ | |
Titanium.Android.CATEGORY_EMBED; | |
/** | |
* To be used as test code for framework instrumentation tests. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST | |
*/ | |
Titanium.Android.CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST; | |
/** | |
* Home activity, the first activity that is displayed when the device boots. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_HOME | |
*/ | |
Titanium.Android.CATEGORY_HOME; | |
/** | |
* Provides information about the package it is in. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_INFO | |
*/ | |
Titanium.Android.CATEGORY_INFO; | |
/** | |
* Activity is in the device's launcher. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_LAUNCHER | |
*/ | |
Titanium.Android.CATEGORY_LAUNCHER; | |
/** | |
* This activity may be exercised by the monkey or other automated test tools. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_MONKEY | |
*/ | |
Titanium.Android.CATEGORY_MONKEY; | |
/** | |
* Activity can open raw `file://` or `scheme://` URIs. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_OPENABLE | |
*/ | |
Titanium.Android.CATEGORY_OPENABLE; | |
/** | |
* This activity is a preference panel. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_PREFERENCE | |
*/ | |
Titanium.Android.CATEGORY_PREFERENCE; | |
/** | |
* To be used as a sample code example (not part of the normal user experience). | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_SAMPLE_CODE | |
*/ | |
Titanium.Android.CATEGORY_SAMPLE_CODE; | |
/** | |
* Activity should be considered as an alternative selection action to the data the user | |
* has currently selected. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_SELECTED_ALTERNATIVE | |
*/ | |
Titanium.Android.CATEGORY_SELECTED_ALTERNATIVE; | |
/** | |
* Activity to be used in a tab activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_TAB | |
*/ | |
Titanium.Android.CATEGORY_TAB; | |
/** | |
* To be used as a test (not part of the normal user experience). | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_TEST | |
*/ | |
Titanium.Android.CATEGORY_TEST; | |
/** | |
* To be used as a unit test (run through the Test Harness). | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} CATEGORY_UNIT_TEST | |
*/ | |
Titanium.Android.CATEGORY_UNIT_TEST; | |
/** | |
* Integer indicating how many pending alarms are being delivered with the intent. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_ALARM_COUNT | |
*/ | |
Titanium.Android.EXTRA_ALARM_COUNT; | |
/** | |
* String array containing e-mail addresses for blind carbon copying. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_BCC | |
*/ | |
Titanium.Android.EXTRA_BCC; | |
/** | |
* String array containing e-mail addresses for carbon copying. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_CC | |
*/ | |
Titanium.Android.EXTRA_CC; | |
/** | |
* Boolean indicating full uninstall (true) or partial uninstall (false). | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_DATA_REMOVED | |
*/ | |
Titanium.Android.EXTRA_DATA_REMOVED; | |
/** | |
* Boolean indicating to restart the application or not. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_DONT_KILL_APP | |
*/ | |
Titanium.Android.EXTRA_DONT_KILL_APP; | |
/** | |
* String array containing e-mail addresses. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_EMAIL | |
*/ | |
Titanium.Android.EXTRA_EMAIL; | |
/** | |
* An Intent describing the choices you would like shown. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_INTENT | |
*/ | |
Titanium.Android.EXTRA_INTENT; | |
/** | |
* A KeyEvent object containing the event that triggered the creation of the Intent it is in. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_KEY_EVENT | |
*/ | |
Titanium.Android.EXTRA_KEY_EVENT; | |
/** | |
* String holding the phone number to call or number that was called. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_PHONE_NUMBER | |
*/ | |
Titanium.Android.EXTRA_PHONE_NUMBER; | |
/** | |
* Boolean indicating if the package is being replaced. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_REPLACING | |
*/ | |
Titanium.Android.EXTRA_REPLACING; | |
/** | |
* Bitmap icon. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_SHORTCUT_ICON | |
*/ | |
Titanium.Android.EXTRA_SHORTCUT_ICON; | |
/** | |
* Resource of the shortcut. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_SHORTCUT_ICON_RESOURCE | |
*/ | |
Titanium.Android.EXTRA_SHORTCUT_ICON_RESOURCE; | |
/** | |
* Intent of a shortcut. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_SHORTCUT_INTENT | |
*/ | |
Titanium.Android.EXTRA_SHORTCUT_INTENT; | |
/** | |
* Name of the shortcut. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_SHORTCUT_NAME | |
*/ | |
Titanium.Android.EXTRA_SHORTCUT_NAME; | |
/** | |
* URI containing the stream data. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_STREAM | |
*/ | |
Titanium.Android.EXTRA_STREAM; | |
/** | |
* Subject line of a message. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_SUBJECT | |
*/ | |
Titanium.Android.EXTRA_SUBJECT; | |
/** | |
* Initial data to place in a newly created record. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_TEMPLATE | |
*/ | |
Titanium.Android.EXTRA_TEMPLATE; | |
/** | |
* Corresponds to the Android `Intent.EXTRA_TEXT` constant. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_TEXT | |
*/ | |
Titanium.Android.EXTRA_TEXT; | |
/** | |
* Corresponds to the Android `Intent.EXTRA_TITLE` constant. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_TITLE | |
*/ | |
Titanium.Android.EXTRA_TITLE; | |
/** | |
* UID of the assigned packaged. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} EXTRA_UID | |
*/ | |
Titanium.Android.EXTRA_UID; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FILL_IN_ACTION | |
*/ | |
Titanium.Android.FILL_IN_ACTION; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FILL_IN_CATEGORIES | |
*/ | |
Titanium.Android.FILL_IN_CATEGORIES; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FILL_IN_COMPONENT | |
*/ | |
Titanium.Android.FILL_IN_COMPONENT; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FILL_IN_DATA | |
*/ | |
Titanium.Android.FILL_IN_DATA; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FILL_IN_PACKAGE | |
*/ | |
Titanium.Android.FILL_IN_PACKAGE; | |
/** | |
* If activity is already running, bring it to the foreground. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_BROUGHT_TO_FRONT | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_BROUGHT_TO_FRONT; | |
/** | |
* If the activity is present, removes any activities on top of it to make it the foreground activity. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_CLEAR_TOP | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_CLEAR_TOP; | |
/** | |
* Corresponds to the Android `Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET` constant. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET; | |
/** | |
* Exclude the activity from recently launched activities. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS; | |
/** | |
* Return result to the original calling activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_FORWARD_RESULT | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_FORWARD_RESULT; | |
/** | |
* Activity was launched from history. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY; | |
/** | |
* Start the activity as a new task even if it exists. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_MULTIPLE_TASK | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_MULTIPLE_TASK; | |
/** | |
* Activity will be the start of a new task (collection of activities). | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_NEW_TASK | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_NEW_TASK; | |
/** | |
* Prevent transition animation. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_NO_ANIMATION | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_NO_ANIMATION; | |
/** | |
* Do not keep the activity in the history stack. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_NO_HISTORY | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_NO_HISTORY; | |
/** | |
* Disables the [onUserLeaveHint()](https://developer.android.com/reference/android/app/Activity.html#onUserLeaveHint()) callback. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_NO_USER_ACTION | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_NO_USER_ACTION; | |
/** | |
* Corresponds to the Android `Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP` constant. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_PREVIOUS_IS_TOP | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_PREVIOUS_IS_TOP; | |
/** | |
* If the activity already exists, place it at the top of the history stack. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_REORDER_TO_FRONT | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_REORDER_TO_FRONT; | |
/** | |
* If the task already exists, resets the task to its initial state. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_RESET_TASK_IF_NEEDED | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED; | |
/** | |
* Do not launch the activity if it is already running. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ACTIVITY_SINGLE_TOP | |
*/ | |
Titanium.Android.FLAG_ACTIVITY_SINGLE_TOP; | |
/** | |
* Enable a log message to print out the resolution of the intent. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_DEBUG_LOG_RESOLUTION | |
*/ | |
Titanium.Android.FLAG_DEBUG_LOG_RESOLUTION; | |
/** | |
* Indicates the intent is coming from a background operation. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_FROM_BACKGROUND | |
*/ | |
Titanium.Android.FLAG_FROM_BACKGROUND; | |
/** | |
* Grant read permission on the URI in the Intent's data or clipboard. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_GRANT_READ_URI_PERMISSION | |
*/ | |
Titanium.Android.FLAG_GRANT_READ_URI_PERMISSION; | |
/** | |
* Grants write permission on the URI in the Intent's data or clipboard. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_GRANT_WRITE_URI_PERMISSION | |
*/ | |
Titanium.Android.FLAG_GRANT_WRITE_URI_PERMISSION; | |
/** | |
* When sending a broadcast, only registered receivers will be called. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_RECEIVER_REGISTERED_ONLY | |
*/ | |
Titanium.Android.FLAG_RECEIVER_REGISTERED_ONLY; | |
/** | |
* Cancel the current pending intent before creating a new one. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_CANCEL_CURRENT | |
*/ | |
Titanium.Android.FLAG_CANCEL_CURRENT; | |
/** | |
* If the current intent does not exist, do not create it. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_NO_CREATE | |
*/ | |
Titanium.Android.FLAG_NO_CREATE; | |
/** | |
* The pending intent can only be used once. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ONE_SHOT | |
*/ | |
Titanium.Android.FLAG_ONE_SHOT; | |
/** | |
* If the current pending intent already exists, only update the current intent's extra data. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_UPDATE_CURRENT | |
*/ | |
Titanium.Android.FLAG_UPDATE_CURRENT; | |
/** | |
* Notification category indicating an alarm or timer. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_ALARM | |
*/ | |
Titanium.Android.CATEGORY_ALARM; | |
/** | |
* Notification category indicating an incoming call (voice or video) or similar synchronous | |
* communication request. | |
* | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_CALL | |
*/ | |
Titanium.Android.CATEGORY_CALL; | |
/** | |
* Notification category indicating an asynchronous bulk message (email). | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_EMAIL | |
*/ | |
Titanium.Android.CATEGORY_EMAIL; | |
/** | |
* Notification category indicating an error in background operation or authentication status. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_ERROR | |
*/ | |
Titanium.Android.CATEGORY_ERROR; | |
/** | |
* Notification category indicating a calendar event. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_EVENT | |
*/ | |
Titanium.Android.CATEGORY_EVENT; | |
/** | |
* Notification category indicating an incoming direct message (SMS, instant message, etc.). | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_MESSAGE | |
*/ | |
Titanium.Android.CATEGORY_MESSAGE; | |
/** | |
* Notification category indicating the progress of a long-running background operation. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_PROGRESS | |
*/ | |
Titanium.Android.CATEGORY_PROGRESS; | |
/** | |
* Notification category indicating a promotion or advertisement. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_PROMO | |
*/ | |
Titanium.Android.CATEGORY_PROMO; | |
/** | |
* Notification category indicating a specific, timely recommendation for a single thing. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_RECOMMENDATION | |
*/ | |
Titanium.Android.CATEGORY_RECOMMENDATION; | |
/** | |
* Notification category for a running background service. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_SERVICE | |
*/ | |
Titanium.Android.CATEGORY_SERVICE; | |
/** | |
* Notification category for a social network or sharing update. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_SOCIAL | |
*/ | |
Titanium.Android.CATEGORY_SOCIAL; | |
/** | |
* Notification category indicating ongoing information about device or contextual status. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_STATUS | |
*/ | |
Titanium.Android.CATEGORY_STATUS; | |
/** | |
* Notification category indicating media transport control for playback. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {String} CATEGORY_TRANSPORT | |
*/ | |
Titanium.Android.CATEGORY_TRANSPORT; | |
/** | |
* Use all default settings for a notification; see | |
* [Notification.defaults](Titanium.Android.Notification.defaults). | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_ALL | |
*/ | |
Titanium.Android.DEFAULT_ALL; | |
/** | |
* Use the default light settings for a notification; see | |
* [Notification.defaults](Titanium.Android.Notification.defaults). | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_LIGHTS | |
*/ | |
Titanium.Android.DEFAULT_LIGHTS; | |
/** | |
* Use the default sound settings for a notification; see | |
* [Notification.defaults](Titanium.Android.Notification.defaults). | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_SOUND | |
*/ | |
Titanium.Android.DEFAULT_SOUND; | |
/** | |
* Use the default vibration settings for a notification; see | |
* [Notification.defaults](Titanium.Android.Notification.defaults). | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_VIBRATE | |
*/ | |
Titanium.Android.DEFAULT_VIBRATE; | |
/** | |
* Cancel the notification when it is clicked by the user. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_AUTO_CANCEL | |
*/ | |
Titanium.Android.FLAG_AUTO_CANCEL; | |
/** | |
* Repeat audio until the notification is cancelled or the notification window | |
* is opened. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_INSISTENT | |
*/ | |
Titanium.Android.FLAG_INSISTENT; | |
/** | |
* Do not cancel the notification when the user clicks the Clear All button. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_NO_CLEAR | |
*/ | |
Titanium.Android.FLAG_NO_CLEAR; | |
/** | |
* Specifies that a notification is in reference to something that is ongoing, like a phone call. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ONGOING_EVENT | |
*/ | |
Titanium.Android.FLAG_ONGOING_EVENT; | |
/** | |
* Play an alert (sound, lights, and/or vibration) once each time the notification is sent, even if it has not been canceled before that. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ONLY_ALERT_ONCE | |
*/ | |
Titanium.Android.FLAG_ONLY_ALERT_ONCE; | |
/** | |
* Use LED lights to alert the user to the notification. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_SHOW_LIGHTS | |
*/ | |
Titanium.Android.FLAG_SHOW_LIGHTS; | |
/** | |
* Use for urgent or time-critical notifications, for example, turn-by-turn directions or | |
* emergency alerts. | |
* | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} PRIORITY_MAX | |
*/ | |
Titanium.Android.PRIORITY_MAX; | |
/** | |
* Use for high priority notifications like real-time chat messages. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} PRIORITY_HIGH | |
*/ | |
Titanium.Android.PRIORITY_HIGH; | |
/** | |
* Default priority if it does not fit into another priority category. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} PRIORITY_DEFAULT | |
*/ | |
Titanium.Android.PRIORITY_DEFAULT; | |
/** | |
* Use for low priority notifications like software updates. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} PRIORITY_LOW | |
*/ | |
Titanium.Android.PRIORITY_LOW; | |
/** | |
* Use for expired events. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} PRIORITY_MIN | |
*/ | |
Titanium.Android.PRIORITY_MIN; | |
/** | |
* Shows basic information about the notification. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_PRIVATE | |
*/ | |
Titanium.Android.VISIBILITY_PRIVATE; | |
/** | |
* Shows the notification's full content on the lockscreen. This is the system default if visibility is left unspecified. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_PUBLIC | |
*/ | |
Titanium.Android.VISIBILITY_PUBLIC; | |
/** | |
* Shows the most minimal information of the notification on the lockscreen. | |
* @since 3.6.0 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_SECRET | |
*/ | |
Titanium.Android.VISIBILITY_SECRET; | |
/** | |
* QuickSettings tile is unavailble. | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} TILE_STATE_UNAVAILABLE | |
*/ | |
Titanium.Android.TILE_STATE_UNAVAILABLE; | |
/** | |
* QuickSettings tile is inactive. | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} TILE_STATE_INACTIVE | |
*/ | |
Titanium.Android.TILE_STATE_INACTIVE; | |
/** | |
* QuickSettings tile is active. | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} TILE_STATE_ACTIVE | |
*/ | |
Titanium.Android.TILE_STATE_ACTIVE; | |
/** | |
* Ensures that the CPU is running; the screen and keyboard backlight will be allowed to go off. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} WAKE_LOCK_PARTIAL | |
*/ | |
Titanium.Android.WAKE_LOCK_PARTIAL; | |
/** | |
* Ensures that the screen and keyboard backlight are on at full brightness. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} WAKE_LOCK_FULL | |
*/ | |
Titanium.Android.WAKE_LOCK_FULL; | |
/** | |
* Ensures that the screen is on (but may be dimmed); the keyboard backlight will be allowed to go off. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} WAKE_LOCK_SCREEN_DIM | |
*/ | |
Titanium.Android.WAKE_LOCK_SCREEN_DIM; | |
/** | |
* Ensures that the screen is on at full brightness; the keyboard backlight will be allowed to go off. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} WAKE_LOCK_SCREEN_BRIGHT | |
*/ | |
Titanium.Android.WAKE_LOCK_SCREEN_BRIGHT; | |
/** | |
* Turn the screen on when the wake lock is acquired. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} WAKE_LOCK_ACQUIRE_CAUSES_WAKEUP | |
*/ | |
Titanium.Android.WAKE_LOCK_ACQUIRE_CAUSES_WAKEUP; | |
/** | |
* When this wake lock is released, poke the user activity timer so the screen stays on for a little longer. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} WAKE_LOCK_ON_AFTER_RELEASE | |
*/ | |
Titanium.Android.WAKE_LOCK_ON_AFTER_RELEASE; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} PENDING_INTENT_FOR_ACTIVITY | |
*/ | |
Titanium.Android.PENDING_INTENT_FOR_ACTIVITY; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} PENDING_INTENT_FOR_BROADCAST | |
*/ | |
Titanium.Android.PENDING_INTENT_FOR_BROADCAST; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} PENDING_INTENT_FOR_SERVICE | |
*/ | |
Titanium.Android.PENDING_INTENT_FOR_SERVICE; | |
/** | |
* Not used. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} PENDING_INTENT_MAX_VALUE | |
*/ | |
Titanium.Android.PENDING_INTENT_MAX_VALUE; | |
/** | |
* Accessor for Android system resources. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Titanium.Android.R} R | |
*/ | |
Titanium.Android.R; | |
/** | |
* Used with [setResult](Titanium.Android.Activity.setResult) to specify that | |
* an activity was canceled. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} RESULT_CANCELED | |
*/ | |
Titanium.Android.RESULT_CANCELED; | |
/** | |
* Used with [setResult](Titanium.Android.Activity.setResult) to specify a | |
* user-defined result. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} RESULT_FIRST_USER | |
*/ | |
Titanium.Android.RESULT_FIRST_USER; | |
/** | |
* Used with [setResult](Titanium.Android.Activity.setResult) to specify that | |
* an activity succeeded. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} RESULT_OK | |
*/ | |
Titanium.Android.RESULT_OK; | |
/** | |
* Use with [requestedOrientation](Titanium.Android.Activity.requestedOrientation) to | |
* specify the activity should run in the same orientation as the activity behind it | |
* in the activity stack. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} SCREEN_ORIENTATION_BEHIND | |
*/ | |
Titanium.Android.SCREEN_ORIENTATION_BEHIND; | |
/** | |
* Use with [requestedOrientation](Titanium.Android.Activity.requestedOrientation) to | |
* specify a landscape screen orientation. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} SCREEN_ORIENTATION_LANDSCAPE | |
*/ | |
Titanium.Android.SCREEN_ORIENTATION_LANDSCAPE; | |
/** | |
* Use with [requestedOrientation](Titanium.Android.Activity.requestedOrientation) to | |
* specify that the sensor should be ignored and the display should not rotate. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} SCREEN_ORIENTATION_NOSENSOR | |
*/ | |
Titanium.Android.SCREEN_ORIENTATION_NOSENSOR; | |
/** | |
* Use with [requestedOrientation](Titanium.Android.Activity.requestedOrientation) to | |
* specify a portrait screen orientation. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} SCREEN_ORIENTATION_PORTRAIT | |
*/ | |
Titanium.Android.SCREEN_ORIENTATION_PORTRAIT; | |
/** | |
* Use with [requestedOrientation](Titanium.Android.Activity.requestedOrientation) to | |
* specify that orientation should be determined by the orientation sensor. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} SCREEN_ORIENTATION_SENSOR | |
*/ | |
Titanium.Android.SCREEN_ORIENTATION_SENSOR; | |
/** | |
* Use with [requestedOrientation](Titanium.Android.Activity.requestedOrientation) to | |
* specify that the system should use its default rules for determining the best | |
* orientation. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} SCREEN_ORIENTATION_UNSPECIFIED | |
*/ | |
Titanium.Android.SCREEN_ORIENTATION_UNSPECIFIED; | |
/** | |
* Use with [requestedOrientation](Titanium.Android.Activity.requestedOrientation) to | |
* specify that the system should use the user's preferred orientation. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} SCREEN_ORIENTATION_USER | |
*/ | |
Titanium.Android.SCREEN_ORIENTATION_USER; | |
/** | |
* Always show this item as an action button in the action bar. | |
* @since 3.0.0 (Android) | |
* @readonly | |
* @type {Number} SHOW_AS_ACTION_ALWAYS | |
*/ | |
Titanium.Android.SHOW_AS_ACTION_ALWAYS; | |
/** | |
* The action view can collapse to a normal menu item. | |
* @since 3.0.0 (Android) | |
* @readonly | |
* @type {Number} SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW | |
*/ | |
Titanium.Android.SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW; | |
/** | |
* Show this item as an action button if the system decides there is room for it. | |
* | |
* @since 3.0.0 (Android) | |
* @readonly | |
* @type {Number} SHOW_AS_ACTION_IF_ROOM | |
*/ | |
Titanium.Android.SHOW_AS_ACTION_IF_ROOM; | |
/** | |
* Never display this item as an action button in the action bar. | |
* @since 3.0.0 (Android) | |
* @readonly | |
* @type {Number} SHOW_AS_ACTION_NEVER | |
*/ | |
Titanium.Android.SHOW_AS_ACTION_NEVER; | |
/** | |
* When this item is in the action bar, always show it with a text label. | |
* @since 3.0.0 (Android) | |
* @readonly | |
* @type {Number} SHOW_AS_ACTION_WITH_TEXT | |
*/ | |
Titanium.Android.SHOW_AS_ACTION_WITH_TEXT; | |
/** | |
* Standard Action Bar navigation mode. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} NAVIGATION_MODE_STANDARD | |
*/ | |
Titanium.Android.NAVIGATION_MODE_STANDARD; | |
/** | |
* Action Bar tab navigation mode. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} NAVIGATION_MODE_TABS | |
*/ | |
Titanium.Android.NAVIGATION_MODE_TABS; | |
/** | |
* A Service start mode indicating that if the host application is stopped by Android, the service should not be restarted automatically. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} START_NOT_STICKY | |
*/ | |
Titanium.Android.START_NOT_STICKY; | |
/** | |
* A Service start mode indicating that if the host application is stopped by Android, the service should be restarted automatically and the original Intent re-sent. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} START_REDELIVER_INTENT | |
*/ | |
Titanium.Android.START_REDELIVER_INTENT; | |
/** | |
* Use with [audioStreamType](Titanium.Android.Notification.audioStreamType) to | |
* request that the alarm stream type for notifications be used. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_ALARM | |
*/ | |
Titanium.Android.STREAM_ALARM; | |
/** | |
* Use with [audioStreamType](Titanium.Android.Notification.audioStreamType) to request that the | |
* default stream type for notifications be used. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_DEFAULT | |
*/ | |
Titanium.Android.STREAM_DEFAULT; | |
/** | |
* Use with [audioStreamType](Titanium.Android.Notification.audioStreamType) to | |
* request that the music stream type for notifications be used. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_MUSIC | |
*/ | |
Titanium.Android.STREAM_MUSIC; | |
/** | |
* Use with [audioStreamType](Titanium.Android.Notification.audioStreamType) to request that the | |
* notification stream type for notifications be used. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_NOTIFICATION | |
*/ | |
Titanium.Android.STREAM_NOTIFICATION; | |
/** | |
* Use with [audioStreamType](Titanium.Android.Notification.audioStreamType) to request that the | |
* ring stream type for notifications be used. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_RING | |
*/ | |
Titanium.Android.STREAM_RING; | |
/** | |
* Use with [audioStreamType](Titanium.Android.Notification.audioStreamType) to request that the | |
* system stream type for notifications be used. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_SYSTEM | |
*/ | |
Titanium.Android.STREAM_SYSTEM; | |
/** | |
* Use with [audioStreamType](Titanium.Android.Notification.audioStreamType) to request that the | |
* voice call stream type for notifications be used. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_VOICE_CALL | |
*/ | |
Titanium.Android.STREAM_VOICE_CALL; | |
/** | |
* The URI scheme used for intent URIs. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} URI_INTENT_SCHEME | |
*/ | |
Titanium.Android.URI_INTENT_SCHEME; | |
/** | |
* Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level. | |
* | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} IMPORTANCE_DEFAULT | |
*/ | |
Titanium.Android.IMPORTANCE_DEFAULT; | |
/** | |
* Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level. | |
* | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} IMPORTANCE_HIGH | |
*/ | |
Titanium.Android.IMPORTANCE_HIGH; | |
/** | |
* Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level. | |
* | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} IMPORTANCE_LOW | |
*/ | |
Titanium.Android.IMPORTANCE_LOW; | |
/** | |
* Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level. | |
* | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} IMPORTANCE_MAX | |
*/ | |
Titanium.Android.IMPORTANCE_MAX; | |
/** | |
* Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level. | |
* | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} IMPORTANCE_MIN | |
*/ | |
Titanium.Android.IMPORTANCE_MIN; | |
/** | |
* Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level. | |
* | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} IMPORTANCE_NONE | |
*/ | |
Titanium.Android.IMPORTANCE_NONE; | |
/** | |
* Used with [NotificationChannel](Titanium.Android.NotificationChannel) to specify an importance level. | |
* | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {Number} IMPORTANCE_UNSPECIFIED | |
*/ | |
Titanium.Android.IMPORTANCE_UNSPECIFIED; | |
/** | |
* References the top-most window's activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Titanium.Android.Activity} currentActivity | |
*/ | |
Titanium.Android.prototype.currentActivity; | |
/** | |
* Service in the active context. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Titanium.Android.Service} currentService | |
*/ | |
Titanium.Android.prototype.currentService; | |
/** | |
* The first activity launched by the application. | |
* @since 8.0.0 (Android) | |
* @readonly | |
* @type {Titanium.Android.Activity} rootActivity | |
*/ | |
Titanium.Android.prototype.rootActivity; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.applyProperties = function(props) {}; | |
/** | |
* Creates an activity chooser intent, used to allow the user to select a target activity | |
* for an intent. | |
* | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent The intent to display a chooser for. | |
* @param {String} title Title to display on the chooser. | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.Android.createIntentChooser = function(intent, title) {}; | |
/** | |
* Creates a [PendingIntent](Titanium.Android.PendingIntent) to be used inside a | |
* [Notification](Titanium.Android.Notification). | |
* | |
* @since 1.5 (Android) | |
* @param {Titanium.Android._Dictionary_PendingIntent=} parameters Properties to set on the new object, including any defined by | |
* <Titanium.Android.PendingIntent>, except those marked not-creation or read-only. | |
* | |
* @return {Titanium.Android.PendingIntent} | |
*/ | |
Titanium.Android.createPendingIntent = function(parameters) {}; | |
/** | |
* Create a <Titanium.Android.Service> so you can start/stop it and listen for events from it. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent An `Intent` created with [createServiceIntent](Titanium.Android.createServiceIntent), | |
* which specifies the service to be instantiated. | |
* | |
* @return {Titanium.Android.Service} | |
*/ | |
Titanium.Android.createService = function(intent) {}; | |
/** | |
* Create an `Intent` to be used to start a service. | |
* @since 1.5 (Android) | |
* @param {ServiceIntentOptions} options Options for the Service. | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.Android.createServiceIntent = function(options) {}; | |
/** | |
* Creates a [DrawerLayout](Titanium.UI.Android.DrawerLayout). | |
* @since 6.2.0 (Android) | |
* @param {Titanium.UI.Android._Dictionary_DrawerLayout=} parameters Properties to set on the new object, including any defined by | |
* <Titanium.UI.Android.DrawerLayout>, except those marked not-creation or read-only. | |
* | |
* @return {Titanium.UI.Android.DrawerLayout} | |
*/ | |
Titanium.Android.createDrawerLayout = function(parameters) {}; | |
/** | |
* Returns `true` if the app has permission access. | |
* @since 5.4.0 (Android) | |
* @param {String|Array<String>} permission The permission to check for access. This can be any of the constants listed here | |
* with dangerous protection level [here](https://developer.android.com/reference/android/Manifest.permission.html). | |
* For example, `android.permission.WRITE_CONTACTS`. | |
* | |
* Since Titanium 6.1.0, the method will also accept `Array<String>` | |
* | |
* @return {Boolean} | |
*/ | |
Titanium.Android.hasPermission = function(permission) {}; | |
/** | |
* Request for permission access. | |
* @since 5.4.0 (Android) | |
* @param {String|Array<String>} permissions The permission(s) to request for access. This can be any of the constants listed here | |
* with dangerous protection level [here](https://developer.android.com/reference/android/Manifest.permission.html). | |
* Normal protection permissions are automatically enabled if they are included in the manifest. An example of a | |
* dangerous protection permission would be `android.permission.WRITE_CONTACTS`. | |
* The requested permission(s) MUST also be included in the Android Manifest. | |
* | |
* Besides this, there are also requestPermission methods that are ready for commonly used situations. These methods are | |
* <Titanium.Calendar.requestCalendarPermissions>, <Titanium.Contacts.requestContactsPermissions>, | |
* <Titanium.Filesystem.requestStoragePermissions>, <Titanium.Geolocation.requestLocationPermissions> and <Titanium.Media.requestCameraPermissions>. | |
* | |
* Since Titanium 6.1.0, the method will also accept a String. Any requests where permissions are already granted will yield a successful callback. | |
* | |
* @param {Callback<RequestPermissionAccessResult>=} callback Function to call upon user decision to grant access. | |
*/ | |
Titanium.Android.requestPermissions = function(permissions, callback) {}; | |
/** | |
* Check on state of Service. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent An `Intent` created with [createServiceIntent](Titanium.Android.createServiceIntent), | |
* which specifies the service to check. | |
* | |
* @return {Boolean} | |
*/ | |
Titanium.Android.isServiceRunning = function(intent) {}; | |
/** | |
* Registers broadcast receiver for the given actions. | |
* @since 3.1.0 (Android) | |
* @param {Titanium.Android.BroadcastReceiver} broadcastReceiver The broadcast receiver to register and handle the broadcast. | |
* | |
* @param {Array<String>} actions The actions that the broadcast reciever will handle | |
* | |
*/ | |
Titanium.Android.registerBroadcastReceiver = function(broadcastReceiver, actions) {}; | |
/** | |
* Unregisters a broadcast receiver. | |
* @since 3.1.0 (Android) | |
* @param {Titanium.Android.BroadcastReceiver} broadcastReceiver The broadcast receiver to unregister. | |
* | |
*/ | |
Titanium.Android.unregisterBroadcastReceiver = function(broadcastReceiver) {}; | |
/** | |
* Starts a simple service. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent An `Intent` created with [createServiceIntent](Titanium.Android.createServiceIntent), | |
* which specifies the service to start. | |
* | |
*/ | |
Titanium.Android.startService = function(intent) {}; | |
/** | |
* Stop a simple service that was started with `startService`. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent An `Intent` created with [createServiceIntent](Titanium.Android.createServiceIntent), | |
* which specifies the service to stop. | |
* | |
*/ | |
Titanium.Android.stopService = function(intent) {}; | |
/** | |
* Create an `Intent` to be used in a broadcast. | |
* @since 3.2.0 (Android) | |
* @param {Titanium.Android._Dictionary_Intent=} parameters Properties to set on the new object, including any defined by | |
* <Titanium.Android.Intent>, except those marked not-creation or read-only. | |
* | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.Android.createBroadcastIntent = function(parameters) {}; | |
/** | |
* Gets the value of the <Titanium.Android.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.BigPictureStyle>. | |
* | |
* @since 5.4.0 (Android) | |
* @param {Titanium.Android._Dictionary_BigPictureStyle=} parameters Properties to set on a new object, including any defined by <Titanium.Android.BigPictureStyle> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createBigPictureStyle = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.BigTextStyle>. | |
* | |
* @since 5.4.0 (Android) | |
* @param {Titanium.Android._Dictionary_BigTextStyle=} parameters Properties to set on a new object, including any defined by <Titanium.Android.BigTextStyle> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createBigTextStyle = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.BroadcastReceiver>. | |
* | |
* @since 3.1.0 (Android) | |
* @param {Titanium.Android._Dictionary_BroadcastReceiver=} parameters Properties to set on a new object, including any defined by <Titanium.Android.BroadcastReceiver> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createBroadcastReceiver = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.Intent>. | |
* | |
* @since 1.5 (Android) | |
* @param {Titanium.Android._Dictionary_Intent=} parameters Properties to set on a new object, including any defined by <Titanium.Android.Intent> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createIntent = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.Notification>. | |
* | |
* @since 1.5 (Android) | |
* @param {Titanium.Android._Dictionary_Notification=} parameters Properties to set on a new object, including any defined by <Titanium.Android.Notification> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createNotification = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.NotificationChannel>. | |
* | |
* @since 7.0.0 (Android) | |
* @param {Titanium.Android._Dictionary_NotificationChannel=} parameters Properties to set on a new object, including any defined by <Titanium.Android.NotificationChannel> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createNotificationChannel = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.QuickSettingsService>. | |
* | |
* @since 7.0 (Android) | |
* @param {Titanium.Android._Dictionary_QuickSettingsService=} parameters Properties to set on a new object, including any defined by <Titanium.Android.QuickSettingsService> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createQuickSettingsService = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Android.RemoteViews>. | |
* | |
* @since 1.6 (Android) | |
* @param {Titanium.Android._Dictionary_RemoteViews=} parameters Properties to set on a new object, including any defined by <Titanium.Android.RemoteViews> except those marked not-creation or read-only. | |
* | |
*/ | |
Titanium.Android.createRemoteViews = function(parameters) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_Android; | |
/** | |
* An action bar is a window feature that identifies the application and user location, | |
* and provides user actions and navigation modes. | |
* | |
* @extends {Titanium.Proxy} | |
* @description Starting with Release 3.3.0, the Titanium SDK uses the appcompat library to provide support for | |
* the action bar, including devices running Android 2.3.x and prior. If you are using a release earlier | |
* than 3.3.0, refer to the _Applicaton Note_ below for additional information. | |
* | |
* You can add action items to the action bar by defining an Android menu and setting the | |
* menu items to display as action items. See [Menu](Titanium.Android.Menu) and | |
* [MenuItem](Titanium.Android.MenuItem) for details. | |
* | |
* In JavaScript, wait for the window or tab group's `open` event before accessing | |
* the action bar from the window or tab group's [activity](Titanium.Android.Activity). | |
* | |
* Note that setting the [Window.navBarHidden](Titanium.UI.Window.navBarHidden) property | |
* to true disables the Action Bar since it is part of the navigation title bar. | |
* | |
* For more examples on using the Action Bar, refer to the | |
* [Android Action Bar guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Action_Bar). | |
* | |
* #### Application Notes for Alloy | |
* | |
* Starting with Alloy 1.5.0, you can add ActionBar attributes to the `ActionBar` element. | |
* To use the action bar, add the `<ActionBar>` tag as a child of either a | |
* a `<Window>` or `<TabGroup>`, then set ActionBar attributes in either the XML or TSS file. | |
* | |
* Starting with Alloy 1.4.0, you can also add ActionBar attributes to the `Menu` element. | |
* Do not define ActionBar attributes in both the `ActionBar` and `Menu` elements. Only define the | |
* attributes in one element. | |
* | |
* To add action items to the action bar, add the `<Menu>` tag as a child of either | |
* a `<Window>` or `<TabGroup>`, then add `<MenuItem>` tags as children of the `<Menu>` tag. | |
* Set MenuItem attributes in either the XML or TSS file. | |
* | |
* For an example of using the Action Bar with Alloy, see "Action Bar using Alloy XML Markup" below. | |
* | |
* #### Action Bar Icon | |
* | |
* Starting with Release 4.0, due to the requirement that the target SDK must be set to Android 5.0 | |
* (API level 21) or higher, the action bar icon may not display. Google is discouraging | |
* the use of icons in toolbars: | |
* | |
* In modern Android UIs developers should lean more on a visually distinct color scheme for toolbars | |
* than on their application icon. The use of application icon plus title as a standard layout is | |
* discouraged on API 21 devices and newer. | |
* | |
* Source: [Android Developer: Toolbar API reference](https://developer.android.com/reference/android/support/v7/widget/Toolbar.html) | |
* | |
* #### Application Note for Release 3.2.x and earlier | |
* | |
* If you are using Release 3.2.x or earlier, this feature is only available in Android 3.0 | |
* (API level 11) and above. | |
* | |
* To access the action bar, you must first open a heavyweight window or tab group that | |
* uses one of the action bar themes (such as the Android Holo theme). | |
* | |
* @since 3.0 (Android) | |
*/ | |
Titanium.Android.ActionBar = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.ActionBar.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.ActionBar.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.ActionBar.prototype.lifecycleContainer; | |
/** | |
* The background image for the action bar, specified as a local file path or URL. | |
* @since 3.0 (Android) | |
* @type {String} backgroundImage | |
*/ | |
Titanium.Android.ActionBar.prototype.backgroundImage; | |
/** | |
* Displays an "up" affordance on the "home" area of the action bar. | |
* @since 3.0 (Android) | |
* @type {Boolean} displayHomeAsUp | |
*/ | |
Titanium.Android.ActionBar.prototype.displayHomeAsUp; | |
/** | |
* Enable or disable the "home" button in the corner of the action bar. | |
* @since 3.3.0 (Android) | |
* @type {Boolean} homeButtonEnabled | |
*/ | |
Titanium.Android.ActionBar.prototype.homeButtonEnabled; | |
/** | |
* Sets the application icon displayed in the "home" area of the action bar, specified as a local file path or URL. | |
* @since 3.0 (Android) | |
* @type {String} icon | |
*/ | |
Titanium.Android.ActionBar.prototype.icon; | |
/** | |
* Sets the application logo displayed in the "home" area of the action bar, specified as a local file path or URL. | |
* @since 3.0 (Android) | |
* @type {String} logo | |
*/ | |
Titanium.Android.ActionBar.prototype.logo; | |
/** | |
* Controls the navigation mode. | |
* @since 3.0 (Android) | |
* @type {Number} navigationMode | |
*/ | |
Titanium.Android.ActionBar.prototype.navigationMode; | |
/** | |
* Callback function called when the home icon is clicked. | |
* @since 3.0 (Android) | |
* @type {Callback} onHomeIconItemSelected | |
*/ | |
Titanium.Android.ActionBar.prototype.onHomeIconItemSelected; | |
/** | |
* Sets the subtitle of the action bar. | |
* @since 3.2.3 (Android) | |
* @type {String} subtitle | |
*/ | |
Titanium.Android.ActionBar.prototype.subtitle; | |
/** | |
* Sets the title of the action bar. | |
* @since 3.0 (Android) | |
* @type {String} title | |
*/ | |
Titanium.Android.ActionBar.prototype.title; | |
/** | |
* Sets a view to be used for a custom navigation mode. | |
* @since 7.1.0 (Android) | |
* @type {Titanium.UI.View} customView | |
*/ | |
Titanium.Android.ActionBar.prototype.customView; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.ActionBar.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.ActionBar.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.ActionBar.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.ActionBar.applyProperties = function(props) {}; | |
/** | |
* Hides the action bar if it is currently showing. | |
* @since 3.0 (Android) | |
*/ | |
Titanium.Android.ActionBar.hide = function() {}; | |
/** | |
* Shows or hides the action bar home icon | |
* @since 3.3.0 (Android) | |
* @param {Boolean} show Boolean to show or hide action bar home icon | |
*/ | |
Titanium.Android.ActionBar.setDisplayShowHomeEnabled = function(show) {}; | |
/** | |
* Shows or hides the action bar title/subtitle | |
* @since 3.3.0 (Android) | |
* @param {Boolean} show Boolean to show or hide action bar title/subtitle | |
*/ | |
Titanium.Android.ActionBar.setDisplayShowTitleEnabled = function(show) {}; | |
/** | |
* Set an alternate description for the Home/Up action, when enabled. | |
* @since 8.0.0 (Android) | |
* @param {String} description New description for the Home action when enabled | |
*/ | |
Titanium.Android.ActionBar.setHomeActionContentDescription = function(description) {}; | |
/** | |
* Shows the action bar if it is currently hidden. | |
* @since 3.0 (Android) | |
*/ | |
Titanium.Android.ActionBar.show = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.ActionBar.bubbleParent> property. | |
* @since 3.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.ActionBar.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.bubbleParent> property. | |
* @since 3.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.ActionBar.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.ActionBar.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.ActionBar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.ActionBar.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.backgroundImage> property. | |
* @since 3.0 (Android) | |
* @param {String} backgroundImage New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setBackgroundImage = function(backgroundImage) {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.displayHomeAsUp> property. | |
* @since 3.0 (Android) | |
* @param {Boolean} displayHomeAsUp New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setDisplayHomeAsUp = function(displayHomeAsUp) {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.homeButtonEnabled> property. | |
* @since 3.3.0 (Android) | |
* @param {Boolean} homeButtonEnabled New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setHomeButtonEnabled = function(homeButtonEnabled) {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.icon> property. | |
* @since 3.0 (Android) | |
* @param {String} icon New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setIcon = function(icon) {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.logo> property. | |
* @since 3.0 (Android) | |
* @param {String} logo New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setLogo = function(logo) {}; | |
/** | |
* Gets the value of the <Titanium.Android.ActionBar.navigationMode> property. | |
* @since 3.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.ActionBar.getNavigationMode = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.navigationMode> property. | |
* @since 3.0 (Android) | |
* @param {Number} navigationMode New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setNavigationMode = function(navigationMode) {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.onHomeIconItemSelected> property. | |
* @since 3.0 (Android) | |
* @param {Callback} onHomeIconItemSelected New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setOnHomeIconItemSelected = function(onHomeIconItemSelected) {}; | |
/** | |
* Gets the value of the <Titanium.Android.ActionBar.subtitle> property. | |
* @since 3.2.3 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.ActionBar.getSubtitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.subtitle> property. | |
* @since 3.2.3 (Android) | |
* @param {String} subtitle New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setSubtitle = function(subtitle) {}; | |
/** | |
* Gets the value of the <Titanium.Android.ActionBar.title> property. | |
* @since 3.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.ActionBar.getTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.title> property. | |
* @since 3.0 (Android) | |
* @param {String} title New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setTitle = function(title) {}; | |
/** | |
* Gets the value of the <Titanium.Android.ActionBar.customView> property. | |
* @since 7.1.0 (Android) | |
* @return {Titanium.UI.View} | |
*/ | |
Titanium.Android.ActionBar.getCustomView = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.ActionBar.customView> property. | |
* @since 7.1.0 (Android) | |
* @param {Titanium.UI.View} customView New value for the property. | |
*/ | |
Titanium.Android.ActionBar.setCustomView = function(customView) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* backgroundImage: String, | |
* displayHomeAsUp: Boolean, | |
* homeButtonEnabled: Boolean, | |
* icon: String, | |
* logo: String, | |
* navigationMode: Number, | |
* onHomeIconItemSelected: Callback, | |
* subtitle: String, | |
* title: String, | |
* customView: Titanium.UI.View | |
* }} | |
*/ | |
Titanium.Android._Dictionary_ActionBar; | |
/** | |
* The Titanium binding of an Android Activity. | |
* @extends {Titanium.Proxy} | |
* @description According to the Android API Reference, an activity is "a single, focused thing that a | |
* user can do." | |
* | |
* In almost all cases, an activity is associated with a window. Activities are central | |
* to the Android **Back** button navigation -- the **Back** button closes the current | |
* activity and returns to whatever activity was open previously. | |
* | |
* In Titanium, the Android Activity is not created until a window or tab group is opened. | |
* After a Window or TabGroup object is created but before it is opened, its `activity` property | |
* refers to an empty JavaScript object. You can use it to set properties on the activity, such as | |
* the `onCreateOptionsMenu` property, but you cannot invoke any Activity methods. | |
* | |
* After the window or tab group opens, a real Activity object is created and the properties from | |
* the JavaScript object are copied over. The `activity` property now refers to this real Activity object, | |
* which you can use to call the various Activity methods. For example, to use the | |
* `invalidateOptionsMenu` method, you need to get the activity after the window or tab group opens. | |
* | |
* See also [android.app.Activity](https://developer.android.com/reference/android/app/Activity.html) | |
* in the Android API Reference. | |
* | |
* #### Activity Lifecycle | |
* | |
* In Android, activities are created, started, resumed, paused, stopped, destroyed and restarted. | |
* Titanium generates lifecycle events for activities but does not generate application-level events. | |
* To be notified when an activity's lifecycle event is triggered, assign callbacks to the following activity | |
* properties: | |
* | |
* * [onCreate](Titanium.Android.Activity.onCreate) | |
* * [onStart](Titanium.Android.Activity.onStart) | |
* * [onResume](Titanium.Android.Activity.onResume) | |
* * [onPause](Titanium.Android.Activity.onPause) | |
* * [onStop](Titanium.Android.Activity.onStop) | |
* * [onDestroy](Titanium.Android.Activity.onDestroy) | |
* * [onRestart](Titanium.Android.Activity.onRestart) | |
* | |
* See also the "Understand the Lifecycle Callbacks" section in | |
* [Android Developers: Activity Lifecycle](https://developer.android.com/training/basics/activity-lifecycle/starting.html). | |
* | |
* #### Don't keep activities option | |
* | |
* Android 4.0 and greater devices have an option called **Don't keep activities** under the **Developer | |
* Options** menu. When this option is enabled, the Android OS will destroy an activity as soon as it | |
* is stopped. It is intended to help developers debug their apps. For example, it can simulate the | |
* case that Android will kill an activity in the background due to memory pressure. In | |
* normal use, it is not recommended to turn this option on because this may lead to unexpected issues | |
* on the apps, such as freezes, force closes and reboots. | |
* | |
* When the **Don't keep activities** option is enabled, the lifecycle of the activity is different | |
* from the normal case. Whenever the user leaves an activity, such as backgrounding the app using the | |
* HOME button, this activity is destroyed by Android, which calls `onDestroy`. In the normal case, `onStop` | |
* would be called and the activity would not be destroyed. Later, when the user goes back to that activity, this | |
* activity will be recreated, which calls `onCreate`. In the normal case, since the activity is not destroyed, | |
* `onRestart` would be called instead. Therefore, some events, such as the open and close events on the Window | |
* or TabGroup, will be fired differently from the normal case, and the root window of the app must set | |
* [exitOnClose](Titanium.UI.Window.exitOnClose) to true; otherwise, the app will be unable to back out, that is, | |
* hitting the BACK button in the root window will not allow the application to exit. | |
* | |
* #### Deprecated Behavior | |
* | |
* Prior to Release 8.0.0, you would set the below "tiapp.xml" property to `true` to handle the case | |
* where the Android OS would automatically close all child activity windows after the app has been backgrounded | |
* for about 30 minutes, bringing the app back to the root splash screen activity window. The below property | |
* would restart your app's UI in this case. This is no longer needed in 8.0.0 since Titanium now sets the | |
* "AndroidManifest.xml" setting | |
* [android:alwaysRetainTaskState](https://developer.android.com/guide/topics/manifest/activity-element#always) | |
* to the root activity instead | |
* | |
* <property name="ti.android.root.reappears.restart" type="bool">true</property> | |
* | |
* Prior to Release 3.4.0, to monitor lifecycle events, use the activity's events, `create`, `destroy`, | |
* `pause`, `resume`, `start` and `stop`, to be notified when an activity is created, destroyed, paused, | |
* resumed, started and stopped, respectively. | |
* | |
* You can only set Activity properties from a TabGroup object after the tab group opens. | |
* | |
* Prior to Release 3.2.0, you can create either a "lightweight" or "heavyweight" window, as | |
* described on the <Titanium.UI.Window> reference page. A *heavyweight* window creates a | |
* new `Activity`. A *lightweight* window runs inside the same activity as the code that | |
* created it. If you try to reference the activity of lightweight window, it returns undefined. | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Activity = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Activity.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Activity.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Activity.prototype.lifecycleContainer; | |
/** | |
* The action bar for this activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Titanium.Android.ActionBar} actionBar | |
*/ | |
Titanium.Android.Activity.prototype.actionBar; | |
/** | |
* The last `Intent` received by this activity. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Titanium.Android.Intent} intent | |
*/ | |
Titanium.Android.Activity.prototype.intent; | |
/** | |
* Callback function called when the Android activity is created. | |
* | |
* @since 3.4.0 (Android) | |
* @type {Callback<Object>} onCreate | |
*/ | |
Titanium.Android.Activity.prototype.onCreate; | |
/** | |
* Callback function called to initially create an Android options menu | |
* for this Activity when the user presses the **Menu** button. | |
* | |
* @since 1.5 (Android) | |
* @type {Callback<Object>} onCreateOptionsMenu | |
*/ | |
Titanium.Android.Activity.prototype.onCreateOptionsMenu; | |
/** | |
* Callback function called when the Android activity is destroyed. | |
* | |
* @since 3.4.0 (Android) | |
* @type {Callback<Object>} onDestroy | |
*/ | |
Titanium.Android.Activity.prototype.onDestroy; | |
/** | |
* Callback function called when the Android activity is paused. | |
* | |
* @since 3.4.0 (Android) | |
* @type {Callback<Object>} onPause | |
*/ | |
Titanium.Android.Activity.prototype.onPause; | |
/** | |
* Callback function called to prepare an options menu for display when the user presses | |
* the **Menu** button. | |
* | |
* @since 1.5 (Android) | |
* @type {Callback<Object>} onPrepareOptionsMenu | |
*/ | |
Titanium.Android.Activity.prototype.onPrepareOptionsMenu; | |
/** | |
* Callback function called when the Android activity is restarted. | |
* | |
* @since 3.4.0 (Android) | |
* @type {Callback<Object>} onRestart | |
*/ | |
Titanium.Android.Activity.prototype.onRestart; | |
/** | |
* Callback function called when the Android activity is resumed. | |
* | |
* @since 3.4.0 (Android) | |
* @type {Callback<Object>} onResume | |
*/ | |
Titanium.Android.Activity.prototype.onResume; | |
/** | |
* Callback function called when the Android activity is started. | |
* | |
* @since 3.4.0 (Android) | |
* @type {Callback<Object>} onStart | |
*/ | |
Titanium.Android.Activity.prototype.onStart; | |
/** | |
* Callback function called when the Android activity is stopped. | |
* | |
* @since 3.4.0 (Android) | |
* @type {Callback<Object>} onStop | |
*/ | |
Titanium.Android.Activity.prototype.onStop; | |
/** | |
* Specifies a specific orientation for this activity. | |
* @since 1.5 (Android) | |
* @type {Number} requestedOrientation | |
*/ | |
Titanium.Android.Activity.prototype.requestedOrientation; | |
/** | |
* Toolbar instance that serves as ActionBar | |
* @since 6.2.0 (Android) | |
* @type {Titanium.UI.Toolbar} supportToolbar | |
*/ | |
Titanium.Android.Activity.prototype.supportToolbar; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Activity.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Activity.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Activity.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Activity.applyProperties = function(props) {}; | |
/** | |
* Closes this activity. | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Activity.finish = function() {}; | |
/** | |
* Gets an Android or Application string using the specified Resource ID and optional format arguments. | |
* @since 1.5 (Android) | |
* @param {Number} resourceId Resource ID from the Application or Android. | |
* @param {Object} format Optional format arguments for the String resource. May be repeated. | |
* @return {String} | |
*/ | |
Titanium.Android.Activity.getString = function(resourceId, format) {}; | |
/** | |
* Declares that the option menu has changed and should be recreated. | |
* @since 3.0.0 (Android) | |
*/ | |
Titanium.Android.Activity.invalidateOptionsMenu = function() {}; | |
/** | |
* Sets the requested Activity orientation. | |
* @since 1.5 (Android) | |
* @param {Number} orientation Orientation mode for the activity. | |
*/ | |
Titanium.Android.Activity.setRequestedOrientation = function(orientation) {}; | |
/** | |
* Sets the result of this activity using an `Intent`. | |
* @since 1.5 (Android) | |
* @param {Number} resultCode Result code for this activity. | |
* @param {Titanium.Android.Intent=} intent An optional `Intent` with extra result data. | |
*/ | |
Titanium.Android.Activity.setResult = function(resultCode, intent) {}; | |
/** | |
* Sets a toolbar instance to be used as an ActionBar. | |
* @since 6.2.0 (Android) | |
* @param {Titanium.UI.Toolbar} toolbar Instance of a toolbar to be used as an ActionBar | |
*/ | |
Titanium.Android.Activity.setSupportActionBar = function(toolbar) {}; | |
/** | |
* Starts a new activity, using the passed in `Intent` as the description. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent Description of the activity to start. | |
*/ | |
Titanium.Android.Activity.startActivity = function(intent) {}; | |
/** | |
* The same as `startActivity`, but also accepts a callback function for handling the result of the started Activity. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent Description of the activity to start. | |
* @param {Callback<ActivityResult>} callback Callback function to be executed when the activity sets result. See | |
* examples. | |
* | |
*/ | |
Titanium.Android.Activity.startActivityForResult = function(intent, callback) {}; | |
/** | |
* Programmatically opens the options menu. | |
* @since 3.0.0 (Android) | |
*/ | |
Titanium.Android.Activity.openOptionsMenu = function() {}; | |
/** | |
* Broadcast the passed in `Intent` to all `BroadcastReceiver`s. | |
* @since 3.2.0 (Android) | |
* @param {Titanium.Android.Intent} intent Description of the broadcast. | |
*/ | |
Titanium.Android.Activity.sendBroadcast = function(intent) {}; | |
/** | |
* Broadcast the passed in `Intent` to all `BroadcastReceiver`s with an optional permission. | |
* @since 3.2.0 (Android) | |
* @param {Titanium.Android.Intent} intent Description of the broadcast. | |
* @param {String=} receiverPermission Name of the permission that the receiver should hold in order to receive the broadcast. | |
*/ | |
Titanium.Android.Activity.sendBroadcastWithPermission = function(intent, receiverPermission) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Activity.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Activity.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Activity.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Activity.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Activity.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.actionBar> property. | |
* @since 1.5 (Android) | |
* @return {Titanium.Android.ActionBar} | |
*/ | |
Titanium.Android.Activity.getActionBar = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.intent> property. | |
* @since 1.5 (Android) | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.Android.Activity.getIntent = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onCreate> property. | |
* @since 3.4.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnCreate = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onCreate> property. | |
* @since 3.4.0 (Android) | |
* @param {Callback<Object>} onCreate New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnCreate = function(onCreate) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onCreateOptionsMenu> property. | |
* @since 1.5 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnCreateOptionsMenu = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onCreateOptionsMenu> property. | |
* @since 1.5 (Android) | |
* @param {Callback<Object>} onCreateOptionsMenu New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnCreateOptionsMenu = function(onCreateOptionsMenu) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onDestroy> property. | |
* @since 3.4.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnDestroy = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onDestroy> property. | |
* @since 3.4.0 (Android) | |
* @param {Callback<Object>} onDestroy New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnDestroy = function(onDestroy) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onPause> property. | |
* @since 3.4.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnPause = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onPause> property. | |
* @since 3.4.0 (Android) | |
* @param {Callback<Object>} onPause New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnPause = function(onPause) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onPrepareOptionsMenu> property. | |
* @since 1.5 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnPrepareOptionsMenu = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onPrepareOptionsMenu> property. | |
* @since 1.5 (Android) | |
* @param {Callback<Object>} onPrepareOptionsMenu New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnPrepareOptionsMenu = function(onPrepareOptionsMenu) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onRestart> property. | |
* @since 3.4.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnRestart = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onRestart> property. | |
* @since 3.4.0 (Android) | |
* @param {Callback<Object>} onRestart New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnRestart = function(onRestart) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onResume> property. | |
* @since 3.4.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnResume = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onResume> property. | |
* @since 3.4.0 (Android) | |
* @param {Callback<Object>} onResume New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnResume = function(onResume) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onStart> property. | |
* @since 3.4.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnStart = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onStart> property. | |
* @since 3.4.0 (Android) | |
* @param {Callback<Object>} onStart New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnStart = function(onStart) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.onStop> property. | |
* @since 3.4.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.Activity.getOnStop = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.onStop> property. | |
* @since 3.4.0 (Android) | |
* @param {Callback<Object>} onStop New value for the property. | |
*/ | |
Titanium.Android.Activity.setOnStop = function(onStop) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Activity.supportToolbar> property. | |
* @since 6.2.0 (Android) | |
* @return {Titanium.UI.Toolbar} | |
*/ | |
Titanium.Android.Activity.getSupportToolbar = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Activity.supportToolbar> property. | |
* @since 6.2.0 (Android) | |
* @param {Titanium.UI.Toolbar} supportToolbar New value for the property. | |
*/ | |
Titanium.Android.Activity.setSupportToolbar = function(supportToolbar) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* onCreate: Callback<Object>, | |
* onCreateOptionsMenu: Callback<Object>, | |
* onDestroy: Callback<Object>, | |
* onPause: Callback<Object>, | |
* onPrepareOptionsMenu: Callback<Object>, | |
* onRestart: Callback<Object>, | |
* onResume: Callback<Object>, | |
* onStart: Callback<Object>, | |
* onStop: Callback<Object>, | |
* requestedOrientation: Number, | |
* supportToolbar: Titanium.UI.Toolbar | |
* }} | |
*/ | |
Titanium.Android._Dictionary_Activity; | |
/** | |
* Helper object for generating large-format notifications that include a large image attachment. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description 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. | |
* | |
* @since 5.4.0 (Android) | |
*/ | |
Titanium.Android.BigPictureStyle = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 5.4.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 5.4.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 5.4.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.lifecycleContainer; | |
/** | |
* Override the <Titanium.Android.Notification.largeIcon> when the big notification is shown. | |
* @since 5.4.0 (Android) | |
* @type {Number|String} bigLargeIcon | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.bigLargeIcon; | |
/** | |
* Provide the bitmap to be used as the payload for the BigPicture notification. | |
* @since 5.4.0 (Android) | |
* @type {Number|String|Titanium.Blob|Titanium.Filesystem.File} bigPicture | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.bigPicture; | |
/** | |
* Overrides <Titanium.Android.Notification.contentTitle> in the big form of the notification. This defaults to the value passed to <Titanium.Android.Notification.contentTitle>. | |
* @since 5.4.0 (Android) | |
* @type {String} bigContentTitle | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.bigContentTitle; | |
/** | |
* Number of times to retry decoding the bitmap at bigPicture URL. | |
* | |
* @since 5.4.0 (Android) | |
* @type {Number} decodeRetries | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.decodeRetries; | |
/** | |
* Set the first line of text after the detail section in the big form of the notification. | |
* @since 5.4.0 (Android) | |
* @type {String} summaryText | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.summaryText; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 5.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 5.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 5.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 5.4.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.bubbleParent> property. | |
* @since 5.4.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigPictureStyle.bubbleParent> property. | |
* @since 5.4.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.apiName> property. | |
* @since 5.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.lifecycleContainer> property. | |
* @since 5.4.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigPictureStyle.lifecycleContainer> property. | |
* @since 5.4.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.bigLargeIcon> property. | |
* @since 5.4.0 (Android) | |
* @return {Number|String} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getBigLargeIcon = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigPictureStyle.bigLargeIcon> property. | |
* @since 5.4.0 (Android) | |
* @param {Number|String} bigLargeIcon New value for the property. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.setBigLargeIcon = function(bigLargeIcon) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.bigPicture> property. | |
* @since 5.4.0 (Android) | |
* @return {Number|String|Titanium.Blob|Titanium.Filesystem.File} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getBigPicture = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigPictureStyle.bigPicture> property. | |
* @since 5.4.0 (Android) | |
* @param {Number|String|Titanium.Blob|Titanium.Filesystem.File} bigPicture New value for the property. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.setBigPicture = function(bigPicture) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.bigContentTitle> property. | |
* @since 5.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getBigContentTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigPictureStyle.bigContentTitle> property. | |
* @since 5.4.0 (Android) | |
* @param {String} bigContentTitle New value for the property. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.setBigContentTitle = function(bigContentTitle) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.decodeRetries> property. | |
* @since 5.4.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getDecodeRetries = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigPictureStyle.decodeRetries> property. | |
* @since 5.4.0 (Android) | |
* @param {Number} decodeRetries New value for the property. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.setDecodeRetries = function(decodeRetries) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigPictureStyle.summaryText> property. | |
* @since 5.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.getSummaryText = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigPictureStyle.summaryText> property. | |
* @since 5.4.0 (Android) | |
* @param {String} summaryText New value for the property. | |
*/ | |
Titanium.Android.BigPictureStyle.prototype.setSummaryText = function(summaryText) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* bigLargeIcon: (Number|String), | |
* bigPicture: (Number|String|Titanium.Blob|Titanium.Filesystem.File), | |
* bigContentTitle: String, | |
* decodeRetries: Number, | |
* summaryText: String | |
* }} | |
*/ | |
Titanium.Android._Dictionary_BigPictureStyle; | |
/** | |
* Helper object for generating large-format notifications that include a lot of text. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description 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.Android.Notification> object and modifies its behavior. | |
* | |
* @since 5.4.0 (Android) | |
*/ | |
Titanium.Android.BigTextStyle = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 5.4.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.BigTextStyle.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 5.4.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.BigTextStyle.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 5.4.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.BigTextStyle.prototype.lifecycleContainer; | |
/** | |
* Sets the longer text to be displayed in the big form of the notification in place of the content text. | |
* @since 5.4.0 (Android) | |
* @type {String} bigText | |
*/ | |
Titanium.Android.BigTextStyle.prototype.bigText; | |
/** | |
* Overrides <Titanium.Android.Notification.contentTitle> in the big form of the notification. This defaults to the value passed to <Titanium.Android.Notification.contentTitle>. | |
* @since 5.4.0 (Android) | |
* @type {String} bigContentTitle | |
*/ | |
Titanium.Android.BigTextStyle.prototype.bigContentTitle; | |
/** | |
* Set the first line of text after the detail section in the big form of the notification. | |
* @since 5.4.0 (Android) | |
* @type {String} summaryText | |
*/ | |
Titanium.Android.BigTextStyle.prototype.summaryText; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 5.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 5.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 5.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 5.4.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigTextStyle.bubbleParent> property. | |
* @since 5.4.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.BigTextStyle.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigTextStyle.bubbleParent> property. | |
* @since 5.4.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigTextStyle.apiName> property. | |
* @since 5.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BigTextStyle.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigTextStyle.lifecycleContainer> property. | |
* @since 5.4.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.BigTextStyle.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigTextStyle.lifecycleContainer> property. | |
* @since 5.4.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigTextStyle.bigText> property. | |
* @since 5.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BigTextStyle.prototype.getBigText = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigTextStyle.bigText> property. | |
* @since 5.4.0 (Android) | |
* @param {String} bigText New value for the property. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.setBigText = function(bigText) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigTextStyle.bigContentTitle> property. | |
* @since 5.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BigTextStyle.prototype.getBigContentTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigTextStyle.bigContentTitle> property. | |
* @since 5.4.0 (Android) | |
* @param {String} bigContentTitle New value for the property. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.setBigContentTitle = function(bigContentTitle) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BigTextStyle.summaryText> property. | |
* @since 5.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BigTextStyle.prototype.getSummaryText = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BigTextStyle.summaryText> property. | |
* @since 5.4.0 (Android) | |
* @param {String} summaryText New value for the property. | |
*/ | |
Titanium.Android.BigTextStyle.prototype.setSummaryText = function(summaryText) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* bigText: String, | |
* bigContentTitle: String, | |
* summaryText: String | |
* }} | |
*/ | |
Titanium.Android._Dictionary_BigTextStyle; | |
/** | |
* Monitor and handle Android system broadcasts. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description The application can use broadcast receivers to monitor system events from the Android OS | |
* as well as custom broadcasts sent by other applications. The application will need to know the | |
* name of the broadcast actions in order to monitor them. Note that Titanium only supports | |
* programmatically creating and registering broadcast receivers. Titanium does not support | |
* declaring a receiver in the Android manifest. | |
* | |
* To create a Broadcast Receiver, use the <Titanium.Android.createBroadcastReceiver> method. | |
* Specify either a callback to handle the broadcast with the `onReceived` property or a | |
* JavaScript file with the `url` property. Do not specify both. If both properties are | |
* used, the `url` property takes precedence. | |
* | |
* To start listening to a broadcast, pass the `BroadcastReceiver` object and an array of | |
* broadcast actions to listen for to the <Titanium.Android.registerBroadcastReceiver> method. | |
* | |
* Titanium exposes some of the system-level broadcasts as the `Titanium.Android.ACTION_*` | |
* constants. Note that some of these constants are not broadcast messages. | |
* | |
* You can also define a custom broadcast action. Use a reverse domain name scheme in order to | |
* avoid potential conflicts with other applications. | |
* | |
* To stop listening to a broadcast, pass the `BroadcastReceiver` object to the | |
* <Titanium.Android.unregisterBroadcastReceiver> method. | |
* | |
* To monitor a broadcast that requires a special permission, declare the **`<uses-permission>`** | |
* element in the Android manifest section of the `tiapp.xml` file for each broadcast that uses | |
* a special permission. For example, to monitor the `NEW_OUTGOING_CALL` broadcast, the | |
* application needs to add the following permission: | |
* | |
* <ti:app> | |
* <android> | |
* <manifest> | |
* <uses-permission android:name="android.permission.NEW_OUTGOING_CALL" /> | |
* </manifest> | |
* </android> | |
* </ti:app> | |
* | |
* Further Reading: | |
* | |
* * [Android Broadcast Intents and Receivers guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Broadcast_Intents_and_Receivers) | |
* * [Android Developers: Broadcast Receivers](https://developer.android.com/reference/android/content/BroadcastReceiver.html). | |
* | |
* @since 3.1.0 (Android) | |
*/ | |
Titanium.Android.BroadcastReceiver = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.1.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.lifecycleContainer; | |
/** | |
* The function called when a broadcast is received. | |
* @since 3.1.0 (Android) | |
* @type {Callback<Object>} onReceived | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.onReceived; | |
/** | |
* URL of the JavaScript file to handle the broadcast. | |
* @since 3.1.0 (Android) | |
* @type {String} url | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.url; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.1.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.1.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.1.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.1.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BroadcastReceiver.bubbleParent> property. | |
* @since 3.1.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BroadcastReceiver.bubbleParent> property. | |
* @since 3.1.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BroadcastReceiver.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.BroadcastReceiver.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BroadcastReceiver.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BroadcastReceiver.onReceived> property. | |
* @since 3.1.0 (Android) | |
* @return {Callback<Object>} | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.getOnReceived = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BroadcastReceiver.onReceived> property. | |
* @since 3.1.0 (Android) | |
* @param {Callback<Object>} onReceived New value for the property. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.setOnReceived = function(onReceived) {}; | |
/** | |
* Gets the value of the <Titanium.Android.BroadcastReceiver.url> property. | |
* @since 3.1.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.getUrl = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.BroadcastReceiver.url> property. | |
* @since 3.1.0 (Android) | |
* @param {String} url New value for the property. | |
*/ | |
Titanium.Android.BroadcastReceiver.prototype.setUrl = function(url) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* onReceived: Callback<Object>, | |
* url: String | |
* }} | |
*/ | |
Titanium.Android._Dictionary_BroadcastReceiver; | |
/** | |
* The Android.Calendar module provides proxies and methods for accessing the native Android | |
* calendar functionality. | |
* | |
* @extends {Titanium.Module} | |
* @description This module supports retrieving information about existing events and creating new events. | |
* However, modifying or deleting existing events is not yet supported. | |
* Additionally, recurring events are not yet supported. | |
* | |
* Currently, calendar permissions must be explicitly configured in `tiapp.xml` in order to access the | |
* calendar. See "Common Requirements" in | |
* [tiapp.xml and timodule.xml Reference](https://docs.appcelerator.com/platform/latest/#!/guide/tiapp.xml_and_timodule.xml_Reference). | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Calendar = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Calendar.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Calendar.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Calendar.prototype.lifecycleContainer; | |
/** | |
* Reminder alert delivery method. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} METHOD_ALERT | |
*/ | |
Titanium.Android.Calendar.METHOD_ALERT; | |
/** | |
* Reminder default delivery method. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} METHOD_DEFAULT | |
*/ | |
Titanium.Android.Calendar.METHOD_DEFAULT; | |
/** | |
* Reminder email delivery method. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} METHOD_EMAIL | |
*/ | |
Titanium.Android.Calendar.METHOD_EMAIL; | |
/** | |
* Reminder SMS delivery method. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} METHOD_SMS | |
*/ | |
Titanium.Android.Calendar.METHOD_SMS; | |
/** | |
* Alert dismissed state. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STATE_DISMISSED | |
*/ | |
Titanium.Android.Calendar.STATE_DISMISSED; | |
/** | |
* Alert fired state. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STATE_FIRED | |
*/ | |
Titanium.Android.Calendar.STATE_FIRED; | |
/** | |
* Alert scheduled status. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STATE_SCHEDULED | |
*/ | |
Titanium.Android.Calendar.STATE_SCHEDULED; | |
/** | |
* Event canceled status. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STATUS_CANCELED | |
*/ | |
Titanium.Android.Calendar.STATUS_CANCELED; | |
/** | |
* Event confirmed status. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STATUS_CONFIRMED | |
*/ | |
Titanium.Android.Calendar.STATUS_CONFIRMED; | |
/** | |
* Event tentative status. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STATUS_TENTATIVE | |
*/ | |
Titanium.Android.Calendar.STATUS_TENTATIVE; | |
/** | |
* Event confidential visibility. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_CONFIDENTIAL | |
*/ | |
Titanium.Android.Calendar.VISIBILITY_CONFIDENTIAL; | |
/** | |
* Event default visibility. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_DEFAULT | |
*/ | |
Titanium.Android.Calendar.VISIBILITY_DEFAULT; | |
/** | |
* Event private visibility. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_PRIVATE | |
*/ | |
Titanium.Android.Calendar.VISIBILITY_PRIVATE; | |
/** | |
* Event public visibility. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_PUBLIC | |
*/ | |
Titanium.Android.Calendar.VISIBILITY_PUBLIC; | |
/** | |
* All alerts in selected calendars. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Array<Titanium.Android.Calendar.Alert>} allAlerts | |
*/ | |
Titanium.Android.Calendar.prototype.allAlerts; | |
/** | |
* All calendars known to the native calendar app. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Array<Titanium.Android.Calendar.Calendar>} allCalendars | |
*/ | |
Titanium.Android.Calendar.prototype.allCalendars; | |
/** | |
* All calendars selected within the native calendar app, which may be a subset of `allCalendars`. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Array<Titanium.Android.Calendar.Calendar>} selectableCalendars | |
*/ | |
Titanium.Android.Calendar.prototype.selectableCalendars; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Calendar.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Calendar.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Calendar.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Calendar.applyProperties = function(props) {}; | |
/** | |
* Gets the calendar with the specified identifier. | |
* @since 1.5 (Android) | |
* @param {Number} id Integer identifier of the calendar. | |
* @return {Titanium.Android.Calendar.Calendar} | |
*/ | |
Titanium.Android.Calendar.getCalendarById = function(id) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Calendar.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Calendar.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Calendar.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.allAlerts> property. | |
* @since 1.5 (Android) | |
* @return {Array<Titanium.Android.Calendar.Alert>} | |
*/ | |
Titanium.Android.Calendar.getAllAlerts = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.allCalendars> property. | |
* @since 1.5 (Android) | |
* @return {Array<Titanium.Android.Calendar.Calendar>} | |
*/ | |
Titanium.Android.Calendar.getAllCalendars = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.selectableCalendars> property. | |
* @since 1.5 (Android) | |
* @return {Array<Titanium.Android.Calendar.Calendar>} | |
*/ | |
Titanium.Android.Calendar.getSelectableCalendars = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android._Dictionary_Calendar; | |
/** | |
* An object that represents a single alert for an event in an Android calendar. | |
* @extends {Titanium.Proxy} | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Calendar.Alert = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.lifecycleContainer; | |
/** | |
* Date/time at which this alert alarm is set to trigger. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Date} alarmTime | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.alarmTime; | |
/** | |
* Start date/time for the corresponding event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Date} begin | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.begin; | |
/** | |
* End date/time for the corresponding event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Date} end | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.end; | |
/** | |
* Identifier of the event for which this alert is set. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} eventId | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.eventId; | |
/** | |
* Identifier of this alert. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.id; | |
/** | |
* Reminder notice period in minutes, that determines how long prior to the event this alert | |
* should trigger. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} minutes | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.minutes; | |
/** | |
* The current state of the alert. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} state | |
*/ | |
Titanium.Android.Calendar.Alert.prototype.state; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Calendar.Alert.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Calendar.Alert.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Calendar.Alert.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Calendar.Alert.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Alert.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Alert.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Calendar.Alert.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Alert.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Calendar.Alert.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Alert.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Calendar.Alert.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.alarmTime> property. | |
* @since 1.5 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Android.Calendar.Alert.getAlarmTime = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.begin> property. | |
* @since 1.5 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Android.Calendar.Alert.getBegin = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.end> property. | |
* @since 1.5 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Android.Calendar.Alert.getEnd = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.eventId> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Calendar.Alert.getEventId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.id> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Alert.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.minutes> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Calendar.Alert.getMinutes = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Alert.state> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Calendar.Alert.getState = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android.Calendar._Dictionary_Alert; | |
/** | |
* An object that represents a single calendar on Android. | |
* @extends {Titanium.Proxy} | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Calendar.Calendar = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Calendar.Calendar.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Calendar.Calendar.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Calendar.Calendar.prototype.lifecycleContainer; | |
/** | |
* Indicates whether this calendar is hidden. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Boolean} hidden | |
*/ | |
Titanium.Android.Calendar.Calendar.prototype.hidden; | |
/** | |
* Identifier of this calendar. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Android.Calendar.Calendar.prototype.id; | |
/** | |
* Display name of this calendar. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} name | |
*/ | |
Titanium.Android.Calendar.Calendar.prototype.name; | |
/** | |
* Indicates whether the calendar is selected. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Boolean} selected | |
*/ | |
Titanium.Android.Calendar.Calendar.prototype.selected; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Calendar.Calendar.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Calendar.Calendar.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Calendar.Calendar.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Calendar.Calendar.applyProperties = function(props) {}; | |
/** | |
* Creates an event in this calendar. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Calendar._Dictionary_Event} properties Properties of the event | |
* @return {Titanium.Android.Calendar.Event} | |
*/ | |
Titanium.Android.Calendar.Calendar.createEvent = function(properties) {}; | |
/** | |
* Gets the event with the specified identifier. | |
* @since 1.5 (Android) | |
* @param {Number} id Identifier of the event. | |
* @return {Titanium.Android.Calendar.Event} | |
*/ | |
Titanium.Android.Calendar.Calendar.getEventById = function(id) {}; | |
/** | |
* Gets events that occur between two dates. | |
* @since 1.5 (Android) | |
* @param {Date} date1 Start date. | |
* @param {Date} date2 End date. | |
* @return {Array<Titanium.Android.Calendar.Event>} | |
*/ | |
Titanium.Android.Calendar.Calendar.getEventsBetweenDates = function(date1, date2) {}; | |
/** | |
* Gets events that occur on a specified date. | |
* @since 1.5 (Android) | |
* @param {Number} year Year of the events. | |
* @param {Number} month Month of the events, as a zero-based integer with January at 0 and December at 11. | |
* @param {Number} day Day of the month of the events. | |
* @return {Array<Titanium.Android.Calendar.Event>} | |
*/ | |
Titanium.Android.Calendar.Calendar.getEventsInDate = function(year, month, day) {}; | |
/** | |
* Gets events that occur during a specified month. | |
* @since 1.5 (Android) | |
* @param {Number} year Year of the events. | |
* @param {Number} month Month of the events, as a zero-based integer with January at 0 and December at 11. | |
* @return {Array<Titanium.Android.Calendar.Event>} | |
*/ | |
Titanium.Android.Calendar.Calendar.getEventsInMonth = function(year, month) {}; | |
/** | |
* Gets all events that occur during a specified year. | |
* @since 1.5 (Android) | |
* @param {Number} year Year of the events. | |
* @return {Array<Titanium.Android.Calendar.Event>} | |
*/ | |
Titanium.Android.Calendar.Calendar.getEventsInYear = function(year) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Calendar.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Calendar.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Calendar.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Calendar.Calendar.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Calendar.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Calendar.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Calendar.Calendar.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Calendar.Calendar.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Calendar.hidden> property. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Calendar.getHidden = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Calendar.id> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Calendar.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Calendar.name> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Calendar.getName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Calendar.selected> property. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Calendar.getSelected = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android.Calendar._Dictionary_Calendar; | |
/** | |
* An object that represents a single event in an Android calendar. | |
* @extends {Titanium.Proxy} | |
* @description The API supports retrieving information about existing events and creating new events. | |
* Be aware that modifying or deleting existing events is not yet supported. Additionally, recurring | |
* events are not yet supported. | |
* | |
* See <Titanium.Android.Calendar> for examples of retrieving event information and creating events. | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Calendar.Event = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Calendar.Event.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Calendar.Event.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Calendar.Event.prototype.lifecycleContainer; | |
/** | |
* Existing alerts for this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Array<Titanium.Android.Calendar.Alert>} alerts | |
*/ | |
Titanium.Android.Calendar.Event.prototype.alerts; | |
/** | |
* Indicates whether this event is all day. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Boolean} allDay | |
*/ | |
Titanium.Android.Calendar.Event.prototype.allDay; | |
/** | |
* Start date/time of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Date} begin | |
*/ | |
Titanium.Android.Calendar.Event.prototype.begin; | |
/** | |
* Description of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} description | |
*/ | |
Titanium.Android.Calendar.Event.prototype.description; | |
/** | |
* End date/time of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Date} end | |
*/ | |
Titanium.Android.Calendar.Event.prototype.end; | |
/** | |
* Extended properties of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Dictionary} extendedProperties | |
*/ | |
Titanium.Android.Calendar.Event.prototype.extendedProperties; | |
/** | |
* Indicates whether an alarm is scheduled for this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Boolean} hasAlarm | |
*/ | |
Titanium.Android.Calendar.Event.prototype.hasAlarm; | |
/** | |
* Indicates whether [extendedProperties](Titanium.Android.Calendar.Event.extendedProperties) | |
* exists for this event. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Boolean} hasExtendedProperties | |
*/ | |
Titanium.Android.Calendar.Event.prototype.hasExtendedProperties; | |
/** | |
* Identifier of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Android.Calendar.Event.prototype.id; | |
/** | |
* Location of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} location | |
*/ | |
Titanium.Android.Calendar.Event.prototype.location; | |
/** | |
* Existing reminders for this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Array<Titanium.Android.Calendar.Reminder>} reminders | |
*/ | |
Titanium.Android.Calendar.Event.prototype.reminders; | |
/** | |
* Status of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} status | |
*/ | |
Titanium.Android.Calendar.Event.prototype.status; | |
/** | |
* Title of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} title | |
*/ | |
Titanium.Android.Calendar.Event.prototype.title; | |
/** | |
* Visibility of this event. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} visibility | |
*/ | |
Titanium.Android.Calendar.Event.prototype.visibility; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Calendar.Event.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Calendar.Event.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Calendar.Event.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Calendar.Event.applyProperties = function(props) {}; | |
/** | |
* Creates an alert for this event. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Calendar._Dictionary_Alert} data Properties for the alert. | |
* @return {Titanium.Android.Calendar.Alert} | |
*/ | |
Titanium.Android.Calendar.Event.createAlert = function(data) {}; | |
/** | |
* Creates a reminder for this event. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Calendar._Dictionary_Reminder} data Properties for the reminder. | |
* @return {Titanium.Android.Calendar.Reminder} | |
*/ | |
Titanium.Android.Calendar.Event.createReminder = function(data) {}; | |
/** | |
* Gets the value of the specified extended property. | |
* @since 1.5 (Android) | |
* @param {String} name Name of an existing extended property. | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Event.getExtendedProperty = function(name) {}; | |
/** | |
* Sets the value of the specified extended property. | |
* @since 1.5 (Android) | |
* @param {String} name Property name. | |
* @param {String} value Property value. | |
*/ | |
Titanium.Android.Calendar.Event.setExtendedProperty = function(name, value) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Event.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Event.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Calendar.Event.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Event.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Calendar.Event.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Event.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Calendar.Event.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.alerts> property. | |
* @since 1.5 (Android) | |
* @return {Array<Titanium.Android.Calendar.Alert>} | |
*/ | |
Titanium.Android.Calendar.Event.getAlerts = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.allDay> property. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Event.getAllDay = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.begin> property. | |
* @since 1.5 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Android.Calendar.Event.getBegin = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.description> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Event.getDescription = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.end> property. | |
* @since 1.5 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Android.Calendar.Event.getEnd = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.extendedProperties> property. | |
* @since 1.5 (Android) | |
* @return {Dictionary} | |
*/ | |
Titanium.Android.Calendar.Event.getExtendedProperties = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.hasAlarm> property. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Event.getHasAlarm = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.hasExtendedProperties> property. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Event.getHasExtendedProperties = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.id> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Event.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.location> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Event.getLocation = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.reminders> property. | |
* @since 1.5 (Android) | |
* @return {Array<Titanium.Android.Calendar.Reminder>} | |
*/ | |
Titanium.Android.Calendar.Event.getReminders = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.status> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Calendar.Event.getStatus = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.title> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Event.getTitle = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Event.visibility> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Calendar.Event.getVisibility = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android.Calendar._Dictionary_Event; | |
/** | |
* An object that represents a single reminder for an event in an Android calendar. | |
* @extends {Titanium.Proxy} | |
* @description Reminders should be created using the <Titanium.Android.Calendar.Event.createReminder> method | |
* rather than directly. | |
* | |
* See <Titanium.Android.Calendar> for examples of retrieving reminder information and creating | |
* reminders for events. | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Calendar.Reminder = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Calendar.Reminder.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Calendar.Reminder.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Calendar.Reminder.prototype.lifecycleContainer; | |
/** | |
* Identifier of this reminder. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Android.Calendar.Reminder.prototype.id; | |
/** | |
* Method by which this reminder will be delivered. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} method | |
*/ | |
Titanium.Android.Calendar.Reminder.prototype.method; | |
/** | |
* Reminder notice period in minutes, that determines how long prior to the event this reminder | |
* should trigger. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} minutes | |
*/ | |
Titanium.Android.Calendar.Reminder.prototype.minutes; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Calendar.Reminder.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Calendar.Reminder.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Calendar.Reminder.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Calendar.Reminder.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Reminder.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Calendar.Reminder.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Reminder.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Calendar.Reminder.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Reminder.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Reminder.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Reminder.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Calendar.Reminder.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Calendar.Reminder.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Calendar.Reminder.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Reminder.id> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Calendar.Reminder.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Reminder.method> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Calendar.Reminder.getMethod = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Calendar.Reminder.minutes> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Calendar.Reminder.getMinutes = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android.Calendar._Dictionary_Reminder; | |
/** | |
* The Titanium binding of an Android HttpResponseCache. | |
* @extends {Titanium.Proxy} | |
* @description Caches HTTP and HTTPS responses to the filesystem so they may be reused, saving time and bandwidth. | |
* | |
* See also [android.net.http.HttpResponseCache](https://developer.android.com/reference/android/net/http/HttpResponseCache.html) | |
* in the Android API Reference. | |
* | |
* Cache will be saved in external storage if it present on the moment then | |
* [install](Titanium.Android.HttpResponseCache.install) method is called. | |
* | |
* #### Usage example | |
* | |
* if(Ti.Platform.osname == "android") { | |
* Ti.Android.HttpResponseCache.setHttpCachePath('_http_'); | |
* Ti.Android.HttpResponseCache.setHttpCacheSize(30 * 1024 * 1024); // 30MB | |
* Ti.Android.HttpResponseCache.install(); | |
* } | |
* | |
* @since 7.4.0 (Android) | |
*/ | |
Titanium.Android.HttpResponseCache = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 7.4.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.HttpResponseCache.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 7.4.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.HttpResponseCache.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 7.4.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.HttpResponseCache.prototype.lifecycleContainer; | |
/** | |
* Maximum cache size in bytes. | |
* @since 7.4.0 (Android) | |
* @type {Number} maxSize | |
*/ | |
Titanium.Android.HttpResponseCache.prototype.maxSize; | |
/** | |
* Relative path for cache | |
* @since 7.4.0 (Android) | |
* @type {String} path | |
*/ | |
Titanium.Android.HttpResponseCache.prototype.path; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 7.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.HttpResponseCache.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 7.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.HttpResponseCache.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 7.4.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.HttpResponseCache.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 7.4.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.HttpResponseCache.applyProperties = function(props) {}; | |
/** | |
* Uninstalls the cache and releases any active resources. | |
* @since 7.4.0 (Android) | |
*/ | |
Titanium.Android.HttpResponseCache.close = function() {}; | |
/** | |
* Force buffered operations to the filesystem. | |
* @since 7.4.0 (Android) | |
*/ | |
Titanium.Android.HttpResponseCache.flush = function() {}; | |
/** | |
* Creates a new HTTP response cache and sets it as the system default cache. | |
* @since 7.4.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.HttpResponseCache.install = function() {}; | |
/** | |
* Uninstalls the cache and deletes all of its stored contents. | |
* @since 7.4.0 (Android) | |
*/ | |
Titanium.Android.HttpResponseCache.remove = function() {}; | |
/** | |
* Returns the number of HTTP requests whose response was provided by the cache. | |
* @since 7.4.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.HttpResponseCache.getHitCount = function() {}; | |
/** | |
* Returns the number of HTTP requests that required the network to either supply a response or validate a locally cached response. | |
* @since 7.4.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.HttpResponseCache.getNetworkCount = function() {}; | |
/** | |
* Returns the total number of HTTP requests that were made. | |
* @since 7.4.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.HttpResponseCache.getRequestCount = function() {}; | |
/** | |
* Returns the number of bytes currently being used to store the values in this cache. | |
* @since 7.4.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.HttpResponseCache.size = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.HttpResponseCache.bubbleParent> property. | |
* @since 7.4.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.HttpResponseCache.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.HttpResponseCache.bubbleParent> property. | |
* @since 7.4.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.HttpResponseCache.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.HttpResponseCache.apiName> property. | |
* @since 7.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.HttpResponseCache.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.HttpResponseCache.lifecycleContainer> property. | |
* @since 7.4.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.HttpResponseCache.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.HttpResponseCache.lifecycleContainer> property. | |
* @since 7.4.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.HttpResponseCache.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.HttpResponseCache.maxSize> property. | |
* @since 7.4.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.HttpResponseCache.getMaxSize = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.HttpResponseCache.maxSize> property. | |
* @since 7.4.0 (Android) | |
* @param {Number} maxSize New value for the property. | |
*/ | |
Titanium.Android.HttpResponseCache.setMaxSize = function(maxSize) {}; | |
/** | |
* Gets the value of the <Titanium.Android.HttpResponseCache.path> property. | |
* @since 7.4.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.HttpResponseCache.getPath = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.HttpResponseCache.path> property. | |
* @since 7.4.0 (Android) | |
* @param {String} path New value for the property. | |
*/ | |
Titanium.Android.HttpResponseCache.setPath = function(path) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* maxSize: Number, | |
* path: String | |
* }} | |
*/ | |
Titanium.Android._Dictionary_HttpResponseCache; | |
/** | |
* Message objects passed between Android application components. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description In Android, applications and application components cannot directly communicate with each other. | |
* In order to communicate with another application, use an intent. An intent is a message sent | |
* to the Android OS. Android directs the message to an application or application component based | |
* on the intent's settings. | |
* | |
* To receive an intent, an application needs to declare an Intent Filter. An intent filter | |
* indicates to the Android OS that your application can handle certain data types or URIs. | |
* For details on using Intent Filters, see the | |
* [Android Intent Filters guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Intent_Filters). | |
* | |
* Intents can be used to start an activity, start a service or start a broadcast. | |
* | |
* * To create an intent to start an **Activity**, use the <Titanium.Android.createIntent> method. | |
* * To create an intent to start a **Broadcast**, use the <Titanium.Android.createBroadcastIntent> method. | |
* * To create an intent to start a **Service**, use the <Titanium.Android.createServiceIntent> method. | |
* | |
* You can create either an implicit intent or an explicit intent. | |
* | |
* An *explicit intent* specifies the application or application component to launch. To create an | |
* explicit intent, specify the Intent's `className` and `packageName` properties to specify the | |
* application component to launch or the `url` property to specify a JavaScript file to handle | |
* the data. | |
* | |
* An *implicit intent* does not specify a particular application. Android will present the options | |
* to the user of which applications to launch if a default application was not selected to handle | |
* a particular data type or content URI. To create an implicit intent, do not specify the | |
* `className`, `packageName` or `url` properties. | |
* | |
* Note that the parameters to create a Service Intent are different than the ones used to | |
* create an Activity or Broadcast. The properties and methods listed below | |
* are used for Activity and Broadcast Intents. See the <Titanium.Android.createServiceIntent> method | |
* for the parameters to create a Service Intent. | |
* | |
* #### Action | |
* | |
* The `action` property specifies the action you want the activity to perform, or in the case of | |
* broadcasts, the action that just completed you want to report. | |
* | |
* Titanium exposes some of the Android Intent actions as the `Titanium.Android.ACTION_*` constants. | |
* Note that some of these actions are for system-level broadcasts that only Android can send. | |
* If Titanium has not exposed a particular constant, you can pass the string value listed in the | |
* Android API reference guide instead. | |
* | |
* You can also define your own custom action names. Use a reverse domain scheme to name the | |
* action to avoid potential conflicts, for example, `com.appcelerator.action.LINT`. | |
* Custom actions are only useful to communicate between your applications and application | |
* activities using intents. | |
* | |
* #### Data | |
* | |
* The [data](Titanium.Android.Intent.data) property specifies a content URI you want the activity to handle. | |
* | |
* The [type](Titanium.Android.Intent.type) property specifies a MIME type the activity can handle. | |
* | |
* For Broadcast Intents, do not use the `data` or `type` properties. Use extras to pass data. | |
* See the *Extras* section below. | |
* | |
* #### Category | |
* | |
* Add a category to your Intent by invoking the [addCategory()](Titanium.Android.Intent.addCategory) | |
* method on it. A category provides additional details about the purpose of the intent. | |
* Note that most categories are only useful for intent filters. | |
* | |
* Titanium exposes some of the Android Intent categories as the `Titanium.Android.CATEGORY_*` constants. | |
* Note that some of these categories are for Notifications. If Titanium has not exposed a | |
* particular constant, you can pass the string value listed in the Android API reference instead. | |
* | |
* You can also define your own custom category names. Use a reverse domain scheme to name the | |
* category to avoid potential conflicts, for example, `org.foo.category.SUPER`. | |
* Custom categories are only useful to communicate between your applications and application | |
* activities using intents. | |
* | |
* #### Flags | |
* | |
* Bitwise-OR flags with the Intent's [flags](Titanium.Android.Intent.flags) property | |
* or pass a flag to the [addFlags()](Titanium.Android.Intent.addFlags) method. | |
* Flags modify the behavior of the intent. | |
* | |
* Titanium exposes some of the Android Intent flags as the `Titanium.Android.FLAG_*` constants. | |
* If Titanium has not exposed a particular constant, you can pass the constant value listed in | |
* the Android API reference instead. | |
* | |
* #### Extras | |
* | |
* Extras are key-value pairs that are useful to pass on extra data with the Intent that can be | |
* used by another application component. | |
* | |
* * Use one of the `get*Extra()` methods to retrieve the data. Pass the method the extra key. | |
* * Use the [hasExtra()](Titanium.Android.Intent.hasExtra) method to check if the intent contains an extra. | |
* Pass the method the key of the extra. | |
* * Use the [putExtra()](Titanium.Android.Intent.putExtra) method to add data to the intent. | |
* Pass the method the extra key and data. | |
* | |
* Titanium exposes the Android-defined extra keys as the `Titanium.Android.EXTRA_*` constants. | |
* You can also define your own custom extra keys to use between your applications and application | |
* components. | |
* | |
* #### Further Reading | |
* | |
* * [Android Intents guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Intents) | |
* * [Android Developer: Intent](https://developer.android.com/reference/android/content/Intent.html) | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Intent = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Intent.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Intent.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Intent.prototype.lifecycleContainer; | |
/** | |
* The action associated with this intent. | |
* @since 1.5 (Android) | |
* @type {String} action | |
*/ | |
Titanium.Android.Intent.prototype.action; | |
/** | |
* The Java class name of the activity associated with this intent | |
* ([packageName](Titanium.Android.Intent.packageName) must also be set). | |
* | |
* @since 1.5 (Android) | |
* @type {String} className | |
*/ | |
Titanium.Android.Intent.prototype.className; | |
/** | |
* The Intent's Data URI. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} data | |
*/ | |
Titanium.Android.Intent.prototype.data; | |
/** | |
* Intent flags. | |
* @since 1.5 (Android) | |
* @type {Number} flags | |
*/ | |
Titanium.Android.Intent.prototype.flags; | |
/** | |
* The fully-qualified Java package name of the activity. | |
* @since 1.5 (Android) | |
* @type {String} packageName | |
*/ | |
Titanium.Android.Intent.prototype.packageName; | |
/** | |
* The MIME type for this Intent. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {String} type | |
*/ | |
Titanium.Android.Intent.prototype.type; | |
/** | |
* The URL to a Titanium JavaScript Activity. | |
* @since 1.5 (Android) | |
* @type {String} url | |
*/ | |
Titanium.Android.Intent.prototype.url; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Intent.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Intent.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Intent.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Intent.prototype.applyProperties = function(props) {}; | |
/** | |
* Adds a category to this Intent. | |
* @since 1.5 (Android) | |
* @param {String} name The category name. | |
*/ | |
Titanium.Android.Intent.prototype.addCategory = function(name) {}; | |
/** | |
* Adds to the existing flags on the `Intent`. | |
* @since 1.5 (Android) | |
* @param {Number} flags Bitwise OR of the flags to add to the existing set. | |
*/ | |
Titanium.Android.Intent.prototype.addFlags = function(flags) {}; | |
/** | |
* Get a <Titanium.Blob> property from this `Intent`. | |
* @since 2.1.0 (Android) | |
* @param {String} name The <Titanium.Blob> extra to get, most commonly <Titanium.Android.EXTRA_STREAM>. | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Android.Intent.prototype.getBlobExtra = function(name) {}; | |
/** | |
* Get a boolean property from this Intent. | |
* @since 1.5 (Android) | |
* @param {String} name Property to get. | |
* @param {Boolean} default_ Default value to return if property does not exist or is of a different type. | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Intent.prototype.getBooleanExtra = function(name, default_) {}; | |
/** | |
* Get the Data URI from this `Intent`. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getData = function() {}; | |
/** | |
* Get a double property from this `Intent`. | |
* @since 1.5 (Android) | |
* @param {String} name Property to get. | |
* @param {Number} default_ Default value to return if property does not exist or is of a different type. | |
* @return {Number} | |
*/ | |
Titanium.Android.Intent.prototype.getDoubleExtra = function(name, default_) {}; | |
/** | |
* Get an integer property from this `Intent`. | |
* @since 1.5 (Android) | |
* @param {String} name Property to get. | |
* @param {Number} default_ Default value to return if property does not exist or is of a different type. | |
* @return {Number} | |
*/ | |
Titanium.Android.Intent.prototype.getIntExtra = function(name, default_) {}; | |
/** | |
* Get a long property from this `Intent`. | |
* @since 1.5 (Android) | |
* @param {String} name Property to get. | |
* @param {Number} default_ Default value to return if property does not exist or is of a different type. | |
* @return {Number} | |
*/ | |
Titanium.Android.Intent.prototype.getLongExtra = function(name, default_) {}; | |
/** | |
* Get a string property from this `Intent`. | |
* @since 1.5 (Android) | |
* @param {String} name Property to get. | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getStringExtra = function(name) {}; | |
/** | |
* Returns `true` if this `Intent` has the specified property. | |
* @since 1.5 (Android) | |
* @param {String} name Property name to check for. | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Intent.prototype.hasExtra = function(name) {}; | |
/** | |
* Puts an extra property on this `Intent`. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the property to add. | |
* @param {Object} value Property value to set. | |
*/ | |
Titanium.Android.Intent.prototype.putExtra = function(name, value) {}; | |
/** | |
* Put a URI property on this `Intent` (useful for <Titanium.Android.EXTRA_STREAM>). | |
* @since 1.5 (Android) | |
* @param {String} name The property name. | |
* @param {Object} value The URI, as a string or a string array. | |
*/ | |
Titanium.Android.Intent.prototype.putExtraUri = function(name, value) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Intent.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Intent.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Intent.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Intent.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Intent.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Intent.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.action> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getAction = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Intent.action> property. | |
* @since 1.5 (Android) | |
* @param {String} action New value for the property. | |
*/ | |
Titanium.Android.Intent.prototype.setAction = function(action) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.className> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getClassName = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Intent.className> property. | |
* @since 1.5 (Android) | |
* @param {String} className New value for the property. | |
*/ | |
Titanium.Android.Intent.prototype.setClassName = function(className) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.flags> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Intent.prototype.getFlags = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Intent.flags> property. | |
* @since 1.5 (Android) | |
* @param {Number} flags New value for the property. | |
*/ | |
Titanium.Android.Intent.prototype.setFlags = function(flags) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.packageName> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getPackageName = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Intent.packageName> property. | |
* @since 1.5 (Android) | |
* @param {String} packageName New value for the property. | |
*/ | |
Titanium.Android.Intent.prototype.setPackageName = function(packageName) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.type> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getType = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Intent.url> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Intent.prototype.getUrl = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Intent.url> property. | |
* @since 1.5 (Android) | |
* @param {String} url New value for the property. | |
*/ | |
Titanium.Android.Intent.prototype.setUrl = function(url) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* action: String, | |
* className: String, | |
* flags: Number, | |
* packageName: String, | |
* url: String | |
* }} | |
*/ | |
Titanium.Android._Dictionary_Intent; | |
/** | |
* The Titanium binding of an Android Options Menu. | |
* @extends {Titanium.Proxy} | |
* @description The Menu and MenuItems APIs are used to create the action items | |
* for the action bar. Action items can appear in either the action bar or the action bar's | |
* overflow menu. | |
* | |
* To create action items with JavaScript, assign a callback function to the activity's | |
* [onCreateOptionsMenu](Titanium.Android.Activity.onCreateOptionsMenu) property. | |
* The activity's menu object is passed in to the `onCreateOptionsMenu` function when the menu is created. | |
* Use the Menu's [add()](Titanium.Android.Menu.add) method to create new action items. | |
* | |
* In Alloy you can use `<Menu>` and `<MenuItem>` elements to create an options menu. | |
* | |
* <Menu id="menu" platform="android"> | |
* <!-- Cannot specify node text. Use attributes only. --> | |
* <MenuItem id="saveitem" title="Save" icon="item1.png" onClick="doSave" /> | |
* <MenuItem id="closeitem" title="Close" icon="item1.png" onClick="doClose" /> | |
* </Menu> | |
* | |
* To switch menu items dynamically, call | |
* [invalidateOptionsMenu](Titanium.Android.Activity.invalidateOptionsMenu), which causes | |
* the `onCreateOptionsMenu` callback to be called again. | |
* | |
* #### Menus on Tab Groups | |
* | |
* Menus must be added to tab groups using the tab group's | |
* activity. These changes were required to support the Android 3.0 action bar. | |
* | |
* The TabGroup activity is available using [TabGroup.getActivity](Titanium.UI.TabGroup.getActivity). | |
* However, unlike a window's activity it is not currently possible to set properties on | |
* the tab group's activity before the tab group is opened. To add a menu to a tab group, | |
* set the `onCreateOptionsMenu` property to the tab group's `open` event listener, and | |
* then call `invalidateOptionsMenu` to force the changes to take effect. | |
* | |
* tabGroup.addEventListener("open", function(e) { | |
* var activity = globals.tabs.getActivity(); | |
* activity.onCreateOptionsMenu = function(e) { | |
* var menuItem = e.menu.add({ | |
* title : "Add Task", | |
* showAsAction : Ti.Android.SHOW_AS_ACTION_ALWAYS, | |
* icon : "add_icon.png" | |
* }); | |
* menuItem.addEventListener("click", function(e) { | |
* // | |
* }); | |
* } | |
* activity.invalidateOptionsMenu(); | |
* }); | |
* | |
* | |
* ### Application Notes for Release 3.2.x and earlier | |
* | |
* If you are using Release 3.2.x and earlier, the options menu is presented differently | |
* based on the Android version and application settings. | |
* | |
* On Android devices prior to Android 3.0 (API level 11), the menu is always presented | |
* as an options menu, which is displayed when the **Menu** button is pressed. | |
* | |
* On Android 3.0 and later, menu items can be displayed as _action items_ in the action | |
* bar. To enable this, the application must be built with a theme that supports the | |
* action bar, such as the Holo theme. (See | |
* [Android Themes](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Themes) in | |
* the Titanium Guides for information on setting your application's theme.) | |
* | |
* For menu items displayed in the menu, the `onCreateOptionsMenu` function is called | |
* once, and the [onPrepareOptionsMenu](Titanium.Android.Activity.onPrepareOptionsMenu) callback function is called each | |
* time the menu is opened. The `onPrepareOptionsMenu` function can be used to switch menu items dynamically. | |
* | |
* #### Further Reading | |
* | |
* See also: | |
* | |
* * [Menus](https://developer.android.com/guide/topics/ui/menus.html) in the | |
* Android Developer Guides. | |
* | |
* * [Action Bar](https://developer.android.com/guide/topics/ui/actionbar.html) in | |
* the Android Developer Guides. | |
* | |
* * [Menu](https://developer.android.com/reference/android/view/Menu.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Menu = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Menu.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Menu.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Menu.prototype.lifecycleContainer; | |
/** | |
* Array of menu items in this menu. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Array<Titanium.Android.MenuItem>} items | |
*/ | |
Titanium.Android.Menu.prototype.items; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Menu.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Menu.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Menu.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Menu.applyProperties = function(props) {}; | |
/** | |
* Creates a <Titanium.Android.MenuItem> from the passed creation options. | |
* @since 1.5 (Android) | |
* @param {Object} options Creation options. Supported options are | |
* [itemId](Titanium.Android.MenuItem.itemId), | |
* [groupId](Titanium.Android.MenuItem.groupId), | |
* [title](Titanium.Android.MenuItem.title), | |
* [order](Titanium.Android.MenuItem.order), | |
* [actionView](Titanium.Android.MenuItem.actionView), | |
* [checkable](Titanium.Android.MenuItem.checkable), | |
* [checked](Titanium.Android.MenuItem.checked), | |
* [enabled](Titanium.Android.MenuItem.enabled), | |
* [icon](Titanium.Android.MenuItem.icon), | |
* [showAsAction](Titanium.Android.MenuItem.showAsAction), | |
* [titleCondensed](Titanium.Android.MenuItem.titleCondensed), and | |
* [visible](Titanium.Android.MenuItem.visible). | |
* | |
* @return {Titanium.Android.MenuItem} | |
*/ | |
Titanium.Android.Menu.add = function(options) {}; | |
/** | |
* Clears all items from this menu. | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Menu.clear = function() {}; | |
/** | |
* Closes the menu, if visible. | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Menu.close = function() {}; | |
/** | |
* Locates a [MenuItem](Titanium.Android.MenuItem) in this menu, by item ID or reference. | |
* @since 1.5 (Android) | |
* @param {Number|Titanium.Android.MenuItem} item Integer [itemId](Titanium.Android.MenuItem.itemId) or a reference to a `MenuItem` object. | |
* @return {Titanium.Android.MenuItem} | |
*/ | |
Titanium.Android.Menu.findItem = function(item) {}; | |
/** | |
* Returns the [MenuItem](Titanium.Android.MenuItem) at a specific index. | |
* @since 1.5 (Android) | |
* @param {Number} index Index of the menu item to return. | |
* @return {Titanium.Android.MenuItem} | |
*/ | |
Titanium.Android.Menu.getItem = function(index) {}; | |
/** | |
* Returns `true` if this menu has visible items. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Menu.hasVisibleItems = function() {}; | |
/** | |
* Removes all menu items with the specified | |
* [groupId](Titanium.Android.MenuItem.groupId). | |
* | |
* @since 1.5 (Android) | |
* @param {Number} groupId Group ID of items to remove. | |
*/ | |
Titanium.Android.Menu.removeGroup = function(groupId) {}; | |
/** | |
* Removes a specific [MenuItem](Titanium.Android.MenuItem) identified by its | |
* [itemId](Titanium.Android.MenuItem.itemId). | |
* | |
* @since 1.5 (Android) | |
* @param {Number} itemId Item ID of item to remove. | |
*/ | |
Titanium.Android.Menu.removeItem = function(itemId) {}; | |
/** | |
* Enables or disables a group of menu items identified by a | |
* [groupId](Titanium.Android.MenuItem.groupId). | |
* | |
* @since 1.5 (Android) | |
* @param {Number} groupId ID of the group to enable or disable. | |
* @param {Boolean} enabled True to enable the specified group, false to disable it. | |
*/ | |
Titanium.Android.Menu.setGroupEnabled = function(groupId, enabled) {}; | |
/** | |
* Shows or hides a group of menu items identified by a | |
* [groupId](Titanium.Android.MenuItem.groupId). | |
* | |
* @since 1.5 (Android) | |
* @param {Number} groupId Group ID to enable or disable. | |
* @param {Boolean} visible True to show the group, false to hide it. | |
*/ | |
Titanium.Android.Menu.setGroupVisible = function(groupId, visible) {}; | |
/** | |
* Number of items in this menu. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Menu.size = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Menu.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Menu.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Menu.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Menu.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Menu.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Menu.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Menu.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Menu.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Menu.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Menu.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Menu.items> property. | |
* @since 1.5 (Android) | |
* @return {Array<Titanium.Android.MenuItem>} | |
*/ | |
Titanium.Android.Menu.getItems = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android._Dictionary_Menu; | |
/** | |
* The Titanium binding of an Android menu item. | |
* @extends {Titanium.Proxy} | |
* @description As of Release 3.3.0, the Menu and MenuItem APIs are used to create action items for the action bar. | |
* Prior to Release 3.3.0, the APIs could also be used to customize the Options Menu. | |
* | |
* In JavaScript, use the Menu's [add()](Titanium.Android.Menu.add) method to create | |
* new action items. | |
* | |
* In Alloy you can define **`<MenuItem>`** elements inside a `<Menu>` element. | |
* | |
* <Menu id="menu" platform="android"> | |
* <MenuItem id="saveitem" title="Save" icon="item1.png" onClick="doSave" /> | |
* <MenuItem id="closeitem" title="Close" icon="item1.png" onClick="doClose" /> | |
* </Menu> | |
* | |
* Action items can appear in either the action bar or the action bar's | |
* overflow menu. To determine how an action item is displayed, set | |
* [showAsAction](Titanium.Android.MenuItem.showAsAction). | |
* | |
* You can optionally customize the look of action items using the | |
* [actionView](Titanium.Android.MenuItem.actionView) property. | |
* | |
* See the <Titanium.Android.Menu> reference page for additional code examples. | |
* | |
* Further Reading: | |
* | |
* * [Android Developers: MenuItem](https://developer.android.com/reference/android/view/MenuItem.html) | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.MenuItem = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.MenuItem.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.MenuItem.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.MenuItem.prototype.lifecycleContainer; | |
/** | |
* Briefly describes what performing an action (such as a click) on the view will do. | |
* @since 8.2.0 (Android) | |
* @type {String} accessibilityHint | |
*/ | |
Titanium.Android.MenuItem.prototype.accessibilityHint; | |
/** | |
* A succint label identifying the view for the device's accessibility service. | |
* @since 8.2.0 (Android) | |
* @type {String} accessibilityLabel | |
*/ | |
Titanium.Android.MenuItem.prototype.accessibilityLabel; | |
/** | |
* A string describing the value (if any) of the view for the device's accessibility service. | |
* @since 8.2.0 (Android) | |
* @type {String} accessibilityValue | |
*/ | |
Titanium.Android.MenuItem.prototype.accessibilityValue; | |
/** | |
* Custom view that replaces the default menu item button. | |
* @since 3.0.0 (Android) | |
* @type {Titanium.UI.View} actionView | |
*/ | |
Titanium.Android.MenuItem.prototype.actionView; | |
/** | |
* True if this menu item's action view has been expanded. | |
* @since 3.0.0 (Android) | |
* @readonly | |
* @type {Boolean} actionViewExpanded | |
*/ | |
Titanium.Android.MenuItem.prototype.actionViewExpanded; | |
/** | |
* Determines if the item can be checked. | |
* @since 1.5 (Android) | |
* @type {Boolean} checkable | |
*/ | |
Titanium.Android.MenuItem.prototype.checkable; | |
/** | |
* Determines if the item is checked. | |
* @since 1.5 (Android) | |
* @type {Boolean} checked | |
*/ | |
Titanium.Android.MenuItem.prototype.checked; | |
/** | |
* Determines if the item is enabled. | |
* @since 1.5 (Android) | |
* @type {Boolean} enabled | |
*/ | |
Titanium.Android.MenuItem.prototype.enabled; | |
/** | |
* Group ID for this item. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} groupId | |
*/ | |
Titanium.Android.MenuItem.prototype.groupId; | |
/** | |
* Icon to display for the this menu item. | |
* @since 1.5 (Android) | |
* @type {Number|String} icon | |
*/ | |
Titanium.Android.MenuItem.prototype.icon; | |
/** | |
* Item ID for this item. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} itemId | |
*/ | |
Titanium.Android.MenuItem.prototype.itemId; | |
/** | |
* Integer used for controlling the category and sort order for menu items. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} order | |
*/ | |
Titanium.Android.MenuItem.prototype.order; | |
/** | |
* A set of flags that controls how this item appears in the action bar. | |
* @since 3.0.0 (Android) | |
* @type {Number} showAsAction | |
*/ | |
Titanium.Android.MenuItem.prototype.showAsAction; | |
/** | |
* Title of the item. | |
* @since 1.5 (Android) | |
* @type {String} title | |
*/ | |
Titanium.Android.MenuItem.prototype.title; | |
/** | |
* Shortened version of the item's title. | |
* @since 1.5 (Android) | |
* @type {String} titleCondensed | |
*/ | |
Titanium.Android.MenuItem.prototype.titleCondensed; | |
/** | |
* Determines whether the menu item is visible. | |
* @since 1.5 (Android) | |
* @type {Boolean} visible | |
*/ | |
Titanium.Android.MenuItem.prototype.visible; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.MenuItem.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.MenuItem.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.MenuItem.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.MenuItem.applyProperties = function(props) {}; | |
/** | |
* Collapse the action view associated with this menu item. | |
* @since 3.0.0 (Android) | |
*/ | |
Titanium.Android.MenuItem.collapseActionView = function() {}; | |
/** | |
* Expand the action view associated with this menu item. | |
* @since 3.0.0 (Android) | |
*/ | |
Titanium.Android.MenuItem.expandActionView = function() {}; | |
/** | |
* Returns the [actionViewExpanded](Titanium.Android.MenuItem.actionViewExpanded) state of the menu item. | |
* | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.MenuItem.isActionViewExpanded = function() {}; | |
/** | |
* Returns the [checkable](Titanium.Android.MenuItem.checkable) state of the menu item. | |
* | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.MenuItem.isCheckable = function() {}; | |
/** | |
* Returns the [checked](Titanium.Android.MenuItem.checked) state of the menu item. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.MenuItem.isChecked = function() {}; | |
/** | |
* Returns the [enabled](Titanium.Android.MenuItem.enabled) state of the menu item. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.MenuItem.isEnabled = function() {}; | |
/** | |
* Returns the [visible](Titanium.Android.MenuItem.visible) state of the menu item. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.MenuItem.isVisible = function() {}; | |
/** | |
* Sets the [checkable](Titanium.Android.MenuItem.checkable) state of the menu item. | |
* @since 1.5 (Android) | |
* @param {Boolean} checkable True enable checking and unchecking this item, false to disable it. | |
*/ | |
Titanium.Android.MenuItem.setCheckable = function(checkable) {}; | |
/** | |
* Sets the [checked](Titanium.Android.MenuItem.checked) state of the menu item. | |
* @since 1.5 (Android) | |
* @param {Boolean} enabled True to check the item, false to uncheck it. | |
*/ | |
Titanium.Android.MenuItem.setChecked = function(enabled) {}; | |
/** | |
* Sets the [enabled](Titanium.Android.MenuItem.enabled) state of the menu item. | |
* @since 1.5 (Android) | |
* @param {Boolean} enabled True to enable item, false to disable it. | |
*/ | |
Titanium.Android.MenuItem.setEnabled = function(enabled) {}; | |
/** | |
* Sets the [visible](Titanium.Android.MenuItem.visible) state of the menu item. | |
* @since 1.5 (Android) | |
* @param {Boolean} visible True to show the item, false to hide it. | |
*/ | |
Titanium.Android.MenuItem.setVisible = function(visible) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.MenuItem.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.MenuItem.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.MenuItem.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.accessibilityHint> property. | |
* @since 8.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.MenuItem.getAccessibilityHint = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.accessibilityHint> property. | |
* @since 8.2.0 (Android) | |
* @param {String} accessibilityHint New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setAccessibilityHint = function(accessibilityHint) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.accessibilityLabel> property. | |
* @since 8.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.MenuItem.getAccessibilityLabel = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.accessibilityLabel> property. | |
* @since 8.2.0 (Android) | |
* @param {String} accessibilityLabel New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setAccessibilityLabel = function(accessibilityLabel) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.accessibilityValue> property. | |
* @since 8.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.MenuItem.getAccessibilityValue = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.accessibilityValue> property. | |
* @since 8.2.0 (Android) | |
* @param {String} accessibilityValue New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setAccessibilityValue = function(accessibilityValue) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.actionView> property. | |
* @since 3.0.0 (Android) | |
* @return {Titanium.UI.View} | |
*/ | |
Titanium.Android.MenuItem.getActionView = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.actionView> property. | |
* @since 3.0.0 (Android) | |
* @param {Titanium.UI.View} actionView New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setActionView = function(actionView) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.groupId> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.MenuItem.getGroupId = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.icon> property. | |
* @since 1.5 (Android) | |
* @param {Number|String} icon New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setIcon = function(icon) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.itemId> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.MenuItem.getItemId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.order> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.MenuItem.getOrder = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.showAsAction> property. | |
* @since 3.0.0 (Android) | |
* @param {Number} showAsAction New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setShowAsAction = function(showAsAction) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.title> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.MenuItem.getTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.title> property. | |
* @since 1.5 (Android) | |
* @param {String} title New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setTitle = function(title) {}; | |
/** | |
* Gets the value of the <Titanium.Android.MenuItem.titleCondensed> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.MenuItem.getTitleCondensed = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.MenuItem.titleCondensed> property. | |
* @since 1.5 (Android) | |
* @param {String} titleCondensed New value for the property. | |
*/ | |
Titanium.Android.MenuItem.setTitleCondensed = function(titleCondensed) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* accessibilityHint: String, | |
* accessibilityLabel: String, | |
* accessibilityValue: String, | |
* actionView: Titanium.UI.View, | |
* checkable: Boolean, | |
* checked: Boolean, | |
* enabled: Boolean, | |
* icon: (Number|String), | |
* showAsAction: Number, | |
* title: String, | |
* titleCondensed: String, | |
* visible: Boolean | |
* }} | |
*/ | |
Titanium.Android._Dictionary_MenuItem; | |
/** | |
* UI notifications that can be sent while the application is in the background. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description Notifications alert the user that something is happening to your application while it is | |
* in the background. Notifications appear in the notification drawer until the user | |
* clears them and on the lock screen for devices running Android 5.0 or greater. | |
* Note that the user can filter or turn notifications on and off from **Settings**. | |
* | |
* For Android toast notifications (pop-up notifications sent while the application is in the | |
* foreground), see <Titanium.UI.Notification>. | |
* | |
* To create a notification, use the <Titanium.Android.createNotification> method. | |
* | |
* Pass the Notification object to the methods of the <Titanium.Android.NotificationManager> class | |
* to send or cancel notifications. | |
* | |
* For examples of using Notifications, see [Android Notifications](#!/guide/Android_Notifications). | |
* | |
* Further Reading: | |
* | |
* * [Android Developers: Notifications](https://developer.android.com/design/patterns/notifications.html) | |
* | |
* #### Android 5.0 Changes | |
* | |
* Starting with Android 5.0 (API 21), ticker text, defined with the `tickerText` property, | |
* no longer appears in the status bar when the notification is first sent but is used as an | |
* audible notification if accessibility services are enabled. | |
* | |
* Notifications now appear in the lock screen. The user can customize the visibility level of | |
* these notifications from **Settings**. The visibility level is based on the `visibility` | |
* property set on the notification. | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Notification = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Notification.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Notification.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Notification.prototype.lifecycleContainer; | |
/** | |
* The audio stream type to use when playing the sound. | |
* @since 1.5 (Android) | |
* @type {Number} audioStreamType | |
*/ | |
Titanium.Android.Notification.prototype.audioStreamType; | |
/** | |
* Sets the notification's category. | |
* @since 3.6.0 (Android) | |
* @type {String} category | |
*/ | |
Titanium.Android.Notification.prototype.category; | |
/** | |
* The `PendingIntent` to execute when the expanded status entry is clicked. | |
* @since 1.5 (Android) | |
* @type {Titanium.Android.PendingIntent} contentIntent | |
*/ | |
Titanium.Android.Notification.prototype.contentIntent; | |
/** | |
* Description text of the notification. | |
* @since 1.5 (Android) | |
* @type {String} contentText | |
*/ | |
Titanium.Android.Notification.prototype.contentText; | |
/** | |
* Title of the notification. | |
* @since 1.5 (Android) | |
* @type {String} contentTitle | |
*/ | |
Titanium.Android.Notification.prototype.contentTitle; | |
/** | |
* Custom layout to display in the notification. | |
* @since 1.5 (Android) | |
* @type {Titanium.Android.RemoteViews} contentView | |
*/ | |
Titanium.Android.Notification.prototype.contentView; | |
/** | |
* Specifies which values should be taken from the defaults. | |
* @since 1.5 (Android) | |
* @type {Number} defaults | |
*/ | |
Titanium.Android.Notification.prototype.defaults; | |
/** | |
* The `PendingIntent` to execute when the status entry is deleted by the user with the "Clear All Notifications" button. | |
* @since 1.5 (Android) | |
* @type {Titanium.Android.PendingIntent} deleteIntent | |
*/ | |
Titanium.Android.Notification.prototype.deleteIntent; | |
/** | |
* Set of flags for the notification. | |
* @since 1.5 (Android) | |
* @type {Number} flags | |
*/ | |
Titanium.Android.Notification.prototype.flags; | |
/** | |
* The group key that the notification will belong to. | |
* @since 6.2.0 (Android) | |
* @type {String} groupKey | |
*/ | |
Titanium.Android.Notification.prototype.groupKey; | |
/** | |
* Specifies if this is a group summary notification. | |
* @since 6.2.0 (Android) | |
* @type {Boolean} groupSummary | |
*/ | |
Titanium.Android.Notification.prototype.groupSummary; | |
/** | |
* Notification icon, specified as an Android resource ID, or a local URL to a density-specific image. | |
* @since 1.5 (Android) | |
* @type {Number|String} icon | |
*/ | |
Titanium.Android.Notification.prototype.icon; | |
/** | |
* Add a large icon to the notification (and the ticker on some devices) specified as an Android resource ID, or a local URL to a density-specific image. | |
* @since 4.2.0 (Android) | |
* @type {Number|String} largeIcon | |
*/ | |
Titanium.Android.Notification.prototype.largeIcon; | |
/** | |
* Accent color used behind icon. | |
* @since 7.0.0 (Android) | |
* @type {String} color | |
*/ | |
Titanium.Android.Notification.prototype.color; | |
/** | |
* The color for the LED to blink. | |
* @since 1.5 (Android) | |
* @type {Number} ledARGB | |
*/ | |
Titanium.Android.Notification.prototype.ledARGB; | |
/** | |
* The number of milliseconds for the LED to be off while it's flashing. | |
* @since 1.5 (Android) | |
* @type {Number} ledOffMS | |
*/ | |
Titanium.Android.Notification.prototype.ledOffMS; | |
/** | |
* The number of milliseconds for the LED to be on while it's flashing. | |
* @since 1.5 (Android) | |
* @type {Number} ledOnMS | |
*/ | |
Titanium.Android.Notification.prototype.ledOnMS; | |
/** | |
* The number of events that this notification represents. | |
* @since 1.5 (Android) | |
* @type {Number} number | |
*/ | |
Titanium.Android.Notification.prototype.number; | |
/** | |
* Sets the priority of the notification. | |
* @since 3.6.0 (Android) | |
* @type {Number} priority | |
*/ | |
Titanium.Android.Notification.prototype.priority; | |
/** | |
* A URL to the sound to play. | |
* @since 1.5 (Android) | |
* @type {String} sound | |
*/ | |
Titanium.Android.Notification.prototype.sound; | |
/** | |
* Style object that can apply a rich notification style. | |
* @since 5.4.0 (Android) | |
* @type {Titanium.Android.BigTextStyle|Titanium.Android.BigPictureStyle} style | |
*/ | |
Titanium.Android.Notification.prototype.style; | |
/** | |
* Text to scroll across the screen when this item is added to the status bar. | |
* @since 1.5 (Android) | |
* @type {String} tickerText | |
*/ | |
Titanium.Android.Notification.prototype.tickerText; | |
/** | |
* Allows user to conceal private information of the notification on the lockscreen. | |
* @since 3.6.0 (Android) | |
* @type {Number} visibility | |
*/ | |
Titanium.Android.Notification.prototype.visibility; | |
/** | |
* Will wake up the device for the given time (in milliseconds) when the notification is shown. | |
* The application needs to also set the `android.permission.WAKE_LOCK` permission | |
* in the Android manifest section of the `tiapp.xml` file. | |
* | |
* <ti:app> | |
* <android> | |
* <manifest> | |
* <uses-permission android:name="android.permission.WAKE_LOCK" /> | |
* </manifest> | |
* </android> | |
* </ti:app> | |
* | |
* @since 6.2.0 (Android) | |
* @type {wakeLockOptions} wakeLock | |
*/ | |
Titanium.Android.Notification.prototype.wakeLock; | |
/** | |
* The timestamp for the notification (defaults to the current time). | |
* @since 1.5 (Android) | |
* @type {Date|Number} when | |
*/ | |
Titanium.Android.Notification.prototype.when; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Notification.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Notification.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Notification.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Notification.prototype.applyProperties = function(props) {}; | |
/** | |
* Sets the latest event info using the built-in notification view for this notification. | |
* @since 1.5 (Android) | |
* @param {String} contentTitle Title to display when the notification is expanded. | |
* @param {String} contentText Text to display when the notification is expanded. | |
* @param {Titanium.Android.PendingIntent} contentIntent Intent to launch when the user clicks on the notification. | |
*/ | |
Titanium.Android.Notification.prototype.setLatestEventInfo = function(contentTitle, contentText, contentIntent) {}; | |
/** | |
* Set the progress this notification represents. | |
* @since 6.1.0 (Android) | |
* @param {Number} max Defines the maximum value the progress can take. | |
* @param {Number} progress Defines the progress value, between 0 and max. | |
* @param {Boolean} indeterminate Allows to enable the indeterminate mode. | |
*/ | |
Titanium.Android.Notification.prototype.setProgress = function(max, progress, indeterminate) {}; | |
/** | |
* Add an action button to the notification | |
* @since 6.2.0 (Android) | |
* @param {Number|String} icon Icon of the action button as URL or resource ID | |
* @param {String} title Title of the action button | |
* @param {Titanium.Android.PendingIntent} intent Intent of the action button | |
*/ | |
Titanium.Android.Notification.prototype.addAction = function(icon, title, intent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Notification.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Notification.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.audioStreamType> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getAudioStreamType = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.audioStreamType> property. | |
* @since 1.5 (Android) | |
* @param {Number} audioStreamType New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setAudioStreamType = function(audioStreamType) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.category> property. | |
* @since 3.6.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getCategory = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.category> property. | |
* @since 3.6.0 (Android) | |
* @param {String} category New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setCategory = function(category) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.contentIntent> property. | |
* @since 1.5 (Android) | |
* @return {Titanium.Android.PendingIntent} | |
*/ | |
Titanium.Android.Notification.prototype.getContentIntent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.contentIntent> property. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.PendingIntent} contentIntent New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setContentIntent = function(contentIntent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.contentText> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getContentText = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.contentText> property. | |
* @since 1.5 (Android) | |
* @param {String} contentText New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setContentText = function(contentText) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.contentTitle> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getContentTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.contentTitle> property. | |
* @since 1.5 (Android) | |
* @param {String} contentTitle New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setContentTitle = function(contentTitle) {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.contentView> property. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.RemoteViews} contentView New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setContentView = function(contentView) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.defaults> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getDefaults = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.defaults> property. | |
* @since 1.5 (Android) | |
* @param {Number} defaults New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setDefaults = function(defaults) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.deleteIntent> property. | |
* @since 1.5 (Android) | |
* @return {Titanium.Android.PendingIntent} | |
*/ | |
Titanium.Android.Notification.prototype.getDeleteIntent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.deleteIntent> property. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.PendingIntent} deleteIntent New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setDeleteIntent = function(deleteIntent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.flags> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getFlags = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.flags> property. | |
* @since 1.5 (Android) | |
* @param {Number} flags New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setFlags = function(flags) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.groupKey> property. | |
* @since 6.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getGroupKey = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.groupKey> property. | |
* @since 6.2.0 (Android) | |
* @param {String} groupKey New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setGroupKey = function(groupKey) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.groupSummary> property. | |
* @since 6.2.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Notification.prototype.getGroupSummary = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.groupSummary> property. | |
* @since 6.2.0 (Android) | |
* @param {Boolean} groupSummary New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setGroupSummary = function(groupSummary) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.icon> property. | |
* @since 1.5 (Android) | |
* @return {Number|String} | |
*/ | |
Titanium.Android.Notification.prototype.getIcon = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.icon> property. | |
* @since 1.5 (Android) | |
* @param {Number|String} icon New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setIcon = function(icon) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.largeIcon> property. | |
* @since 4.2.0 (Android) | |
* @return {Number|String} | |
*/ | |
Titanium.Android.Notification.prototype.getLargeIcon = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.largeIcon> property. | |
* @since 4.2.0 (Android) | |
* @param {Number|String} largeIcon New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setLargeIcon = function(largeIcon) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.color> property. | |
* @since 7.0.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getColor = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.color> property. | |
* @since 7.0.0 (Android) | |
* @param {String} color New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setColor = function(color) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.ledARGB> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getLedARGB = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.ledARGB> property. | |
* @since 1.5 (Android) | |
* @param {Number} ledARGB New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setLedARGB = function(ledARGB) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.ledOffMS> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getLedOffMS = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.ledOffMS> property. | |
* @since 1.5 (Android) | |
* @param {Number} ledOffMS New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setLedOffMS = function(ledOffMS) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.ledOnMS> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getLedOnMS = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.ledOnMS> property. | |
* @since 1.5 (Android) | |
* @param {Number} ledOnMS New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setLedOnMS = function(ledOnMS) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.number> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getNumber = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.number> property. | |
* @since 1.5 (Android) | |
* @param {Number} number New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setNumber = function(number) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.priority> property. | |
* @since 3.6.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getPriority = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.priority> property. | |
* @since 3.6.0 (Android) | |
* @param {Number} priority New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setPriority = function(priority) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.sound> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getSound = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.sound> property. | |
* @since 1.5 (Android) | |
* @param {String} sound New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setSound = function(sound) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.style> property. | |
* @since 5.4.0 (Android) | |
* @return {Titanium.Android.BigTextStyle|Titanium.Android.BigPictureStyle} | |
*/ | |
Titanium.Android.Notification.prototype.getStyle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.style> property. | |
* @since 5.4.0 (Android) | |
* @param {Titanium.Android.BigTextStyle|Titanium.Android.BigPictureStyle} style New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setStyle = function(style) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.tickerText> property. | |
* @since 1.5 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Notification.prototype.getTickerText = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.tickerText> property. | |
* @since 1.5 (Android) | |
* @param {String} tickerText New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setTickerText = function(tickerText) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.visibility> property. | |
* @since 3.6.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Notification.prototype.getVisibility = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.visibility> property. | |
* @since 3.6.0 (Android) | |
* @param {Number} visibility New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setVisibility = function(visibility) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.wakeLock> property. | |
* @since 6.2.0 (Android) | |
* @return {wakeLockOptions} | |
*/ | |
Titanium.Android.Notification.prototype.getWakeLock = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.wakeLock> property. | |
* @since 6.2.0 (Android) | |
* @param {wakeLockOptions} wakeLock New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setWakeLock = function(wakeLock) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Notification.when> property. | |
* @since 1.5 (Android) | |
* @return {Date|Number} | |
*/ | |
Titanium.Android.Notification.prototype.getWhen = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Notification.when> property. | |
* @since 1.5 (Android) | |
* @param {Date|Number} when New value for the property. | |
*/ | |
Titanium.Android.Notification.prototype.setWhen = function(when) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* audioStreamType: Number, | |
* category: String, | |
* contentIntent: Titanium.Android.PendingIntent, | |
* contentText: String, | |
* contentTitle: String, | |
* contentView: Titanium.Android.RemoteViews, | |
* defaults: Number, | |
* deleteIntent: Titanium.Android.PendingIntent, | |
* flags: Number, | |
* groupKey: String, | |
* groupSummary: Boolean, | |
* icon: (Number|String), | |
* largeIcon: (Number|String), | |
* color: String, | |
* ledARGB: Number, | |
* ledOffMS: Number, | |
* ledOnMS: Number, | |
* number: Number, | |
* priority: Number, | |
* sound: String, | |
* style: (Titanium.Android.BigTextStyle|Titanium.Android.BigPictureStyle), | |
* tickerText: String, | |
* visibility: Number, | |
* wakeLock: wakeLockOptions, | |
* when: (Date|Number) | |
* }} | |
*/ | |
Titanium.Android._Dictionary_Notification; | |
/** | |
* Module for notification channels. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description You can create a notification channel for each distinct type of notification you need to send. | |
* | |
* To create a notification channel, use the <Titanium.Android.createNotificationChannel> method. | |
* | |
* Further Reading: | |
* | |
* * [Android Developers: Notification Channel](https://developer.android.com/reference/android/app/NotificationChannel.html) | |
* | |
* @since 7.0.0 (Android) | |
*/ | |
Titanium.Android.NotificationChannel = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 7.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.NotificationChannel.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 7.0.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.NotificationChannel.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 7.0.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.NotificationChannel.prototype.lifecycleContainer; | |
/** | |
* Whether or not notifications posted to this channel can interrupt the user. | |
* @since 7.0.0 (Android) | |
* @type {Boolean} bypassDnd | |
*/ | |
Titanium.Android.NotificationChannel.prototype.bypassDnd; | |
/** | |
* User visible description of this channel. | |
* @since 7.0.0 (Android) | |
* @type {String} description | |
*/ | |
Titanium.Android.NotificationChannel.prototype.description; | |
/** | |
* Whether notifications posted to this channel should display notification lights | |
* @since 7.0.0 (Android) | |
* @type {Boolean} enableLights | |
*/ | |
Titanium.Android.NotificationChannel.prototype.enableLights; | |
/** | |
* Whether notification posted to this channel should vibrate. | |
* @since 7.0.0 (Android) | |
* @type {Boolean} enableVibration | |
*/ | |
Titanium.Android.NotificationChannel.prototype.enableVibration; | |
/** | |
* Group id this channel belongs to. | |
* @since 7.0.0 (Android) | |
* @type {String} groupId | |
*/ | |
Titanium.Android.NotificationChannel.prototype.groupId; | |
/** | |
* The audio stream type to use when playing the sound. | |
* @since 7.0.0 (Android) | |
* @type {Number} importance | |
*/ | |
Titanium.Android.NotificationChannel.prototype.importance; | |
/** | |
* The channel id specified for the notification channel. | |
* @since 7.0.0 (Android) | |
* @type {String} id | |
*/ | |
Titanium.Android.NotificationChannel.prototype.id; | |
/** | |
* The notification light color for notifications posted to this channel. | |
* @since 7.0.0 (Android) | |
* @type {Number} lightColor | |
*/ | |
Titanium.Android.NotificationChannel.prototype.lightColor; | |
/** | |
* Whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form. | |
* @since 7.0.0 (Android) | |
* @type {Number} lockscreenVisibility | |
*/ | |
Titanium.Android.NotificationChannel.prototype.lockscreenVisibility; | |
/** | |
* Whether notifications posted to this channel can appear as application icon badges in a Launcher. | |
* @since 7.0.0 (Android) | |
* @type {Boolean} showBadge | |
*/ | |
Titanium.Android.NotificationChannel.prototype.showBadge; | |
/** | |
* A URL to the sound to play. | |
* @since 7.5.0 (Android) | |
* @type {String} sound | |
*/ | |
Titanium.Android.NotificationChannel.prototype.sound; | |
/** | |
* The vibration pattern for notifications posted to this channel. | |
* @since 7.0.0 (Android) | |
* @type {Array<Number>} vibratePattern | |
*/ | |
Titanium.Android.NotificationChannel.prototype.vibratePattern; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 7.0.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 7.0.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 7.0.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 7.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.bubbleParent> property. | |
* @since 7.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.bubbleParent> property. | |
* @since 7.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.apiName> property. | |
* @since 7.0.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.lifecycleContainer> property. | |
* @since 7.0.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.lifecycleContainer> property. | |
* @since 7.0.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.bypassDnd> property. | |
* @since 7.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getBypassDnd = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.bypassDnd> property. | |
* @since 7.0.0 (Android) | |
* @param {Boolean} bypassDnd New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setBypassDnd = function(bypassDnd) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.description> property. | |
* @since 7.0.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getDescription = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.description> property. | |
* @since 7.0.0 (Android) | |
* @param {String} description New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setDescription = function(description) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.enableLights> property. | |
* @since 7.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getEnableLights = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.enableLights> property. | |
* @since 7.0.0 (Android) | |
* @param {Boolean} enableLights New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setEnableLights = function(enableLights) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.enableVibration> property. | |
* @since 7.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getEnableVibration = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.enableVibration> property. | |
* @since 7.0.0 (Android) | |
* @param {Boolean} enableVibration New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setEnableVibration = function(enableVibration) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.groupId> property. | |
* @since 7.0.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getGroupId = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.groupId> property. | |
* @since 7.0.0 (Android) | |
* @param {String} groupId New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setGroupId = function(groupId) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.importance> property. | |
* @since 7.0.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getImportance = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.importance> property. | |
* @since 7.0.0 (Android) | |
* @param {Number} importance New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setImportance = function(importance) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.id> property. | |
* @since 7.0.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getId = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.id> property. | |
* @since 7.0.0 (Android) | |
* @param {String} id New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setId = function(id) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.lightColor> property. | |
* @since 7.0.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getLightColor = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.lightColor> property. | |
* @since 7.0.0 (Android) | |
* @param {Number} lightColor New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setLightColor = function(lightColor) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.lockscreenVisibility> property. | |
* @since 7.0.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getLockscreenVisibility = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.lockscreenVisibility> property. | |
* @since 7.0.0 (Android) | |
* @param {Number} lockscreenVisibility New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setLockscreenVisibility = function(lockscreenVisibility) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.showBadge> property. | |
* @since 7.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getShowBadge = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.showBadge> property. | |
* @since 7.0.0 (Android) | |
* @param {Boolean} showBadge New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setShowBadge = function(showBadge) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.sound> property. | |
* @since 7.5.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getSound = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.sound> property. | |
* @since 7.5.0 (Android) | |
* @param {String} sound New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setSound = function(sound) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationChannel.vibratePattern> property. | |
* @since 7.0.0 (Android) | |
* @return {Array<Number>} | |
*/ | |
Titanium.Android.NotificationChannel.prototype.getVibratePattern = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationChannel.vibratePattern> property. | |
* @since 7.0.0 (Android) | |
* @param {Array<Number>} vibratePattern New value for the property. | |
*/ | |
Titanium.Android.NotificationChannel.prototype.setVibratePattern = function(vibratePattern) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* bypassDnd: Boolean, | |
* description: String, | |
* enableLights: Boolean, | |
* enableVibration: Boolean, | |
* groupId: String, | |
* importance: Number, | |
* id: String, | |
* lightColor: Number, | |
* lockscreenVisibility: Number, | |
* showBadge: Boolean, | |
* sound: String, | |
* vibratePattern: Array<Number> | |
* }} | |
*/ | |
Titanium.Android._Dictionary_NotificationChannel; | |
/** | |
* Module for managing notifications. | |
* @extends {Titanium.Module} | |
* @description This module provides methods for sending and canceling notifications, | |
* which are represented by the <Titanium.Android.Notification> object. | |
* | |
* Further Reading: | |
* | |
* * [Android Notifications guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Notifications) | |
* * [Android Developer: Notifications](https://developer.android.com/guide/topics/ui/notifiers/notifications.html) | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.NotificationManager = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.NotificationManager.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.NotificationManager.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.NotificationManager.prototype.lifecycleContainer; | |
/** | |
* Use <Titanium.Android.DEFAULT_ALL> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_ALL | |
*/ | |
Titanium.Android.NotificationManager.DEFAULT_ALL; | |
/** | |
* Use <Titanium.Android.DEFAULT_LIGHTS> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_LIGHTS | |
*/ | |
Titanium.Android.NotificationManager.DEFAULT_LIGHTS; | |
/** | |
* Use <Titanium.Android.DEFAULT_SOUND> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_SOUND | |
*/ | |
Titanium.Android.NotificationManager.DEFAULT_SOUND; | |
/** | |
* Use <Titanium.Android.DEFAULT_VIBRATE> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} DEFAULT_VIBRATE | |
*/ | |
Titanium.Android.NotificationManager.DEFAULT_VIBRATE; | |
/** | |
* Use <Titanium.Android.FLAG_AUTO_CANCEL> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_AUTO_CANCEL | |
*/ | |
Titanium.Android.NotificationManager.FLAG_AUTO_CANCEL; | |
/** | |
* Use <Titanium.Android.FLAG_INSISTENT> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_INSISTENT | |
*/ | |
Titanium.Android.NotificationManager.FLAG_INSISTENT; | |
/** | |
* Use <Titanium.Android.FLAG_NO_CLEAR> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_NO_CLEAR | |
*/ | |
Titanium.Android.NotificationManager.FLAG_NO_CLEAR; | |
/** | |
* Use <Titanium.Android.FLAG_ONGOING_EVENT> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ONGOING_EVENT | |
*/ | |
Titanium.Android.NotificationManager.FLAG_ONGOING_EVENT; | |
/** | |
* Use <Titanium.Android.FLAG_ONLY_ALERT_ONCE> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_ONLY_ALERT_ONCE | |
*/ | |
Titanium.Android.NotificationManager.FLAG_ONLY_ALERT_ONCE; | |
/** | |
* Use <Titanium.Android.FLAG_SHOW_LIGHTS> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} FLAG_SHOW_LIGHTS | |
*/ | |
Titanium.Android.NotificationManager.FLAG_SHOW_LIGHTS; | |
/** | |
* Use <Titanium.Android.STREAM_DEFAULT> instead. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} STREAM_DEFAULT | |
*/ | |
Titanium.Android.NotificationManager.STREAM_DEFAULT; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.NotificationManager.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.NotificationManager.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.NotificationManager.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.NotificationManager.applyProperties = function(props) {}; | |
/** | |
* Cancels a previously displayed notification. | |
* @since 1.5 (Android) | |
* @param {Number} id The ID passed to [notify](Titanium.Android.NotificationManager.notify). | |
*/ | |
Titanium.Android.NotificationManager.cancel = function(id) {}; | |
/** | |
* Cancels all previously displayed notifications. | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.NotificationManager.cancelAll = function() {}; | |
/** | |
* Adds a persistent notification to the status bar. | |
* @since 1.5 (Android) | |
* @param {Number} id An ID that may be used to cancel a shown notification. | |
* @param {Titanium.Android.Notification} notification Notification to display. | |
*/ | |
Titanium.Android.NotificationManager.notify = function(id, notification) {}; | |
/** | |
* Create a notification channel. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android._Dictionary_NotificationChannel} parameters Properties to set on a new object, including any defined by <Titanium.Android.NotificationChannel> except those marked not-creation or read-only. | |
* @return {Titanium.Android.NotificationChannel} | |
*/ | |
Titanium.Android.NotificationManager.createNotificationChannel = function(parameters) {}; | |
/** | |
* Returns whether showing notifications is enabled for the application. | |
* @since 7.1.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.NotificationManager.areNotificationsEnabled = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationManager.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.NotificationManager.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationManager.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.NotificationManager.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationManager.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.NotificationManager.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.NotificationManager.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.NotificationManager.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.NotificationManager.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.NotificationManager.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android._Dictionary_NotificationManager; | |
/** | |
* The Titanium binding of an Android `PendingIntent`. | |
* @extends {Titanium.Proxy} | |
* @description Use the <Titanium.Android.createPendingIntent> method to create a pending intent. | |
* | |
* The type of `Intent` you pass to `createPendingIntent` determines what kind of | |
* `PendingIntent` is created. Each type corresponds directly with a get method on | |
* Android's PendingIntent: | |
* | |
* * To create a `PendingIntent` that starts an activity, pass in an activity intent, | |
* created with [createIntent](Titanium.Android.createIntent). This is equivalent to | |
* calling the native Android `PendingIntent.getActivity` method. See | |
* [PendingIntent.getActivity in the Android API Reference](https://developer.android.com/reference/android/app/PendingIntent.html#getActivity(android.content.Context, int, android.content.Intent, int)) | |
* | |
* * To create a `PendingIntent` that starts a service, pass in a service intent, | |
* created with [createServiceIntent](Titanium.Android.createServiceIntent). This is | |
* equivalent to calling the native Android `PendingIntent.getService` method. See | |
* [PendingIntent.getService in the Android API Reference](https://developer.android.com/reference/android/app/PendingIntent.html#getService(android.content.Context, int, android.content.Intent, int)). | |
* | |
* The `PendingIntent` is always associated with the activity that was the current activity | |
* when the intent was created. | |
* | |
* Note that this `PendingIntent` is designed primarily to be used with the | |
* [Notification](Titanium.Android.Notification) object. It does not support all features | |
* of the native Android `PendingIntent` -- in particular, | |
* broadcast pending intents are not supported. | |
* | |
* See also: | |
* | |
* * [PendingIntent in the Android API Reference](https://developer.android.com/reference/android/app/PendingIntent.html) | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.PendingIntent = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.PendingIntent.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.PendingIntent.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.PendingIntent.prototype.lifecycleContainer; | |
/** | |
* Flags used for creating the Pending Intent. | |
* @since 1.5 (Android) | |
* @type {Number} flags | |
*/ | |
Titanium.Android.PendingIntent.prototype.flags; | |
/** | |
* The intent data to pass to the [Activity](Titanium.Android.Activity) launched by this `PendingIntent`. | |
* | |
* @since 1.5 (Android) | |
* @type {Titanium.Android.Intent} intent | |
*/ | |
Titanium.Android.PendingIntent.prototype.intent; | |
/** | |
* If this property is true, flag <Titanium.Android.FLAG_UPDATE_CURRENT> will be | |
* appended to `flags` automatically. Default value is true. | |
* | |
* @since 1.5 (Android) | |
* @type {Boolean} updateCurrentIntent | |
*/ | |
Titanium.Android.PendingIntent.prototype.updateCurrentIntent; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.PendingIntent.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.PendingIntent.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.PendingIntent.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.PendingIntent.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.PendingIntent.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.PendingIntent.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.PendingIntent.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.PendingIntent.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.PendingIntent.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.PendingIntent.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.PendingIntent.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.PendingIntent.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.PendingIntent.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.PendingIntent.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.PendingIntent.flags> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.PendingIntent.getFlags = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.PendingIntent.flags> property. | |
* @since 1.5 (Android) | |
* @param {Number} flags New value for the property. | |
*/ | |
Titanium.Android.PendingIntent.setFlags = function(flags) {}; | |
/** | |
* Gets the value of the <Titanium.Android.PendingIntent.intent> property. | |
* @since 1.5 (Android) | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.Android.PendingIntent.getIntent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.PendingIntent.intent> property. | |
* @since 1.5 (Android) | |
* @param {Titanium.Android.Intent} intent New value for the property. | |
*/ | |
Titanium.Android.PendingIntent.setIntent = function(intent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.PendingIntent.updateCurrentIntent> property. | |
* @since 1.5 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.PendingIntent.getUpdateCurrentIntent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.PendingIntent.updateCurrentIntent> property. | |
* @since 1.5 (Android) | |
* @param {Boolean} updateCurrentIntent New value for the property. | |
*/ | |
Titanium.Android.PendingIntent.setUpdateCurrentIntent = function(updateCurrentIntent) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* flags: Number, | |
* intent: Titanium.Android.Intent, | |
* updateCurrentIntent: Boolean | |
* }} | |
*/ | |
Titanium.Android._Dictionary_PendingIntent; | |
/** | |
* Android service for creating custom quick settings tiles and handling user's interaction with them. | |
* @constructor | |
* @extends {Titanium.Android.Service} | |
* @description A special kind of service providing access to a tile in the quick settings menu. Used for customization | |
* and event handling of the tile. Usage is similar to default <Titanium.Android.Service> but with the | |
* addition of some specific attributes and methods. This service is not started from within the application | |
* with the help of an Intent, but instead whenever the custom tile is added in the quick settings menu by the | |
* user. Applications can have multiple tiles in the quick settigs menu, but a <Titanium.Android.QuickSettingsService> | |
* corresponds to a single one - you need separate service file for every tile. | |
* | |
* To create a service file: | |
* | |
* 1. Write the JavaScript code you want the service to execute in a separate file. | |
* The service can execute any Titanium APIs but you should only use non-UI APIs. | |
* 2. Register the service in your `tiapp.xml` file. Refer to the example below. | |
* | |
* Icons used for the 'icon' attribute in the service declaration in tiapp.xml must | |
* be in the Android drawables folder, so they you should be put under | |
* `platform/android/res/drawable` | |
* Icons added with the setIcon method can be outside the directory. | |
* | |
* To get a reference to the `Service` inside the JavaScript service code, use the | |
* <Titanium.Android.currentService> property to retrieve a reference to the service, | |
* | |
* Further Reading: | |
* | |
* * [Android Quick Settings Tile API](https://developer.android.com/about/versions/nougat/android-7.0.html#tile_api) | |
* | |
* @since 7.0 (Android) | |
*/ | |
Titanium.Android.QuickSettingsService = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 7.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 7.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 7.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.lifecycleContainer; | |
/** | |
* The intent used to start or bind to the Service. | |
* @since 7.0 (Android) | |
* @readonly | |
* @type {Titanium.Android.Intent} intent | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.intent; | |
/** | |
* A service can be started more than once -- this number (based on an incrementing integer) | |
* indicates which "start number" in the sequence the current service instance is. | |
* | |
* @since 7.0 (Android) | |
* @readonly | |
* @type {Number} serviceInstanceId | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.serviceInstanceId; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 7.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 7.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 7.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 7.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.applyProperties = function(props) {}; | |
/** | |
* Puts the service into the "background" state and removes its foreground notification. | |
* @since 7.3.0 (Android) | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.foregroundCancel = function() {}; | |
/** | |
* Puts the service into the "foreground" state and displays a notification. | |
* @since 7.3.0 (Android) | |
* @param {Number} id Unique integer ID to be assigned to the notification. Cannot be zero. | |
* @param {Titanium.Android.Notification} notification Notification to display in the status bar. Cannot be null. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.foregroundNotify = function(id, notification) {}; | |
/** | |
* Starts the Service. | |
* @since 7.0 (Android) | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.start = function() {}; | |
/** | |
* Stops this running instance of the Service. | |
* @since 7.0 (Android) | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.stop = function() {}; | |
/** | |
* Applies current tile's properties. | |
* @since 7.0 (Android) | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.updateTile = function() {}; | |
/** | |
* Changes the Tile's icon. | |
* @since 7.0 (Android) | |
* @param {String|Titanium.Blob|Titanium.Filesystem.File} icon Source of the icon image | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.setIcon = function(icon) {}; | |
/** | |
* Sets the state of the Tile. | |
* @since 7.0 (Android) | |
* @param {Number} state State to be set. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.setState = function(state) {}; | |
/** | |
* Changes the Tile's label. | |
* @since 7.0 (Android) | |
* @param {String} label String to be used. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.setLabel = function(label) {}; | |
/** | |
* Returns the Tile's current icon. | |
* @since 7.0 (Android) | |
* @return {String|Titanium.Blob|Titanium.Filesystem.File} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getIcon = function() {}; | |
/** | |
* Returns the Tile's current state. | |
* @since 7.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getState = function() {}; | |
/** | |
* Returns the Tile's current label. | |
* @since 7.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getLabel = function() {}; | |
/** | |
* Returns 'true' if the device is currently locked, 'false' otherwise. | |
* @since 7.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.isLocked = function() {}; | |
/** | |
* Returns 'true' if the device is in secure state, 'false' otherwise. | |
* @since 7.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.isSecure = function() {}; | |
/** | |
* Opens an Alert dialog. | |
* @since 7.0 (Android) | |
* @param {showParams} options Dictionary containing the options for the dialog. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.showDialog = function(options) {}; | |
/** | |
* Colapses the quick settings menu and starts an activity for the passed Intent. | |
* @since 7.0 (Android) | |
* @param {Titanium.Android.Intent} intent Intent to be fired. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.startActivityAndCollapse = function(intent) {}; | |
/** | |
* Prompts the user to unlock the device and runs the JS code. | |
* @since 7.0 (Android) | |
* @param {String} jsCode JavaScript code to be evaluated. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.unlockAndRun = function(jsCode) {}; | |
/** | |
* Gets the value of the <Titanium.Android.QuickSettingsService.bubbleParent> property. | |
* @since 7.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.QuickSettingsService.bubbleParent> property. | |
* @since 7.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.QuickSettingsService.apiName> property. | |
* @since 7.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.QuickSettingsService.lifecycleContainer> property. | |
* @since 7.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.QuickSettingsService.lifecycleContainer> property. | |
* @since 7.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.QuickSettingsService.intent> property. | |
* @since 7.0 (Android) | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getIntent = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.QuickSettingsService.serviceInstanceId> property. | |
* @since 7.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.QuickSettingsService.prototype.getServiceInstanceId = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android._Dictionary_QuickSettingsService; | |
/** | |
* The Titanium binding of the Android system-wide resources class. | |
* @extends {Titanium.Proxy} | |
* @description To access your application's resources, use <Titanium.App.Android.R>. | |
* | |
* These properties and sub-properties correspond directly to the properties of the the `android.R` | |
* class, and should have the same syntax. For example, to retrieve the "OK" string in Android: | |
* | |
* Ti.Android.currentActivity.getString(Ti.Android.R.string.ok); | |
* | |
* See also: [android.R](https://developer.android.com/reference/android/R.html) in the | |
* Android Developer Reference. | |
* | |
* Starting in Titanium SDK 7.3.0, this API exposes all Android related R classes | |
* for the usage in Hyperloop. For example, it can be used to access `menu` resources | |
* as part of native user interfaces, e.g. `BottomNavigationView` or `RecyclerView`. | |
* See an example in the [Hyperloop Sample App](https://github.com/appcelerator/hyperloop-examples) for details! | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.R = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.R.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.R.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.R.prototype.lifecycleContainer; | |
/** | |
* Animation resources. See | |
* [R.anim](https://developer.android.com/reference/android/R.anim.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} anim | |
*/ | |
Titanium.Android.R.prototype.anim; | |
/** | |
* Animator resources. See | |
* [R.animator](https://developer.android.com/reference/android/R.animator.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} animator | |
*/ | |
Titanium.Android.R.prototype.animator; | |
/** | |
* Array resources. See [R.array](https://developer.android.com/reference/android/R.array.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} array | |
*/ | |
Titanium.Android.R.prototype.array; | |
/** | |
* Attribute resources. See | |
* [R.attr](https://developer.android.com/reference/android/R.attr.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} attr | |
*/ | |
Titanium.Android.R.prototype.attr; | |
/** | |
* Boolean resources. See | |
* [R.bool](https://developer.android.com/reference/android/R.bool.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} bool | |
*/ | |
Titanium.Android.R.prototype.bool; | |
/** | |
* Color resources. See | |
* [R.color](https://developer.android.com/reference/android/R.color.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} color | |
*/ | |
Titanium.Android.R.prototype.color; | |
/** | |
* Dimension resources. See | |
* [https://developer.android.com/reference/android/R.dimen.html](https://developer.android.com/reference/android/R.dimen.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} dimen | |
*/ | |
Titanium.Android.R.prototype.dimen; | |
/** | |
* Drawable resources. See | |
* [R.drawable](https://developer.android.com/reference/android/R.drawable.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} drawable | |
*/ | |
Titanium.Android.R.prototype.drawable; | |
/** | |
* Fraction resources. See | |
* [R.fraction](https://developer.android.com/reference/android/R.fraction.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} fraction | |
*/ | |
Titanium.Android.R.prototype.fraction; | |
/** | |
* ID resources. See | |
* [R.id](https://developer.android.com/reference/android/R.id.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} id | |
*/ | |
Titanium.Android.R.prototype.id; | |
/** | |
* Integer resources. See | |
* [R.integer](https://developer.android.com/reference/android/R.integer.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} integer | |
*/ | |
Titanium.Android.R.prototype.integer; | |
/** | |
* Interpolator resources. See | |
* [R.fraction](https://developer.android.com/reference/android/R.interpolator.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} interpolator | |
*/ | |
Titanium.Android.R.prototype.interpolator; | |
/** | |
* Layout resources. See | |
* [R.layout](https://developer.android.com/reference/android/R.layout.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} layout | |
*/ | |
Titanium.Android.R.prototype.layout; | |
/** | |
* Menu resources. See | |
* [R.menu](https://developer.android.com/reference/android/R.menu.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} menu | |
*/ | |
Titanium.Android.R.prototype.menu; | |
/** | |
* Mipmap resources. See | |
* [R.mipmap](https://developer.android.com/reference/android/R.mipmap.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} mipmap | |
*/ | |
Titanium.Android.R.prototype.mipmap; | |
/** | |
* Plurals resources. See | |
* [R.plurals](https://developer.android.com/reference/android/R.plurals.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} plurals | |
*/ | |
Titanium.Android.R.prototype.plurals; | |
/** | |
* Raw resources. See | |
* [R.raw](https://developer.android.com/reference/android/R.raw.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} raw | |
*/ | |
Titanium.Android.R.prototype.raw; | |
/** | |
* String resources. See | |
* [R.string](https://developer.android.com/reference/android/R.string.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} string | |
*/ | |
Titanium.Android.R.prototype.string; | |
/** | |
* Style resources. See | |
* [R.style](https://developer.android.com/reference/android/R.style.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} style | |
*/ | |
Titanium.Android.R.prototype.style; | |
/** | |
* Styleable resources. See | |
* [R.styleable](https://developer.android.com/reference/android/R.styleable.html) | |
* in the Android Developer Reference. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Object} styleable | |
*/ | |
Titanium.Android.R.prototype.styleable; | |
/** | |
* Transition resources. See | |
* [R.transition](https://developer.android.com/reference/android/R.transition.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} transition | |
*/ | |
Titanium.Android.R.prototype.transition; | |
/** | |
* XML resources. See | |
* [R.xml](https://developer.android.com/reference/android/R.xml.html) | |
* in the Android Developer Reference. | |
* | |
* @since 7.3.0 (Android) | |
* @readonly | |
* @type {Object} xml | |
*/ | |
Titanium.Android.R.prototype.xml; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.R.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.R.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.R.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.R.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Android.R.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.R.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.R.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.R.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.R.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.R.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.R.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.R.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.R.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.R.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android._Dictionary_R; | |
/** | |
* The Titanium binding of [Android RemoteViews](https://developer.android.com/reference/android/widget/RemoteViews.html). | |
* | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description `RemoteViews` is an API for referencing and updating a remote view hierarchy that | |
* lives in another process, for example, in a [Notification](Titanium.Android.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](Titanium.Android.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 | |
* heirarchy 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 | |
* | |
* See also: | |
* | |
* * [RemoteViews](https://developer.android.com/reference/android/widget/RemoteViews.html) | |
* in the Android Developer Reference. | |
* | |
* * [XML Layouts](https://developer.android.com/guide/topics/ui/declaring-layout.html) | |
* in the Android Developer Guide. | |
* | |
* @since 1.6 (Android) | |
*/ | |
Titanium.Android.RemoteViews = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.RemoteViews.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.RemoteViews.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.RemoteViews.prototype.lifecycleContainer; | |
/** | |
* Android layout resource ID for the view to display. Required. | |
* @since 1.6 (Android) | |
* @type {Number} layoutId | |
*/ | |
Titanium.Android.RemoteViews.prototype.layoutId; | |
/** | |
* Package name that the resource ID lives in. Optional. | |
* @since 1.6 (Android) | |
* @type {String} packageName | |
*/ | |
Titanium.Android.RemoteViews.prototype.packageName; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.6 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.RemoteViews.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.6 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.RemoteViews.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.6 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.RemoteViews.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.RemoteViews.prototype.applyProperties = function(props) {}; | |
/** | |
* 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)). | |
* | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to invoke the method on. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {String} methodName Name of the method to call. | |
* @param {Boolean} value Value to pass to the method. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setBoolean = function(viewId, methodName, value) {}; | |
/** | |
* Sets the base time, format string, and started flag for a chronometer | |
* in the remote view hierarchy. | |
* | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the Chronometer to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {Date} base Time at which the timer would have read 0:00. | |
* @param {String} format Chronometer format string, or `null` to simply display the timer value. | |
* @param {Boolean} started True if you want the clock to be started, false if not. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setChronometer = function(viewId, base, format, started) {}; | |
/** | |
* Calls a method taking a single `double` argument on a view in the remote view | |
* hierarchy. | |
* | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {String} methodName Name of the method to call. | |
* @param {Number} value Value to pass to the method. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setDouble = function(viewId, methodName, value) {}; | |
/** | |
* Sets the image for an image view in the remote view hierarchy using an Android drawable resource. | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the `ImageView` to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {Number} srcId Resource ID of the new image. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
*/ | |
Titanium.Android.RemoteViews.prototype.setImageViewResource = function(viewId, srcId) {}; | |
/** | |
* Sets the image for an image view in the remote view hierarchy using a URI. | |
* | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the `ImageView` to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {String} uri URI of the image (both Android and Titanium URLs are supported). | |
*/ | |
Titanium.Android.RemoteViews.prototype.setImageViewUri = function(viewId, uri) {}; | |
/** | |
* Calls a method taking a single `int` argument on a view in the remote view hierarchy. | |
* | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {String} methodName Name of the method to call. | |
* @param {Number} value Value to pass to the method. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setInt = function(viewId, methodName, value) {}; | |
/** | |
* Launches a <Titanium.Android.PendingIntent> when the specified view is clicked. | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to add a click listener to. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {Titanium.Android.PendingIntent} pendingIntent The `PendingIntent` to execute when this view is clicked. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setOnClickPendingIntent = function(viewId, pendingIntent) {}; | |
/** | |
* Sets the progress, max value, and indeterminate flag of a progress bar in the | |
* remote view hierarchy. | |
* | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the progress bar to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {Number} max The new maximum value of the progress bar. | |
* @param {Number} progress The new progress value of the progress bar (from 0..`max`). | |
* @param {Boolean} indeterminate Determines whether the progress bar is indeterminate. | |
* If `true`, the progress bar displays an infinite looping animation. | |
* | |
*/ | |
Titanium.Android.RemoteViews.prototype.setProgressBar = function(viewId, max, progress, indeterminate) {}; | |
/** | |
* Calls a method taking a single String argument on a view in the remote view | |
* hierarchy. | |
* | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {String} methodName Name of the method to call. | |
* @param {String} value String to pass to the method. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setString = function(viewId, methodName, value) {}; | |
/** | |
* Sets the text color of a view in the remote view hierarchy. | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {Number} color Color as an integer. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setTextColor = function(viewId, color) {}; | |
/** | |
* Sets the text of a text view in the remote view hierarchy. | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the text view to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {String} text New text for the text view. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setTextViewText = function(viewId, text) {}; | |
/** | |
* Calls a method taking one URI on a view in the remote view hierarchy. | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to update. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {String} methodName Name of the method to call. | |
* @param {String} value URI (as a string) to pass to the method. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setUri = function(viewId, methodName, value) {}; | |
/** | |
* Sets the visibility of a view in the remote view hierarchy. | |
* @since 1.6 (Android) | |
* @param {Number} viewId Resource ID of the view to show or hide. | |
* Application-specific resource IDs can be specified using <Titanium.App.Android.R>. | |
* | |
* @param {Number} visibility The visibility. Either `0` (VISIBLE), `4` (INVISIBLE) or `8` (GONE). | |
*/ | |
Titanium.Android.RemoteViews.prototype.setViewVisibility = function(viewId, visibility) {}; | |
/** | |
* Gets the value of the <Titanium.Android.RemoteViews.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.RemoteViews.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.RemoteViews.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.RemoteViews.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.RemoteViews.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.RemoteViews.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.RemoteViews.prototype.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.RemoteViews.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.RemoteViews.layoutId> property. | |
* @since 1.6 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.RemoteViews.prototype.getLayoutId = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.RemoteViews.layoutId> property. | |
* @since 1.6 (Android) | |
* @param {Number} layoutId New value for the property. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setLayoutId = function(layoutId) {}; | |
/** | |
* Gets the value of the <Titanium.Android.RemoteViews.packageName> property. | |
* @since 1.6 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.RemoteViews.prototype.getPackageName = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.RemoteViews.packageName> property. | |
* @since 1.6 (Android) | |
* @param {String} packageName New value for the property. | |
*/ | |
Titanium.Android.RemoteViews.prototype.setPackageName = function(packageName) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* layoutId: Number, | |
* packageName: String | |
* }} | |
*/ | |
Titanium.Android._Dictionary_RemoteViews; | |
/** | |
* Android application component that executes in the background. | |
* @extends {Titanium.Proxy} | |
* @description A service is a component started by an application that runs in the background. The service | |
* does not have any application UI associated with it, so the user does not directly interact | |
* with it, only your application. | |
* | |
* The Titanium SDK gives you the ability to write your own Android Services using JavaScript. | |
* The service executes your JavaScript code at intervals you specify. Note that the service | |
* may stop running if the application is killed. | |
* | |
* To create a service: | |
* | |
* 1. Write the JavaScript code you want the service to execute in a separate file. | |
* The service can execute any Titanium APIs but you should only use non-UI APIs. | |
* 2. Register the service in your `tiapp.xml` file. Refer to the example below. | |
* 3. Create a service intent by passing the JavaScript file to | |
* the <Titanium.Android.createServiceIntent> method and set the interval to run the | |
* code using the intent's `putExtra()` method. | |
* 4. Pass the Intent object to either the <Titanium.Android.createService> method | |
* to create a `Service` object (*bound service*), where the application can | |
* manage the service by invoking methods and binding callbacks on the object, | |
* or to the <Titanium.Android.startService> method to start the service (*started service*) | |
* and the service manages itself. | |
* | |
* Use the `Titanium.Android.Service` API to manage the service. | |
* | |
* To get a reference to the `Service` inside the JavaScript service code, use the | |
* <Titanium.Android.currentService> property to retrieve a reference to the service, | |
* then invoke the `Titanium.Android.Service` APIs on the `Service` object. | |
* | |
* Further Reading: | |
* | |
* * [Android Services guide](https://docs.appcelerator.com/platform/latest/#!/guide/Android_Services) | |
* * [Android Developer: Service](https://developer.android.com/reference/android/app/Service.html) | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Service = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Android.Service.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Android.Service.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Android.Service.prototype.lifecycleContainer; | |
/** | |
* The intent used to start or bind to the Service. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Titanium.Android.Intent} intent | |
*/ | |
Titanium.Android.Service.prototype.intent; | |
/** | |
* A service can be started more than once -- this number (based on an incrementing integer) | |
* indicates which "start number" in the sequence the current service instance is. | |
* | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Number} serviceInstanceId | |
*/ | |
Titanium.Android.Service.prototype.serviceInstanceId; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Android.Service.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Android.Service.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Android.Service.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Android.Service.applyProperties = function(props) {}; | |
/** | |
* Puts the service into the "background" state and removes its foreground notification. | |
* @since 7.3.0 (Android) | |
*/ | |
Titanium.Android.Service.foregroundCancel = function() {}; | |
/** | |
* Puts the service into the "foreground" state and displays a notification. | |
* @since 7.3.0 (Android) | |
* @param {Number} id Unique integer ID to be assigned to the notification. Cannot be zero. | |
* @param {Titanium.Android.Notification} notification Notification to display in the status bar. Cannot be null. | |
*/ | |
Titanium.Android.Service.foregroundNotify = function(id, notification) {}; | |
/** | |
* Starts the Service. | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Service.start = function() {}; | |
/** | |
* Stops this running instance of the Service. | |
* @since 1.5 (Android) | |
*/ | |
Titanium.Android.Service.stop = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Service.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Android.Service.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Service.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Android.Service.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Service.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Android.Service.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Service.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Android.Service.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Android.Service.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Android.Service.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Android.Service.intent> property. | |
* @since 1.5 (Android) | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.Android.Service.getIntent = function() {}; | |
/** | |
* Gets the value of the <Titanium.Android.Service.serviceInstanceId> property. | |
* @since 1.5 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Android.Service.getServiceInstanceId = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Android._Dictionary_Service; | |
/** | |
* The top-level App module is mainly used for accessing information about the | |
* application at runtime, and for sending or listening for system events. | |
* | |
* @extends {Titanium.Module} | |
* @description The `App` module exposes a number of properties set in the `tiapp.xml` file. | |
* | |
* Three of these properties, the application name, ID, and URL, must be specified when the | |
* application is created. | |
* | |
* While most values may be changed by editing the `tiapp.xml` file after creating the project, | |
* the GUID is automatically generated and should not be changed. | |
* | |
* To access other application properties set in the `tiapp.xml` file not exposed by the | |
* `Titanium.App` module, see <Titanium.App.Properties>. | |
* | |
* #### iOS Application Life Cycle | |
* | |
* At any given moment, you applications can be in one of the following possible states: | |
* | |
* * Not running: The app has not been launched or was running but was terminated by the system. | |
* | |
* * Inactive: The app is running in the foreground but is currently not receiving events. | |
* An app usually stays in this state only briefly as it transitions to a different state. | |
* The `pause` event is fired during this state. | |
* | |
* * Active: The app is running in the foreground and is receiving events. This is the normal | |
* mode for foreground apps. | |
* | |
* * Background: The app is in the background and executing code. Most apps enter this state | |
* briefly on their way to being suspended. | |
* | |
* * Suspended: The app is in the background but is not executing code. The system moves | |
* apps to this state automatically and does not notify them before doing so. While suspended, | |
* an app remains in memory but does not execute any code. The `paused` event is fired | |
* during this state. The system tries to keep as many apps in memory at the same time as it | |
* can, but when memory runs low it terminates suspended apps to reclaim that memory. Apps | |
* that consume large amounts of memory while in the background are the first apps to be terminated. | |
* | |
* **Responding To Interruptions** | |
* | |
* ***System Alerts*** | |
* | |
* When an **alert-based** interruption occurs, such as an incoming phone call, the app moves | |
* temporarily to the inactive state, and fires the `pause` event. The system then displays | |
* an alert to the user. The app remains in this state until the user dismisses the alert. | |
* At this point, the app either returns to the active state and fires the `resumed` event; | |
* or moves to the background state and fires the `paused` event. | |
* | |
* Alert-based interruptions result in temporary loss of control by your app and results in `pause` | |
* event being fired. Your app continues to run in the foreground, but it does not recieve | |
* touch events from the system. (It does continue to receive notifications and other types | |
* of events, such as accelerometer events.) When your app is moved back to the | |
* active state, the `resumed` event is fired. | |
* | |
* The same set of events takes place when user **double taps on the home button**. | |
* | |
* ***Sleep/Wake Button*** | |
* | |
* Pressing the **Sleep/Wake** button is another type of interruption that causes your app to | |
* move to an inactive state. When the app is in the foreground and the **Sleep/Wake button** | |
* is pressed, the the system fires the `pause` event followed by the `paused` event and | |
* becomes inactive. This is an intentionally behavioral change by Apple to conserve battery when | |
* the Sleep/Wake button is pressed. On waking up the app fires the `resume` event followed by the | |
* `resumed` event and returns the app to normal state. | |
* | |
* ***Home Button*** | |
* | |
* Pressing the **home button** is another kind of interruption. The app fires `pause` and | |
* `paused`events before going into background. When app is reopened it fires the `resume` | |
* event followed by the `resumed` event, returning the app to the normal state. | |
* | |
* <table class="doc-table" summary="This table gives the order of events fired when the app is in normal state."> | |
* <caption><b>Lifecycle events fired during different interruptions</b></caption> | |
* <thead> | |
* <tr> | |
* <th colspan="2">Type of Interruption</th> | |
* <th colspan="2">Going into Background</th> | |
* <th colspan="2">Coming into Foreground</th> | |
* </tr> | |
* </thead> | |
* <tbody> | |
* <tr> | |
* <th colspan="2" align="left">Alert-Based/Fast App Switching</th> | |
* <td align="center">pause</td> | |
* <td align="center"></td> | |
* <td align="center"> </td> | |
* <td align="center">resumed</td> | |
* </tr> | |
* <tr> | |
* <th colspan="2" align="left">Sleep/Wake Button</th> | |
* <td align="center">pause</td> | |
* <td align="center">paused</td> | |
* <td align="center">resume</td> | |
* <td align="center">resumed</td> | |
* </tr> | |
* <tr> | |
* <th colspan="2" align="left">Home Button (backgrounding)</th> | |
* <td align="center">pause</td> | |
* <td align="center">paused</td> | |
* <td align="center">resume</td> | |
* <td align="center">resumed</td> | |
* </tr> | |
* </tbody> | |
* </table> | |
* | |
* ***Blur and Focus Events*** | |
* | |
* When using the iOS pause/resume feature, the `blur` and `focus` events do not fire | |
* before the application enters the background or after it returns to the foreground, | |
* respectively. Instead, the application needs to monitor the `pause` and `resumed` events, | |
* which relies on the underlying iOS events to determine the application state rather than the | |
* UI events. | |
* | |
* #### Application Level Events | |
* | |
* Application-level events are custom events that are defined globally for your | |
* application. By convention, application-level events are set on the `Titanium.App` | |
* module, like this: | |
* | |
* Ti.App.addEventListener('app:myCustomEvent', myHandlerFunction); | |
* | |
* Adding a prefix (like 'app:' in this example) is optional, but can help ensure that | |
* your custom event names don't conflict with any future Titanium events. | |
* | |
* Application-level event listeners can be added and fired from any context, including from inside | |
* a web view, so they are ideal for communicating between separate parts of your | |
* application. | |
* | |
* When you add an event listener on a Titanium module (such as `Ti.App` or | |
* [Ti.Geolocation](Titanium.Geolocation)), the event listener function is referenced from | |
* the global context. This means the event listener function and any objecst it references | |
* can't be garbage collected until the event listener is removed. | |
* | |
* This can lead to memory leaks if application-level event listeners are added and not | |
* removed. | |
* | |
* See also: [Event Handling](https://docs.appcelerator.com/platform/latest/#!/guide/Event_Handling) | |
* in the Titanium Mobile Guides. | |
* | |
* #### System Level Accessibility Events | |
* | |
* System-level Accessibility events include: | |
* | |
* * Events your application fires to alert the device's accessibility system of some condition | |
* or to ask it to do something. | |
* * Events fired by the device's accessibility system and listened for in your application. | |
* | |
* Currently there are four system-level accessibility events. Three of them are available for | |
* your application to fire, and one of them is for your application to listen for. | |
* | |
* ##### Firing Accessibility Events. | |
* | |
* The following accessibility events can be fired by your application to alert the accessibility | |
* system of a particular condition or to ask it to perform an action. | |
* | |
* These events are fired using <Titanium.App.fireSystemEvent>, which is available in Titanium Mobile 3.0.0. | |
* | |
* * <Titanium.App.EVENT_ACCESSIBILITY_ANNOUNCEMENT>, available in iOS and Android, asks the device's | |
* accessibility system to make an announcement. The announcement itself is a string passed as the second | |
* argument to <Titanium.App.fireSystemEvent>. *How* the device's accessibility actually makes that announcement | |
* depends on what accessibility services are activated on the device. The most common are VoiceOver on | |
* iOS and TalkBack on Android. Each of those would read the announcement aloud. | |
* | |
* Ti.App.fireSystemEvent(Ti.App.EVENT_ACCESSIBILITY_ANNOUNCEMENT, "Welcome to my App"); | |
* | |
* * <Titanium.App.iOS.EVENT_ACCESSIBILITY_LAYOUT_CHANGED>, available only on iOS, can be used to alert | |
* the accessibility system that the layout of the screen has changed, such as when an element | |
* appears or disappears. When your application fires this event, Titanium calls `UIAccessibilityLayoutChangedNotification` | |
* in the iOS [UIAccessibility Protocol](https://developer.apple.com/documentation/uikit/accessibility/uiaccessibility). | |
* No second parameter is required when firing this event with <Titanium.App.fireSystemEvent>. | |
* | |
* * <Titanium.App.iOS.EVENT_ACCESSIBILITY_SCREEN_CHANGED>, available only on iOS, can be used to alert | |
* the accessibility system when a new view appears that comprises a major portion of the screen. | |
* When your application fires this event, Titanium calls `UIAccessibilityScreenChangedNotification` | |
* in the iOS [UIAccessibility Protocol](https://developer.apple.com/documentation/uikit/accessibility/uiaccessibility). | |
* No second parameter is required when firing this event with <Titanium.App.fireSystemEvent>. | |
* | |
* ##### Listening for Accessibility Events | |
* | |
* Currently there is only one system accessibility event which your application can listen for using | |
* <Titanium.App.addEventListener>, namely <Titanium.App.accessibilitychanged>. This event, available on iOS and on Android | |
* (for devices running Ice Cream Sandwich or greater), is fired when the device's accessibility service is turned | |
* on or off. The object passed as a parameter to the listener function contains an `enabled` property which is | |
* `true` if the accessibility service is now turned on, or `false` otherwise. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.App = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.App.prototype.lifecycleContainer; | |
/** | |
* Convenience constant for system event "accessibilityannouncement". | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @readonly | |
* @type {String} EVENT_ACCESSIBILITY_ANNOUNCEMENT | |
*/ | |
Titanium.App.EVENT_ACCESSIBILITY_ANNOUNCEMENT; | |
/** | |
* Convenience constant for system event "accessibilitychanged". | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @readonly | |
* @type {String} EVENT_ACCESSIBILITY_CHANGED | |
*/ | |
Titanium.App.EVENT_ACCESSIBILITY_CHANGED; | |
/** | |
* Indicates whether Accessibility is enabled by the system. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {Boolean} accessibilityEnabled | |
*/ | |
Titanium.App.prototype.accessibilityEnabled; | |
/** | |
* Indicates whether Analytics is enabled, determined by `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {Boolean} analytics | |
*/ | |
Titanium.App.prototype.analytics; | |
/** | |
* Application copyright statement, determined by `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} copyright | |
*/ | |
Titanium.App.prototype.copyright; | |
/** | |
* Build type that reflects how the application was packaged. | |
* | |
* Returns one of the following values: | |
* * `development` (Simulator) | |
* * `test` (Device) | |
* * `production` (App Store / Adhoc) | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} deployType | |
*/ | |
Titanium.App.prototype.deployType; | |
/** | |
* Application description, determined by `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} description | |
*/ | |
Titanium.App.prototype.description; | |
/** | |
* Application globally-unique ID, determined by `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} guid | |
*/ | |
Titanium.App.prototype.guid; | |
/** | |
* Shows the application's splash screen on app resume. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @type {Boolean} forceSplashAsSnapshot | |
*/ | |
Titanium.App.prototype.forceSplashAsSnapshot; | |
/** | |
* Application ID, from `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.App.prototype.id; | |
/** | |
* The install ID for this application. | |
* @since 2.0.0 (iPhone), 2.0.0 (iPad) | |
* @readonly | |
* @type {String} installId | |
*/ | |
Titanium.App.prototype.installId; | |
/** | |
* Determines whether the screen is locked when the device is idle. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @type {Boolean} idleTimerDisabled | |
*/ | |
Titanium.App.prototype.idleTimerDisabled; | |
/** | |
* Application name, determined by `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} name | |
*/ | |
Titanium.App.prototype.name; | |
/** | |
* Determines whether proximity detection is enabled. | |
* @since 3.3.0 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Boolean} proximityDetection | |
*/ | |
Titanium.App.prototype.proximityDetection; | |
/** | |
* Indicates the state of the device's proximity sensor, according to the | |
* <Titanium.App.proximity> event. | |
* | |
* @since 3.3.0 (Android), 0.8 (iPhone) | |
* @readonly | |
* @type {Boolean} proximityState | |
*/ | |
Titanium.App.prototype.proximityState; | |
/** | |
* Prevents network activity indicator from being displayed. | |
* | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} disableNetworkActivityIndicator | |
*/ | |
Titanium.App.prototype.disableNetworkActivityIndicator; | |
/** | |
* Application publisher, from `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} publisher | |
*/ | |
Titanium.App.prototype.publisher; | |
/** | |
* Unique session identifier for the current continuous run of the application. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} sessionId | |
*/ | |
Titanium.App.prototype.sessionId; | |
/** | |
* Application URL, from `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} url | |
*/ | |
Titanium.App.prototype.url; | |
/** | |
* Application version, from `tiapp.xml`. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} version | |
*/ | |
Titanium.App.prototype.version; | |
/** | |
* Indicates whether or not the soft keyboard is visible. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {Boolean} keyboardVisible | |
*/ | |
Titanium.App.prototype.keyboardVisible; | |
/** | |
* Indicates whether or not the user interaction shoud be tracked. | |
* @since 7.5.0 (iPhone), 7.5.0 (iPad) | |
* @type {Boolean} trackUserInteraction | |
*/ | |
Titanium.App.prototype.trackUserInteraction; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.applyProperties = function(props) {}; | |
/** | |
* Fire a system-level event such as <Titanium.App.EVENT_ACCESSIBILITY_ANNOUNCEMENT>. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {String} eventName The name of the event to fire. | |
* @param {Object=} param A parameter to be passed to the system event. | |
*/ | |
Titanium.App.fireSystemEvent = function(eventName, param) {}; | |
/** | |
* Returns the arguments passed to the application on startup. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @return {launchOptions} | |
*/ | |
Titanium.App.getArguments = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.App.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.App.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.App.accessibilityEnabled> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getAccessibilityEnabled = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.analytics> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getAnalytics = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.copyright> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getCopyright = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.deployType> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getDeployType = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.description> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getDescription = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.guid> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getGuid = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.forceSplashAsSnapshot> property. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getForceSplashAsSnapshot = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.forceSplashAsSnapshot> property. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @param {Boolean} forceSplashAsSnapshot New value for the property. | |
*/ | |
Titanium.App.setForceSplashAsSnapshot = function(forceSplashAsSnapshot) {}; | |
/** | |
* Gets the value of the <Titanium.App.id> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.installId> property. | |
* @since 2.0.0 (iPhone), 2.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getInstallId = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.idleTimerDisabled> property. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getIdleTimerDisabled = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.idleTimerDisabled> property. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @param {Boolean} idleTimerDisabled New value for the property. | |
*/ | |
Titanium.App.setIdleTimerDisabled = function(idleTimerDisabled) {}; | |
/** | |
* Gets the value of the <Titanium.App.name> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.proximityDetection> property. | |
* @since 3.3.0 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getProximityDetection = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.proximityDetection> property. | |
* @since 3.3.0 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Boolean} proximityDetection New value for the property. | |
*/ | |
Titanium.App.setProximityDetection = function(proximityDetection) {}; | |
/** | |
* Gets the value of the <Titanium.App.proximityState> property. | |
* @since 3.3.0 (Android), 0.8 (iPhone) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getProximityState = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.disableNetworkActivityIndicator> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getDisableNetworkActivityIndicator = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.disableNetworkActivityIndicator> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} disableNetworkActivityIndicator New value for the property. | |
*/ | |
Titanium.App.setDisableNetworkActivityIndicator = function(disableNetworkActivityIndicator) {}; | |
/** | |
* Gets the value of the <Titanium.App.publisher> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getPublisher = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.sessionId> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getSessionId = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.url> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getUrl = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.version> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.getVersion = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.keyboardVisible> property. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.getKeyboardVisible = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* forceSplashAsSnapshot: Boolean, | |
* idleTimerDisabled: Boolean, | |
* proximityDetection: Boolean, | |
* disableNetworkActivityIndicator: Boolean, | |
* trackUserInteraction: Boolean | |
* }} | |
*/ | |
Titanium._Dictionary_App; | |
/** | |
* A module used to access Android application resources. | |
* @extends {Titanium.Module} | |
* @description For more information, refer to the official documentation on the Android Developer website about | |
* [application resources](https://developer.android.com/guide/topics/resources/index.html). | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.App.Android = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.Android.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.Android.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.App.Android.prototype.lifecycleContainer; | |
/** | |
* The `R` namespace for application resources. | |
* @since 1.5 (Android) | |
* @readonly | |
* @type {Titanium.App.Android.R} R | |
*/ | |
Titanium.App.Android.R; | |
/** | |
* The version number of the application. | |
* | |
* @since 3.3.0 (Android) | |
* @readonly | |
* @type {Number} appVersionCode | |
*/ | |
Titanium.App.Android.prototype.appVersionCode; | |
/** | |
* The version name of the application. | |
* | |
* @since 3.3.0 (Android) | |
* @readonly | |
* @type {String} appVersionName | |
*/ | |
Titanium.App.Android.prototype.appVersionName; | |
/** | |
* Return the intent that was used to launch the application. | |
* | |
* @since 3.3.0 (Android) | |
* @readonly | |
* @type {Titanium.Android.Intent} launchIntent | |
*/ | |
Titanium.App.Android.prototype.launchIntent; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.Android.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.Android.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.Android.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.Android.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.App.Android.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.Android.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.Android.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.App.Android.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.App.Android.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.Android.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.App.Android.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.appVersionCode> property. | |
* @since 3.3.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.App.Android.getAppVersionCode = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.appVersionName> property. | |
* @since 3.3.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.App.Android.getAppVersionName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.launchIntent> property. | |
* @since 3.3.0 (Android) | |
* @return {Titanium.Android.Intent} | |
*/ | |
Titanium.App.Android.getLaunchIntent = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.App._Dictionary_Android; | |
/** | |
* The Titanium binding of the native Android `R` class, giving access to application resources. | |
* | |
* @extends {Titanium.Proxy} | |
* @description The properties and sub-properties of this object relate directly to the native application | |
* resources `R` class, and thus have the same syntax. For more information, refer to the | |
* official documentation on the Android Developer website about | |
* [accessing application resources](https://developer.android.com/guide/topics/resources/accessing-resources.html). | |
* | |
* For example, if the file | |
* `platform/android/res/drawable/icon.png` exists in the project, it can be accessed using its | |
* integer id, as follows. | |
* | |
* var resid = Titanium.App.Android.R.drawable.icon; | |
* | |
* To access system-wide resources, rather than application resources, use <Titanium.Android.R> | |
* instead. | |
* | |
* Starting in Titanium SDK 7.3.0, this API exposes all Android related R classes | |
* for the usage in Hyperloop. For example, it can be used to access `menu` resources | |
* as part of native user interfaces, e.g. `BottomNavigationView` or `RecyclerView`. | |
* See an example in the [Hyperloop Sample App](https://github.com/appcelerator/hyperloop-examples) for details! | |
* | |
* @since 1.5 (Android) | |
*/ | |
Titanium.App.Android.R = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.Android.R.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.Android.R.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.App.Android.R.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.Android.R.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.Android.R.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.Android.R.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.Android.R.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.R.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.App.Android.R.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.Android.R.bubbleParent> property. | |
* @since 3.0.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.Android.R.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.R.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.App.Android.R.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.Android.R.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.App.Android.R.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.Android.R.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.App.Android.R.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.App.Android._Dictionary_R; | |
/** | |
* The App Properties module is used for storing application-related data in property/value pairs | |
* that persist beyond application sessions and device power cycles. | |
* | |
* @extends {Titanium.Module} | |
* @description #### App Properties in the tiapp.xml file | |
* | |
* App properties defined in the `tiapp.xml` file may be accessed using these APIs. An app | |
* property is defined inside the root-level `<ti:app>` element with the `<property>` element. | |
* Use the `name` attribute to define your property name and place the value inline with the | |
* `<property>` element. For example, to define an app property called `foo` with the value `42`: | |
* | |
* <?xml version="1.0" encoding="UTF-8"?> | |
* <ti:app xmlns:ti="http://ti.appcelerator.org"> | |
* <property name="foo" type="string">42</property> | |
* </ti:app> | |
* | |
* Then, you can retrieve the property during runtime with the following API call: | |
* | |
* var foo = Ti.App.Properties.getString('foo'); | |
* | |
* As of Release 3.2.0, any application properties defined in the `tiapp.xml` file are stored in the | |
* device's secure storage, making them read-only. Additionally, external access to these | |
* properties is now restricted. Other iOS applications cannot access these properties and | |
* native Android modules must use the Titanium module API | |
* [TiApplication.getAppProperties](https://docs.appcelerator.com/module-apidoc/latest/android/org/appcelerator/platform/TiApplication.html#getAppProperties()) | |
* method to access these properties. | |
* | |
* If you need to change the values during runtime, initially create the property with these APIs | |
* rather than defining them in the `tiapp.xml` file. | |
* | |
* Prior to Release 3.2.0, application properties defined in the `tiapp.xml` file could be | |
* overwritten by these APIs and accessed externally by other applications and modules. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.App.Properties = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.Properties.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.Properties.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.App.Properties.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.Properties.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.Properties.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.Properties.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.Properties.applyProperties = function(props) {}; | |
/** | |
* Returns the value of a property as a boolean data type. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Boolean=} default_ Default value to return if property does not exist. | |
* @return {Boolean} | |
*/ | |
Titanium.App.Properties.getBool = function(property, default_) {}; | |
/** | |
* Returns the value of a property as a double (double-precision, floating point) data type. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number=} default_ Default value to return if property does not exist. | |
* @return {Number} | |
*/ | |
Titanium.App.Properties.getDouble = function(property, default_) {}; | |
/** | |
* Returns the value of a property as an integer data type. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number=} default_ Default value to return if property does not exist. | |
* @return {Number} | |
*/ | |
Titanium.App.Properties.getInt = function(property, default_) {}; | |
/** | |
* Returns the value of a property as an array data type. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Array<Object>=} default_ Default value to return if property does not exist. | |
* @return {Array<Object>} | |
*/ | |
Titanium.App.Properties.getList = function(property, default_) {}; | |
/** | |
* Returns the value of a property as an object. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Object=} default_ Default value to return if property does not exist. | |
* @return {Object} | |
*/ | |
Titanium.App.Properties.getObject = function(property, default_) {}; | |
/** | |
* Returns the value of a property as a string data type. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {String=} default_ Default value to return if property does not exist. | |
* @return {String} | |
*/ | |
Titanium.App.Properties.getString = function(property, default_) {}; | |
/** | |
* Indicates whether a property exists. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @return {Boolean} | |
*/ | |
Titanium.App.Properties.hasProperty = function(property) {}; | |
/** | |
* Returns an array of property names. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Array<Object>} | |
*/ | |
Titanium.App.Properties.listProperties = function() {}; | |
/** | |
* Removes a property if it exists, or does nothing otherwise. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
*/ | |
Titanium.App.Properties.removeProperty = function(property) {}; | |
/** | |
* Removes all properties that have been set by the user on runtime, or does nothing otherwise. | |
* @since 6.0.0 (Android), 6.0.0 (iPhone), 6.0.0 (iPad) | |
*/ | |
Titanium.App.Properties.removeAllProperties = function() {}; | |
/** | |
* Sets the value of a property as a boolean data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Boolean} value Property value. | |
*/ | |
Titanium.App.Properties.setBool = function(property, value) {}; | |
/** | |
* Sets the value of a property as a double (double-precision, floating point) data type. The | |
* property will be created if it does not exist. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number} value Property value. | |
*/ | |
Titanium.App.Properties.setDouble = function(property, value) {}; | |
/** | |
* Sets the value of a property as an integer data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number} value Property value, within the range `-2,147,483,648` to `2,147,483,647`. | |
*/ | |
Titanium.App.Properties.setInt = function(property, value) {}; | |
/** | |
* Sets the value of a property as an array data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Array<Object>} value Property value. | |
*/ | |
Titanium.App.Properties.setList = function(property, value) {}; | |
/** | |
* Sets the value of a property as an object data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {Object} value Property value. | |
*/ | |
Titanium.App.Properties.setObject = function(property, value) {}; | |
/** | |
* Sets the value of a property as a string data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} property Name of property. | |
* @param {String} value Property value. | |
*/ | |
Titanium.App.Properties.setString = function(property, value) {}; | |
/** | |
* Gets the value of the <Titanium.App.Properties.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.Properties.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.Properties.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.Properties.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.Properties.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.Properties.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.Properties.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.App.Properties.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.Properties.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.App.Properties.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.App._Dictionary_Properties; | |
/** | |
* The top-level App iOS module, available only to iOS devices, that includes the facilities to | |
* create and manage local notifications and background services. | |
* | |
* @extends {Titanium.Module} | |
* @description | |
* ### Local Notifications | |
* | |
* Local notifications are a way for an application that is not running in the foreground to let | |
* users know that it has information for them. When invoked, the application either displays a | |
* banner message or an alert dialog with a **Close** button to dismiss and an **Open** button to bring the application | |
* into the foreground. The application can also modify the icon badge, to show the | |
* number of pending notifications, and generate a sound. | |
* | |
* To send a local notification, the application needs to: | |
* | |
* 1. Enroll the application to send local notifications with the | |
* <Titanium.App.iOS.registerUserNotificationSettings> method. | |
* 2. Schedule a local notification with the <Titanium.App.iOS.scheduleLocalNotification> method. | |
* 3. Monitor the [notification](Titanium.App.iOS.notification) event to respond to the | |
* notification. | |
* | |
* For instructions on sending local interactive notifications, see the | |
* [iOS Local Notifications guide](https://docs.appcelerator.com/platform/latest/#!/guide/iOS_Local_Notifications). | |
* | |
* ### Local Interactive Notifications | |
* | |
* You can create interactive notifications, where users can respond to application notifications | |
* without launching the application to the foreground. The user needs to reveal notification | |
* actions in the notification, then press a notification action to respond to the notification. | |
* | |
* To create an interactive notification, the application needs to: | |
* | |
* 1. Create and configure notification actions with the | |
* <Titanium.App.iOS.createUserNotificationAction> method. | |
* 2. Create notification categories and assign notification actions to them | |
* with the <Titanium.App.iOS.createUserNotificationCategory> method. | |
* 3. Register the notification categories with the | |
* <Titanium.App.iOS.registerUserNotificationSettings> method. | |
* 4. Monitor the [localnotificationaction](Titanium.App.iOS.localnotificationaction) event. | |
* | |
* For instructions on sending local interactive notifications, see the | |
* [iOS Local Notifications guide](https://docs.appcelerator.com/platform/latest/#!/guide/iOS_Local_Notifications). | |
* | |
* ### Background Downloads | |
* | |
* In iOS 7, Apple introduced new background execution modes which allow the application to download | |
* content in the background. These background modes are supported in Titanium SDK 3.2.0 and later. | |
* | |
* For more information on getting started, refer to the | |
* [iOS Background Services guide](https://docs.appcelerator.com/platform/latest/#!/guide/iOS_Background_Services). | |
* | |
* ### Handoff User Activities | |
* | |
* Handoff allows you to create and transfer user activies from one device to another. For example, you can start editing | |
* a document on your phone, then transfer the activity to your iPad to continue editing the document. | |
* | |
* To make an activity shareable, use the <Titanium.App.iOS.UserActivity> API to create the activity. | |
* To continue the activity on another device, listen for the | |
* [continueactivity](Titanium.App.iOS.continueactivity) event. | |
* | |
* ### Index Application Content | |
* | |
* In iOS 9 and later, Apple lets you index application content, such as music, videos, images and documents, to allow it | |
* to be searched in iOS Spotlight. To effectively add and remove information from the iOS search index | |
* you will need to use the following APIs: | |
* | |
* * <Titanium.App.iOS.SearchableItemAttributeSet> - Used to create metadata related to the `Ti.App.iOS.SearchableItem` | |
* * <Titanium.App.iOS.SearchableItem> - Used to assemble metadata into a unique object package to be used by `Ti.App.iOS.SearchableIndex` | |
* * <Titanium.App.iOS.SearchableIndex> - Used to add and remove `Ti.App.iOS.SearchableItem` objects to the device search index | |
* | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
*/ | |
Titanium.App.iOS = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.prototype.apiName; | |
/** | |
* Convenience constant for system event "accessibilitylayoutchanged". | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @readonly | |
* @type {String} EVENT_ACCESSIBILITY_LAYOUT_CHANGED | |
*/ | |
Titanium.App.iOS.EVENT_ACCESSIBILITY_LAYOUT_CHANGED; | |
/** | |
* Convenience constant for system event "accessibilityscreenchanged". | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @readonly | |
* @type {String} EVENT_ACCESSIBILITY_SCREEN_CHANGED | |
*/ | |
Titanium.App.iOS.EVENT_ACCESSIBILITY_SCREEN_CHANGED; | |
/** | |
* Use with [setMinimumBackgroundFetchInterval](Titanium.App.iOS.setMinimumBackgroundFetchInterval) method. | |
* Specifies the smallest fetch interval supported by the system. | |
* | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {Number} BACKGROUNDFETCHINTERVAL_MIN | |
*/ | |
Titanium.App.iOS.BACKGROUNDFETCHINTERVAL_MIN; | |
/** | |
* Use with [setMinimumBackgroundFetchInterval](Titanium.App.iOS.setMinimumBackgroundFetchInterval) method. | |
* Used to specify a fetch interval large enough to prevent fetch operations from occurring. | |
* | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {Number} BACKGROUNDFETCHINTERVAL_NEVER | |
*/ | |
Titanium.App.iOS.BACKGROUNDFETCHINTERVAL_NEVER; | |
/** | |
* The application may not present any UI upon a notification being received. | |
* Use with the [types](UserNotificationSettings.types) property. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_TYPE_NONE | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_TYPE_NONE; | |
/** | |
* The application may badge its icon upon a notification being received. | |
* Use with the [types](UserNotificationSettings.types) property. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_TYPE_BADGE | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_TYPE_BADGE; | |
/** | |
* The application may play a sound upon a notification being received. | |
* Use with the [types](UserNotificationSettings.types) property. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_TYPE_SOUND | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_TYPE_SOUND; | |
/** | |
* The application may display an alert upon a notification being received. | |
* Use with the [types](UserNotificationSettings.types) property. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_TYPE_ALERT | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_TYPE_ALERT; | |
/** | |
* The ability to play sounds for critical alerts. | |
* Use with the [types](UserNotificationSettings.types) property. | |
* | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_TYPE_CRITICAL_ALERT | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_TYPE_CRITICAL_ALERT; | |
/** | |
* The ability to post non-interrupting notifications provisionally to the Notification Center. | |
* Use with the [types](UserNotificationSettings.types) property. | |
* | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_TYPE_PROVISIONAL | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_TYPE_PROVISIONAL; | |
/** | |
* An option indicating the system should display a button for in-app notification settings. | |
* Use with the [types](UserNotificationSettings.types) property. | |
* | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_TYPE_PROVIDES_APP_NOTIFICATION_SETTINGS | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_TYPE_PROVIDES_APP_NOTIFICATION_SETTINGS; | |
/** | |
* The action will execute in background. Use with the | |
* [activationMode](Titanium.App.iOS.UserNotificationAction.activationMode) property. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_ACTIVATION_MODE_BACKGROUND | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_ACTIVATION_MODE_BACKGROUND; | |
/** | |
* The action will launch the application and execute in the foreground. | |
* Use with the [activationMode](Titanium.App.iOS.UserNotificationAction.activationMode) property. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_ACTIVATION_MODE_FOREGROUND | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_ACTIVATION_MODE_FOREGROUND; | |
/** | |
* Default action behavior with no additional action support. | |
* | |
* @since 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_BEHAVIOR_DEFAULT | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_BEHAVIOR_DEFAULT; | |
/** | |
* Provides a textfield with the notification for the user to enter a text response. | |
* | |
* @since 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_BEHAVIOR_TEXTINPUT | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_BEHAVIOR_TEXTINPUT; | |
/** | |
* The user has not yet made a choice regarding whether the application may post | |
* user notifications. | |
* | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_AUTHORIZATION_STATUS_NOT_DETERMINED | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_AUTHORIZATION_STATUS_NOT_DETERMINED; | |
/** | |
* The application is authorized to post user notifications. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_AUTHORIZATION_STATUS_AUTHORIZED | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_AUTHORIZATION_STATUS_AUTHORIZED; | |
/** | |
* The application is not authorized to post user notifications. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_AUTHORIZATION_STATUS_DENIED | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_AUTHORIZATION_STATUS_DENIED; | |
/** | |
* The application is provisionally authorized to post non-interruptive user notifications. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_AUTHORIZATION_STATUS_PROVISIONAL | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_AUTHORIZATION_STATUS_PROVISIONAL; | |
/** | |
* The application does not support this notification type. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_SETTING_NOT_SUPPORTED | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_SETTING_NOT_SUPPORTED; | |
/** | |
* The notification setting is turned on. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_SETTING_ENABLED | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_SETTING_ENABLED; | |
/** | |
* The notification setting is turned off. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_SETTING_DISABLED | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_SETTING_DISABLED; | |
/** | |
* No banner or alert dialog is presented when the notification is received. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_ALERT_STYLE_NONE | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_ALERT_STYLE_NONE; | |
/** | |
* A alert dialog is presented when the notification is received. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_ALERT_STYLE_ALERT | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_ALERT_STYLE_ALERT; | |
/** | |
* A banner is presented when the notification is received. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_ALERT_STYLE_BANNER | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_ALERT_STYLE_BANNER; | |
/** | |
* No options. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_CATEGORY_OPTION_NONE | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_CATEGORY_OPTION_NONE; | |
/** | |
* Send dismiss actions to the UNUserNotificationCenter object's delegate for handling. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_CATEGORY_OPTION_CUSTOM_DISMISS_ACTION | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_CATEGORY_OPTION_CUSTOM_DISMISS_ACTION; | |
/** | |
* Allow CarPlay to display notifications of this type. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_CATEGORY_OPTION_ALLOW_IN_CARPLAY | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_CATEGORY_OPTION_ALLOW_IN_CARPLAY; | |
/** | |
* Show the notification's title, even if the user has disabled notification previews for the app. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_CATEGORY_OPTION_HIDDEN_PREVIEWS_SHOW_TITLE | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_CATEGORY_OPTION_HIDDEN_PREVIEWS_SHOW_TITLE; | |
/** | |
* Show the notification's subtitle, even if the user has disabled notification previews for the app. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {Number} USER_NOTIFICATION_CATEGORY_OPTION_HIDDEN_PREVIEWS_SHOW_SUBTITLE | |
*/ | |
Titanium.App.iOS.USER_NOTIFICATION_CATEGORY_OPTION_HIDDEN_PREVIEWS_SHOW_SUBTITLE; | |
/** | |
* An unspecified interface style. | |
* @since 8.2.0 (iPhone), 8.2.0 (iPad) | |
* @readonly | |
* @type {Number} USER_INTERFACE_STYLE_UNSPECIFIED | |
*/ | |
Titanium.App.iOS.USER_INTERFACE_STYLE_UNSPECIFIED; | |
/** | |
* A light interface style. | |
* @since 8.2.0 (iPhone), 8.2.0 (iPad) | |
* @readonly | |
* @type {Number} USER_INTERFACE_STYLE_LIGHT | |
*/ | |
Titanium.App.iOS.USER_INTERFACE_STYLE_LIGHT; | |
/** | |
* A dark interface style. | |
* @since 8.2.0 (iPhone), 8.2.0 (iPad) | |
* @readonly | |
* @type {Number} USER_INTERFACE_STYLE_DARK | |
*/ | |
Titanium.App.iOS.USER_INTERFACE_STYLE_DARK; | |
/** | |
* Uniform type identifier for all text types. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_TEXT | |
*/ | |
Titanium.App.iOS.UTTYPE_TEXT; | |
/** | |
* Uniform type identifier for a plain text type, equivalent to MIME type text/plain. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_PLAIN_TEXT | |
*/ | |
Titanium.App.iOS.UTTYPE_PLAIN_TEXT; | |
/** | |
* Uniform type identifier for Unicode-8 plain text type. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_UTF8_PLAIN_TEXT | |
*/ | |
Titanium.App.iOS.UTTYPE_UTF8_PLAIN_TEXT; | |
/** | |
* Uniform type identifier for Unicode-16 with byte-order mark (BOM), or if BOM is not present, | |
* an external representation byte order (big-endian). | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_UTF16_EXTERNAL_PLAIN_TEXT | |
*/ | |
Titanium.App.iOS.UTTYPE_UTF16_EXTERNAL_PLAIN_TEXT; | |
/** | |
* Uniform type identifier for Unicode-16, native byte order, with an optional byte-order mark (BOM). | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_UTF16_PLAIN_TEXT | |
*/ | |
Titanium.App.iOS.UTTYPE_UTF16_PLAIN_TEXT; | |
/** | |
* Uniform type identifier for Rich Text. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_RTF | |
*/ | |
Titanium.App.iOS.UTTYPE_RTF; | |
/** | |
* Uniform type identifier for HTML. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_HTML | |
*/ | |
Titanium.App.iOS.UTTYPE_HTML; | |
/** | |
* Uniform type identifier for XML. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_XML | |
*/ | |
Titanium.App.iOS.UTTYPE_XML; | |
/** | |
* Uniform type identifier for PDF data. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_PDF | |
*/ | |
Titanium.App.iOS.UTTYPE_PDF; | |
/** | |
* Uniform type identifier for Rich Text Format Directory, that is, Rich Text with content embedding, on-disk format. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_RTFD | |
*/ | |
Titanium.App.iOS.UTTYPE_RTFD; | |
/** | |
* Uniform type identifier for Rich Text with content embedding, pasteboard format. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_FLAT_RTFD | |
*/ | |
Titanium.App.iOS.UTTYPE_FLAT_RTFD; | |
/** | |
* Uniform type identifier for MLTE (Textension) format for mixed text and multimedia data. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_TXN_TEXT_AND_MULTIMEDIA_DATA | |
*/ | |
Titanium.App.iOS.UTTYPE_TXN_TEXT_AND_MULTIMEDIA_DATA; | |
/** | |
* Uniform type identifier for WebKit webarchive format. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_WEB_ARCHIVE | |
*/ | |
Titanium.App.iOS.UTTYPE_WEB_ARCHIVE; | |
/** | |
* Uniform type identifier for all image types. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_IMAGE | |
*/ | |
Titanium.App.iOS.UTTYPE_IMAGE; | |
/** | |
* Uniform type identifier for JPEG images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_JPEG | |
*/ | |
Titanium.App.iOS.UTTYPE_JPEG; | |
/** | |
* Uniform type identifier for JPEG 2000 images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_JPEG2000 | |
*/ | |
Titanium.App.iOS.UTTYPE_JPEG2000; | |
/** | |
* Uniform type identifier for TIFF images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_TIFF | |
*/ | |
Titanium.App.iOS.UTTYPE_TIFF; | |
/** | |
* Uniform type identifier for PICT images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_PICT | |
*/ | |
Titanium.App.iOS.UTTYPE_PICT; | |
/** | |
* Uniform type identifier for GIF images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_GIF | |
*/ | |
Titanium.App.iOS.UTTYPE_GIF; | |
/** | |
* Uniform type identifier for PNG images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_PNG | |
*/ | |
Titanium.App.iOS.UTTYPE_PNG; | |
/** | |
* Uniform type identifier for QuickTime images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_QUICKTIME_IMAGE | |
*/ | |
Titanium.App.iOS.UTTYPE_QUICKTIME_IMAGE; | |
/** | |
* Uniform type identifier for Mac OS icon images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_APPLE_ICNS | |
*/ | |
Titanium.App.iOS.UTTYPE_APPLE_ICNS; | |
/** | |
* Uniform type identifier for Windows bitmap images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_BMP | |
*/ | |
Titanium.App.iOS.UTTYPE_BMP; | |
/** | |
* Uniform type identifier for Windows icon images. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_ICO | |
*/ | |
Titanium.App.iOS.UTTYPE_ICO; | |
/** | |
* Uniform type identifier for all audiovisual content. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_MOVIE | |
*/ | |
Titanium.App.iOS.UTTYPE_MOVIE; | |
/** | |
* Uniform type identifier for all video content without audio. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_VIDEO | |
*/ | |
Titanium.App.iOS.UTTYPE_VIDEO; | |
/** | |
* Uniform type identifier for all audio content. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_AUDIO | |
*/ | |
Titanium.App.iOS.UTTYPE_AUDIO; | |
/** | |
* Uniform type identifier for QuickTime movies. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_QUICKTIME_MOVIE | |
*/ | |
Titanium.App.iOS.UTTYPE_QUICKTIME_MOVIE; | |
/** | |
* Uniform type identifier for MPEG-1 and MPEG-2 content. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_MPEG | |
*/ | |
Titanium.App.iOS.UTTYPE_MPEG; | |
/** | |
* Uniform type identifier for MPEG-4 content. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_MPEG4 | |
*/ | |
Titanium.App.iOS.UTTYPE_MPEG4; | |
/** | |
* Uniform type identifier for MP3 audio. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_MP3 | |
*/ | |
Titanium.App.iOS.UTTYPE_MP3; | |
/** | |
* Uniform type identifier for MPEG-4 audio. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_MPEG4_AUDIO | |
*/ | |
Titanium.App.iOS.UTTYPE_MPEG4_AUDIO; | |
/** | |
* Uniform type identifier for protected MPEG-4 audio (iTunes music store format). | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} UTTYPE_APPLE_PROTECTED_MPEG4_AUDIO | |
*/ | |
Titanium.App.iOS.UTTYPE_APPLE_PROTECTED_MPEG4_AUDIO; | |
/** | |
* Notification types and user notification categories the application is registered to use. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {UserNotificationSettings} currentUserNotificationSettings | |
*/ | |
Titanium.App.iOS.prototype.currentUserNotificationSettings; | |
/** | |
* Provides an Array of the NSUserActivityTypes keys defined within your Titanium project. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {Array<String>} supportedUserActivityTypes | |
*/ | |
Titanium.App.iOS.prototype.supportedUserActivityTypes; | |
/** | |
* Returns a URL to open the app's settings. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {String} applicationOpenSettingsURL | |
*/ | |
Titanium.App.iOS.prototype.applicationOpenSettingsURL; | |
/** | |
* The style associated with the user interface. | |
* @since 8.2.0 (iPhone), 8.2.0 (iPad) | |
* @readonly | |
* @type {Array<String>} userInterfaceStyle | |
*/ | |
Titanium.App.iOS.prototype.userInterfaceStyle; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.applyProperties = function(props) {}; | |
/** | |
* Creates and returns an instance of Titanium.App.iOS.UserDefaults. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_UserDefaults} parameters Properties to set on a new object, including any defined by Titanium.App.iOS.UserDefaults except those marked not-creation or read-only. | |
* @return {Titanium.App.iOS.UserDefaults} | |
*/ | |
Titanium.App.iOS.createUserDefaults = function(parameters) {}; | |
/** | |
* Cancels all scheduled local notifications. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
*/ | |
Titanium.App.iOS.cancelAllLocalNotifications = function() {}; | |
/** | |
* Cancels a local notification. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {Number|String} id Application-created ID of the local notification to cancel. | |
* To create an ID for the notification, set the `id` property in the `userInfo` dictionary | |
* passed to the <Titanium.App.iOS.scheduleLocalNotification> method. | |
* | |
*/ | |
Titanium.App.iOS.cancelLocalNotification = function(id) {}; | |
/** | |
* Registers a service to run when the application is placed in the background. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {Dictionary} params Parameters used to create the service. Must include a `url` property, to specify the | |
* local JavaScript file to execute when the application is placed in the background. | |
* | |
* @return {Titanium.App.iOS.BackgroundService} | |
*/ | |
Titanium.App.iOS.registerBackgroundService = function(params) {}; | |
/** | |
* Registers the application to use the requested notification types and categories. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {UserNotificationSettings} params Parameters used to enroll the application in local notifications. | |
*/ | |
Titanium.App.iOS.registerUserNotificationSettings = function(params) {}; | |
/** | |
* Schedule a local notification. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {NotificationParams} params Parameters used to create a notification. | |
* @return {Titanium.App.iOS.LocalNotification} | |
*/ | |
Titanium.App.iOS.scheduleLocalNotification = function(params) {}; | |
/** | |
* Specifies the minimum amount of time that must elapse between background fetch operations. | |
* Available only on iOS 7 and later. | |
* | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {Number} fetchInterval The minimum number of seconds that must elapse before another background fetch can be initiated. | |
* This value is advisory only and does not indicate the exact amount of time expected between | |
* fetch operations. | |
* | |
*/ | |
Titanium.App.iOS.setMinimumBackgroundFetchInterval = function(fetchInterval) {}; | |
/** | |
* Marks the end of the app execution after initiating the download operation. Available only on iOS 7 and later. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @param {String} handlerID Unique string identifier for the event (`backgroundfetch`, `silentpush` or `backgroundtransfer`) | |
* that initiated the background opertation mode. | |
* | |
*/ | |
Titanium.App.iOS.endBackgroundHandler = function(handlerID) {}; | |
/** | |
* Marks the end of an `openParentApplication:reply` execution by a WatchKit extension. | |
* @since 4.1.0 (iPhone), 4.1.0 (iPad) | |
* @param {String} handlerId Unique string identifier for the event (`watchkitextensionrequest`) | |
* that initiated from the WatchKit extension calling the openParentApplication:reply method. | |
* | |
* @param {Dictionary} userInfo Custom data object which will be passed in the reply method to your WatchKit extension. | |
* | |
*/ | |
Titanium.App.iOS.sendWatchExtensionReply = function(handlerId, userInfo) {}; | |
/** | |
* Creates and returns an instance of <Titanium.App.iOS.SearchQuery>. | |
* | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_SearchQuery=} parameters Properties to set on a new object, including any defined by <Titanium.App.iOS.SearchQuery> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.App.iOS.SearchQuery} | |
*/ | |
Titanium.App.iOS.createSearchQuery = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.App.iOS.SearchableIndex>. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_SearchableIndex=} parameters Properties to set on a new object, including any defined by <Titanium.App.iOS.SearchableIndex> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.App.iOS.SearchableIndex} | |
*/ | |
Titanium.App.iOS.createSearchableIndex = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.App.iOS.SearchableItem>. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_SearchableItem=} parameters Properties to set on a new object, including any defined by <Titanium.App.iOS.SearchableItem> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.App.iOS.SearchableItem} | |
*/ | |
Titanium.App.iOS.createSearchableItem = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.App.iOS.SearchableItemAttributeSet>. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_SearchableItemAttributeSet=} parameters Properties to set on a new object, including any defined by <Titanium.App.iOS.SearchableItemAttributeSet> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.App.iOS.SearchableItemAttributeSet} | |
*/ | |
Titanium.App.iOS.createSearchableItemAttributeSet = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.App.iOS.UserActivity>. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_UserActivity=} parameters Properties to set on a new object, including any defined by <Titanium.App.iOS.UserActivity> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.App.iOS.UserActivity} | |
*/ | |
Titanium.App.iOS.createUserActivity = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.App.iOS.UserNotificationAction>. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_UserNotificationAction=} parameters Properties to set on a new object, including any defined by <Titanium.App.iOS.UserNotificationAction> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.App.iOS.UserNotificationAction} | |
*/ | |
Titanium.App.iOS.createUserNotificationAction = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.App.iOS.UserNotificationCategory>. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {Titanium.App.iOS._Dictionary_UserNotificationCategory=} parameters Properties to set on a new object, including any defined by <Titanium.App.iOS.UserNotificationCategory> except those marked not-creation or read-only. | |
* | |
* @return {Titanium.App.iOS.UserNotificationCategory} | |
*/ | |
Titanium.App.iOS.createUserNotificationCategory = function(parameters) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.apiName> property. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.currentUserNotificationSettings> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @return {UserNotificationSettings} | |
*/ | |
Titanium.App.iOS.getCurrentUserNotificationSettings = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.supportedUserActivityTypes> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.getSupportedUserActivityTypes = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.applicationOpenSettingsURL> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.getApplicationOpenSettingsURL = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.userInterfaceStyle> property. | |
* @since 8.2.0 (iPhone), 8.2.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.getUserInterfaceStyle = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean | |
* }} | |
*/ | |
Titanium.App._Dictionary_iOS; | |
/** | |
* A service that runs when the application is placed in the background. | |
* @extends {Titanium.Proxy} | |
* @description A background service is created by <Titanium.App.iOS.registerBackgroundService>. | |
* | |
* At creation, a local URL to a JavaScript file must be defined. The code it contains is executed | |
* each time the application is no longer in the foreground, along with all other services that have | |
* been registered in the same way. When this happens, all background services continue to run until | |
* one of the following occurs: | |
* | |
* * A service is stopped with the `stop` method. | |
* * The application resumes, at which points all background services are stopped. | |
* * The OS terminates the service for one of the reasons discussed in | |
* "Background Service Limitations", below. | |
* | |
* A background service can invoke a <Titanium.App.iOS.LocalNotification>, which prompts users via | |
* a dialog to return to the application and provides a button that brings it back into the | |
* foreground. | |
* | |
* #### Background Service Limitations | |
* | |
* A background service is subject to limitations imposed by the operating system, such as | |
* | |
* * The OS limits the total amount of time a background service can run for after the application | |
* is paused, typically to no more than 10 minutes. | |
* * The OS may terminate the background service at any point to reclaim resources. | |
* | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
*/ | |
Titanium.App.iOS.BackgroundService = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.BackgroundService.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.BackgroundService.prototype.apiName; | |
/** | |
* A local URL to a JavaScript file containing the code to run in the background. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @type {String} url | |
*/ | |
Titanium.App.iOS.BackgroundService.prototype.url; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.BackgroundService.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.BackgroundService.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.BackgroundService.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.BackgroundService.applyProperties = function(props) {}; | |
/** | |
* Stops the service from running during the current background session to conserve resources. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
*/ | |
Titanium.App.iOS.BackgroundService.stop = function() {}; | |
/** | |
* Unregisters the background service. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
*/ | |
Titanium.App.iOS.BackgroundService.unregister = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.BackgroundService.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.BackgroundService.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.BackgroundService.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.BackgroundService.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.BackgroundService.apiName> property. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.BackgroundService.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.BackgroundService.url> property. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.BackgroundService.getUrl = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.BackgroundService.url> property. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} url New value for the property. | |
*/ | |
Titanium.App.iOS.BackgroundService.setUrl = function(url) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* url: String | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_BackgroundService; | |
/** | |
* A local notification to alert the user of new or pending application information. | |
* @extends {Titanium.Proxy} | |
* @description A LocalNotification is created by <Titanium.App.iOS.scheduleLocalNotification>. | |
* | |
* Local notifications are a way for an application that is not running in the foreground to let | |
* users know that it has information for them. When invoked, the application either displays a | |
* banner message or an alert dialog with a **Close** button to dismiss and an **Open** button to bring the application | |
* into the foreground. The application can also modify the icon badge, to show the | |
* number of pending notifications, and generate a sound. | |
* | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
*/ | |
Titanium.App.iOS.LocalNotification = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.LocalNotification.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.LocalNotification.prototype.apiName; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.LocalNotification.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.LocalNotification.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.LocalNotification.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.LocalNotification.applyProperties = function(props) {}; | |
/** | |
* Cancels the pending notification. | |
* @since 1.5 (iPhone), 1.5 (iPad) | |
*/ | |
Titanium.App.iOS.LocalNotification.cancel = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.LocalNotification.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.LocalNotification.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.LocalNotification.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.LocalNotification.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.LocalNotification.apiName> property. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.LocalNotification.getApiName = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_LocalNotification; | |
/** | |
* A search query object manages the criteria to apply when searching app content that you have previously | |
* indexed by using the Core Spotlight APIs. | |
* | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description You can use this API to search multiple <Titanium.App.iOS.SearchableItem> objects at the same time. You can do that | |
* by using the `queryString` parameter that has a special syntax to filter and index several items. Please refer | |
* to the official [Apple documentation](https://developer.apple.com/reference/corespotlight/cssearchquery) for detailed information on how to structure your search-query to get the | |
* best possible results. | |
* | |
* To use this feature make sure you have a compatible device running iOS 10 or later. | |
* | |
* To create a SearchableItem object, use the Titanium.App.iOS.createSearchableItem method. | |
* Pass a dictionary of properties to the method that will help identify the item. | |
* At minimum, you must set the [attributeSet](Titanium.App.iOS.SearchableItem.attributeSet) property, which associates | |
* the metadata with the SearchableItem object. | |
* | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
*/ | |
Titanium.App.iOS.SearchQuery = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.apiName; | |
/** | |
* A formatted string that defines the matching criteria to apply to indexed items. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @type {String} queryString | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.queryString; | |
/** | |
* An array of strings that represent the attributes of indexed items. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @type {Array<String>} attributes | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.attributes; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.applyProperties = function(props) {}; | |
/** | |
* Asynchronously queries the index for items that match the query object's specifications. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.start = function() {}; | |
/** | |
* Cancels a query operation. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.cancel = function() {}; | |
/** | |
* A Boolean value that indicates if the query has been cancelled (`true`) or not (`false`). | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.isCancelled = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchQuery.bubbleParent> property. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchQuery.bubbleParent> property. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchQuery.apiName> property. | |
* @since 5.5.0 (iPhone), 5.5.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchQuery.prototype.getApiName = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* queryString: String, | |
* attributes: Array<String> | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_SearchQuery; | |
/** | |
* The SearchableIndex module is used to add or remove Ti.App.iOS.SearchableItem objects from the device search index. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description To effectively add and remove information from the iOS search index you will need to use the following modules: | |
* | |
* * <Titanium.App.iOS.SearchableItemAttributeSet> - Used to create metadata related to the `Ti.App.iOS.SearchableItem` | |
* * <Titanium.App.iOS.SearchableItem> - Used to assemble metadata into a unique object package to be used by `Ti.App.iOS.SearchableIndex` | |
* * <Titanium.App.iOS.SearchableIndex> - Used to add and remove `Ti.App.iOS.SearchableItem` objects to the device search index | |
* | |
* To use this feature make sure you have a compatible device running iOS 9 or later. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.SearchableIndex = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.apiName; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.applyProperties = function(props) {}; | |
/** | |
* Indicates whether indexing is supported by the device. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.isSupported = function() {}; | |
/** | |
* Adds an array of Titanium.App.iOS.SearchableItem objects to the default search index. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<Titanium.App.iOS.SearchableItem>} Array Array of Titanium.App.iOS.SearchableItem objects to be added to the default search index. | |
* @param {Callback<Dictionary>} callback Function to invoke on success or failure of adding the array Titanium.App.iOS.SearchableItem object to the default search index. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.addToDefaultSearchableIndex = function(Array, callback) {}; | |
/** | |
* Removes all search items added by the application. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Callback<Dictionary>} callback Function to invoke on success or failure of deleting all search items. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.deleteAllSearchableItems = function(callback) {}; | |
/** | |
* Removes search items based on an array of domain identifiers. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} Array Array of domain identifiers to be removed from the default search index. | |
* @param {Callback<Dictionary>} callback Function to invoke on success or failure of removing search items from the default search index. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.deleteAllSearchableItemByDomainIdenifiers = function(Array, callback) {}; | |
/** | |
* Removes search items based on an array of identifiers. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} Array Array of identifiers to be removed from the default search index. | |
* @param {Callback<Dictionary>} callback Function to invoke on success or failure of removing search items from the default search index. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.deleteSearchableItemsByIdentifiers = function(Array, callback) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableIndex.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableIndex.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableIndex.apiName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableIndex.prototype.getApiName = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_SearchableIndex; | |
/** | |
* Used to create a unique object containing all of the search information that will appear in the device search index. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description To effectively add and remove information from the iOS search index you will need to use the below listed modules: | |
* | |
* * <Titanium.App.iOS.SearchableItemAttributeSet> - Used to create metadata related to the `Ti.App.iOS.SearchableItem` | |
* * <Titanium.App.iOS.SearchableItem> - Used to assemble metadata into a unique object package to be used by `Ti.App.iOS.SearchableIndex` | |
* * <Titanium.App.iOS.SearchableIndex> - Used to add and remove `Ti.App.iOS.SearchableItem` objects to the device search index | |
* | |
* To use this feature make sure you have a compatible device running iOS 9 or later. | |
* | |
* To create a SearchableItem object, use the Titanium.App.iOS.createSearchableItem method. | |
* Pass a dictionary of properties to the method that will help identify the item. | |
* At minimum, you must set the [attributeSet](Titanium.App.iOS.SearchableItem.attributeSet) property, which associates | |
* the metadata with the SearchableItem object. | |
* | |
* Then, pass the SearchableItem object to a SearchableIndex object's | |
* [addToDefaultSearchableIndex()](Titanium.App.iOS.SearchableIndex.addToDefaultSearchableIndex) method to add the item | |
* to the device's search index. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.SearchableItem = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.apiName; | |
/** | |
* Set of metadata properties to display for the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Titanium.App.iOS.SearchableItemAttributeSet} attributeSet | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.attributeSet; | |
/** | |
* Identifier that represents the "domain" or owner of this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} domainIdentifier | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.domainIdentifier; | |
/** | |
* Searchable items have an expiration date or time to live. By default it is set to one month. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} expirationDate | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.expirationDate; | |
/** | |
* Unique identifier to your application group. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} uniqueIdentifier | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.uniqueIdentifier; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItem.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItem.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItem.apiName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItem.domainIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.getDomainIdentifier = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItem.domainIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} domainIdentifier New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.setDomainIdentifier = function(domainIdentifier) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItem.expirationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.getExpirationDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItem.expirationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} expirationDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.setExpirationDate = function(expirationDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItem.uniqueIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.getUniqueIdentifier = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItem.uniqueIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} uniqueIdentifier New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItem.prototype.setUniqueIdentifier = function(uniqueIdentifier) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* attributeSet: Titanium.App.iOS.SearchableItemAttributeSet, | |
* domainIdentifier: String, | |
* expirationDate: String, | |
* uniqueIdentifier: String | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_SearchableItem; | |
/** | |
* The SearchableItemAttributeSet module defines metadata properties for SearchItem and UserActivity objects. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description The SearchableItemAttributeSet object provides a large number of properties covering most common scenarios such | |
* as files, music, video, and document searches. To effectively add and remove information from the iOS search index | |
* you will need to use the below listed modules: | |
* | |
* * <Titanium.App.iOS.SearchableItemAttributeSet> - Used to create metadata related to the `Ti.App.iOS.SearchableItem` | |
* * <Titanium.App.iOS.SearchableItem> - Used to assemble metadata into a unique object package to be used by `Ti.App.iOS.SearchableIndex` | |
* * <Titanium.App.iOS.SearchableIndex> - Used to add and remove `Ti.App.iOS.SearchableItem` objects to the device search index | |
* | |
* To use this feature make sure you have a compatible device running iOS 9 or later. | |
* | |
* To create a SearchableItemAttributeSet object, use the Titanium.App.iOS.createSearchableItemAttributeSet method. | |
* Pass a dictionary of metadata properties to the method to associate with a SearchableItem object or UserActivity. | |
* At minimum, you must set the [itemContentType](Titanium.App.iOS.SearchableItemAttributeSet.itemContentType) property. | |
* | |
* Pass the SearchableItemAttributeSet object to either the Titanium.App.iOS.createSearchableItem method to the `attributeSet` key | |
* or to a UserActivity object's [addContentAttributeSet()](Titanium.App.iOS.UserActivity.addContentAttributeSet) method. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.apiName; | |
/** | |
* Content type of the attribute set. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} itemContentType | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.itemContentType; | |
/** | |
* A localized string to be displayed in the UI for this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} displayName | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.displayName; | |
/** | |
* An array of localized strings of alternate display names for this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} alternateNames | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.alternateNames; | |
/** | |
* The complete path to the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} path | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.path; | |
/** | |
* File URL representing the content to be indexed. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} contentURL | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentURL; | |
/** | |
* File URL pointing to a thumbnail image for this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} thumbnailURL | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.thumbnailURL; | |
/** | |
* Image data for thumbnail for this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String|Titanium.Blob} thumbnailData | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.thumbnailData; | |
/** | |
* For activities this is the unique identifier for the item this activity is related to. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} relatedUniqueIdentifier | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.relatedUniqueIdentifier; | |
/** | |
* The date that the last metadata attribute was changed. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} metadataModificationDate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.metadataModificationDate; | |
/** | |
* UTI Type pedigree for an item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} contentType | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentType; | |
/** | |
* Array of strings related to the content tree of the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} contentTypeTree | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentTypeTree; | |
/** | |
* Represents keywords associated with this particular item. Example keywords might be Birthday etc. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} keywords | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.keywords; | |
/** | |
* The title of the particular item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} title | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.title; | |
/** | |
* Subject of the the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} subject | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.subject; | |
/** | |
* Theme of the the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} theme | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.theme; | |
/** | |
* An account of the content of the resource. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} contentDescription | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentDescription; | |
/** | |
* Used to reference to the resource within a given context. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} identifier | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.identifier; | |
/** | |
* A class of entity for whom the resource is intended or useful. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} audiences | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.audiences; | |
/** | |
* Size of the document in MB. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} fileSize | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.fileSize; | |
/** | |
* Number of pages in the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} pageCount | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.pageCount; | |
/** | |
* Width in points (72 points per inch) of the document page. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} pageWidth | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.pageWidth; | |
/** | |
* Height in points (72 points per inch) of the document page. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} pageHeight | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.pageHeight; | |
/** | |
* Security (encryption) method used in the file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} securityMethod | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.securityMethod; | |
/** | |
* Application used to create the document content (e.g. "Word","Framemaker", etc.). | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} creator | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.creator; | |
/** | |
* Software used to convert the original content into a PDF stream. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} encodingApplications | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.encodingApplications; | |
/** | |
* Kind that the item represents. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} kind | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.kind; | |
/** | |
* Array of font names used in the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} fontNames | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.fontNames; | |
/** | |
* The sample rate of the audio data contained in the file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} audioSampleRate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.audioSampleRate; | |
/** | |
* The number of channels in the audio data contained in the file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} audioChannelCount | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.audioChannelCount; | |
/** | |
* The tempo of the music contained in the audio file in Beats Per Minute. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} tempo | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.tempo; | |
/** | |
* The musical key of the song/composition contained in an audio file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} keySignature | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.keySignature; | |
/** | |
* The time signature of the musical composition contained in the audio/MIDI file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} timeSignature | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.timeSignature; | |
/** | |
* The name of the application that encoded the data contained in the audio file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} audioEncodingApplication | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.audioEncodingApplication; | |
/** | |
* The composer of the song/composition contained in the audio file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} composer | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.composer; | |
/** | |
* The lyricist/text writer for song/composition contained in the audio file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} lyricist | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.lyricist; | |
/** | |
* The title for a collection of media. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} album | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.album; | |
/** | |
* The artist for the media. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} artist | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.artist; | |
/** | |
* The track number of a song/composition when it is part of an album. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} audioTrackNumber | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.audioTrackNumber; | |
/** | |
* The recording date of the song/composition. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} recordingDate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.recordingDate; | |
/** | |
* The musical genre of the song/composition contained in the audio file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} musicalGenre | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.musicalGenre; | |
/** | |
* Used to indicates whether the MIDI sequence contained in the file is setup for use with a General MIDI device. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} generalMIDISequence | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.generalMIDISequence; | |
/** | |
* Metadata attribute that stores the category of instrument. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} musicalInstrumentCategory | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.musicalInstrumentCategory; | |
/** | |
* Metadata attribute that stores the name of instrument. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} musicalInstrumentName | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.musicalInstrumentName; | |
/** | |
* Used to indicate that using the phone number is appropriate. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} supportsPhoneCall | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.supportsPhoneCall; | |
/** | |
* Used to determine if navigation is supported. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} supportsNavigation | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.supportsNavigation; | |
/** | |
* Title displayed in the search container | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} containerTitle | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.containerTitle; | |
/** | |
* Display of the search container | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} containerDisplayName | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.containerDisplayName; | |
/** | |
* Identifier for the search container | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} containerIdentifier | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.containerIdentifier; | |
/** | |
* Order the search container is displayed. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} containerOrder | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.containerOrder; | |
/** | |
* The list of editor/editors that have worked on this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} editors | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.editors; | |
/** | |
* The list of people who are visible in an image or movie or written about in a document. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} participants | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.participants; | |
/** | |
* The list of projects that this item is part of. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} projects | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.projects; | |
/** | |
* The date that the file was last downloaded / received. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} downloadedDate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.downloadedDate; | |
/** | |
* The date that the item was last used. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} lastUsedDate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.lastUsedDate; | |
/** | |
* The date that the contents of the item were created. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} contentCreationDate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentCreationDate; | |
/** | |
* The date that the contents of the item were last modified. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} contentModificationDate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentModificationDate; | |
/** | |
* The date that the item was moved into the current location. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} addedDate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.addedDate; | |
/** | |
* Used to indicate where the item was obtained from. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} contentSources | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentSources; | |
/** | |
* Comment related to a file. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} comment | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.comment; | |
/** | |
* Copyright of the content. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} copyright | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.copyright; | |
/** | |
* Duration in seconds of the content of the item (if appropriate). | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} duration | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.duration; | |
/** | |
* A list of contacts that are somehow associated with this document beyond what is captured as Author. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} contactKeywords | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contactKeywords; | |
/** | |
* The codecs used to encode/decode the media. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} codecs | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.codecs; | |
/** | |
* Used to indicate company/Organization that created the document. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} organizations | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.organizations; | |
/** | |
* Media types present in the content. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} mediaTypes | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.mediaTypes; | |
/** | |
* A version specifier for this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} version | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.version; | |
/** | |
* Used to indicate the role of the document creator. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} role | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.role; | |
/** | |
* Whether the content is prepared for streaming. Set to `0` for not streamable and `1` for streamable. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} streamable | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.streamable; | |
/** | |
* The total bit rate (audio and video combined) of the media. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} totalBitRate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.totalBitRate; | |
/** | |
* The video bit rate. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} videoBitRate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.videoBitRate; | |
/** | |
* The audio bit rate. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} audioBitRate | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.audioBitRate; | |
/** | |
* The delivery type of the item. Set to `0` for fast start and `1` for RTSP. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} deliveryType | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.deliveryType; | |
/** | |
* Used to designate the languages of the intellectual content of the resource. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} languages | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.languages; | |
/** | |
* Used to provide a link to information about rights held in and over resource. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} rights | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.rights; | |
/** | |
* Used to designate the entity responsible for making the resource available. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} publishers | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.publishers; | |
/** | |
* Used to designate the entity responsible for making contributions to the content of the resource. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} contributors | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contributors; | |
/** | |
* Used to designate the extent or scope of the content of the resource. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} coverage | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.coverage; | |
/** | |
* User rating of this item out of 5 stars. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} rating | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.rating; | |
/** | |
* A description of the rating, for example, the number of reviewers. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} ratingDescription | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.ratingDescription; | |
/** | |
* User play count of this item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} playCount | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.playCount; | |
/** | |
* Information about the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} information | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.information; | |
/** | |
* Director of the item, for example, the movie director. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} director | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.director; | |
/** | |
* Producer of the content. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} producer | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.producer; | |
/** | |
* Genre of the item, for example, movie genre. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} genre | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.genre; | |
/** | |
* Performers in the movie. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} performers | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.performers; | |
/** | |
* Original format of the movie. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} originalFormat | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.originalFormat; | |
/** | |
* Original source of the movie. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} originalSource | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.originalSource; | |
/** | |
* Whether or not the item is local. Set to `1` if true and `0` otherwise. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} local | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.local; | |
/** | |
* Whether or not the item has explicit content. Set to `1` for explicit or `0` for clean. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Number} contentRating | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.contentRating; | |
/** | |
* URL of the item. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} url | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.url; | |
/** | |
* The fully formatted address of the item (obtained from MapKit). | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @type {String} fullyFormattedAddress | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.fullyFormattedAddress; | |
/** | |
* The sub-location (e.g., street number) for the item according to guidelines established by the provider. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @type {String} subThoroughfare | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.subThoroughfare; | |
/** | |
* The location (e.g., street name) for the item according to guidelines established by the provider. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @type {String} thoroughfare | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.thoroughfare; | |
/** | |
* The postal code for the item according to guidelines established by the provider. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @type {String} postalCode | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.postalCode; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.apiName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.displayName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getDisplayName = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.displayName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} displayName New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setDisplayName = function(displayName) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.alternateNames> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAlternateNames = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.alternateNames> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} alternateNames New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAlternateNames = function(alternateNames) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.path> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPath = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.path> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} path New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPath = function(path) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentURL> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentURL = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentURL> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} contentURL New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentURL = function(contentURL) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.thumbnailURL> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getThumbnailURL = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.thumbnailURL> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} thumbnailURL New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setThumbnailURL = function(thumbnailURL) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.thumbnailData> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String|Titanium.Blob} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getThumbnailData = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.thumbnailData> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String|Titanium.Blob} thumbnailData New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setThumbnailData = function(thumbnailData) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.relatedUniqueIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getRelatedUniqueIdentifier = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.relatedUniqueIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} relatedUniqueIdentifier New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setRelatedUniqueIdentifier = function(relatedUniqueIdentifier) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.metadataModificationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getMetadataModificationDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.metadataModificationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} metadataModificationDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setMetadataModificationDate = function(metadataModificationDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentType> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentType = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentType> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} contentType New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentType = function(contentType) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentTypeTree> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentTypeTree = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentTypeTree> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} contentTypeTree New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentTypeTree = function(contentTypeTree) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.keywords> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getKeywords = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.keywords> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} keywords New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setKeywords = function(keywords) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.title> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.title> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} title New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setTitle = function(title) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.subject> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getSubject = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.subject> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} subject New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setSubject = function(subject) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.theme> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getTheme = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.theme> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} theme New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setTheme = function(theme) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentDescription> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentDescription = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentDescription> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} contentDescription New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentDescription = function(contentDescription) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.identifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getIdentifier = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.identifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} identifier New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setIdentifier = function(identifier) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audiences> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAudiences = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audiences> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} audiences New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAudiences = function(audiences) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.fileSize> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getFileSize = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.fileSize> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} fileSize New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setFileSize = function(fileSize) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.pageCount> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPageCount = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.pageCount> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} pageCount New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPageCount = function(pageCount) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.pageWidth> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPageWidth = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.pageWidth> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} pageWidth New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPageWidth = function(pageWidth) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.pageHeight> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPageHeight = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.pageHeight> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} pageHeight New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPageHeight = function(pageHeight) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.securityMethod> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getSecurityMethod = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.securityMethod> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} securityMethod New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setSecurityMethod = function(securityMethod) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.creator> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getCreator = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.creator> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} creator New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setCreator = function(creator) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.encodingApplications> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getEncodingApplications = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.encodingApplications> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} encodingApplications New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setEncodingApplications = function(encodingApplications) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.kind> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getKind = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.kind> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} kind New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setKind = function(kind) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.fontNames> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getFontNames = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.fontNames> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} fontNames New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setFontNames = function(fontNames) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioSampleRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAudioSampleRate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioSampleRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} audioSampleRate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAudioSampleRate = function(audioSampleRate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioChannelCount> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAudioChannelCount = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioChannelCount> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} audioChannelCount New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAudioChannelCount = function(audioChannelCount) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.tempo> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getTempo = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.tempo> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} tempo New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setTempo = function(tempo) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.keySignature> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getKeySignature = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.keySignature> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} keySignature New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setKeySignature = function(keySignature) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.timeSignature> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getTimeSignature = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.timeSignature> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} timeSignature New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setTimeSignature = function(timeSignature) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioEncodingApplication> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAudioEncodingApplication = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioEncodingApplication> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} audioEncodingApplication New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAudioEncodingApplication = function(audioEncodingApplication) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.composer> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getComposer = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.composer> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} composer New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setComposer = function(composer) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.lyricist> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getLyricist = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.lyricist> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} lyricist New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setLyricist = function(lyricist) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.album> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAlbum = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.album> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} album New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAlbum = function(album) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.artist> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getArtist = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.artist> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} artist New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setArtist = function(artist) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioTrackNumber> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAudioTrackNumber = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioTrackNumber> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} audioTrackNumber New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAudioTrackNumber = function(audioTrackNumber) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.recordingDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getRecordingDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.recordingDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} recordingDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setRecordingDate = function(recordingDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.musicalGenre> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getMusicalGenre = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.musicalGenre> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} musicalGenre New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setMusicalGenre = function(musicalGenre) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.generalMIDISequence> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getGeneralMIDISequence = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.generalMIDISequence> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} generalMIDISequence New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setGeneralMIDISequence = function(generalMIDISequence) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.musicalInstrumentCategory> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getMusicalInstrumentCategory = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.musicalInstrumentCategory> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} musicalInstrumentCategory New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setMusicalInstrumentCategory = function(musicalInstrumentCategory) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.musicalInstrumentName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getMusicalInstrumentName = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.musicalInstrumentName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} musicalInstrumentName New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setMusicalInstrumentName = function(musicalInstrumentName) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.supportsPhoneCall> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getSupportsPhoneCall = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.supportsPhoneCall> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} supportsPhoneCall New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setSupportsPhoneCall = function(supportsPhoneCall) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.supportsNavigation> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getSupportsNavigation = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.supportsNavigation> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} supportsNavigation New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setSupportsNavigation = function(supportsNavigation) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerTitle> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContainerTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerTitle> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} containerTitle New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContainerTitle = function(containerTitle) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerDisplayName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContainerDisplayName = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerDisplayName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} containerDisplayName New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContainerDisplayName = function(containerDisplayName) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContainerIdentifier = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerIdentifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} containerIdentifier New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContainerIdentifier = function(containerIdentifier) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerOrder> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContainerOrder = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.containerOrder> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} containerOrder New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContainerOrder = function(containerOrder) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.editors> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getEditors = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.editors> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} editors New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setEditors = function(editors) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.participants> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getParticipants = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.participants> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} participants New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setParticipants = function(participants) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.projects> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getProjects = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.projects> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} projects New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setProjects = function(projects) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.downloadedDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getDownloadedDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.downloadedDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} downloadedDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setDownloadedDate = function(downloadedDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.lastUsedDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getLastUsedDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.lastUsedDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} lastUsedDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setLastUsedDate = function(lastUsedDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentCreationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentCreationDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentCreationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} contentCreationDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentCreationDate = function(contentCreationDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentModificationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentModificationDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentModificationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} contentModificationDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentModificationDate = function(contentModificationDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.addedDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAddedDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.addedDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} addedDate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAddedDate = function(addedDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentSources> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentSources = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentSources> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} contentSources New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentSources = function(contentSources) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.comment> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getComment = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.comment> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} comment New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setComment = function(comment) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.copyright> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getCopyright = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.copyright> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} copyright New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setCopyright = function(copyright) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.duration> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getDuration = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.duration> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} duration New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setDuration = function(duration) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contactKeywords> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContactKeywords = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contactKeywords> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} contactKeywords New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContactKeywords = function(contactKeywords) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.codecs> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getCodecs = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.codecs> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} codecs New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setCodecs = function(codecs) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.organizations> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getOrganizations = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.organizations> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} organizations New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setOrganizations = function(organizations) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.mediaTypes> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getMediaTypes = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.mediaTypes> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} mediaTypes New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setMediaTypes = function(mediaTypes) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.version> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getVersion = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.version> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} version New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setVersion = function(version) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.role> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getRole = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.role> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} role New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setRole = function(role) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.streamable> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getStreamable = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.streamable> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} streamable New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setStreamable = function(streamable) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.totalBitRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getTotalBitRate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.totalBitRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} totalBitRate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setTotalBitRate = function(totalBitRate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.videoBitRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getVideoBitRate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.videoBitRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} videoBitRate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setVideoBitRate = function(videoBitRate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioBitRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getAudioBitRate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.audioBitRate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} audioBitRate New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setAudioBitRate = function(audioBitRate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.deliveryType> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getDeliveryType = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.deliveryType> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} deliveryType New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setDeliveryType = function(deliveryType) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.languages> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getLanguages = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.languages> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} languages New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setLanguages = function(languages) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.rights> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getRights = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.rights> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} rights New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setRights = function(rights) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.publishers> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPublishers = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.publishers> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} publishers New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPublishers = function(publishers) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contributors> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContributors = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contributors> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} contributors New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContributors = function(contributors) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.coverage> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getCoverage = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.coverage> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} coverage New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setCoverage = function(coverage) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.rating> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getRating = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.rating> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} rating New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setRating = function(rating) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.ratingDescription> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getRatingDescription = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.ratingDescription> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} ratingDescription New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setRatingDescription = function(ratingDescription) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.playCount> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPlayCount = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.playCount> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} playCount New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPlayCount = function(playCount) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.information> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getInformation = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.information> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} information New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setInformation = function(information) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.director> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getDirector = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.director> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} director New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setDirector = function(director) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.producer> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getProducer = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.producer> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} producer New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setProducer = function(producer) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.genre> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getGenre = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.genre> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} genre New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setGenre = function(genre) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.performers> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPerformers = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.performers> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} performers New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPerformers = function(performers) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.originalFormat> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getOriginalFormat = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.originalFormat> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} originalFormat New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setOriginalFormat = function(originalFormat) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.originalSource> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getOriginalSource = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.originalSource> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} originalSource New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setOriginalSource = function(originalSource) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.local> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getLocal = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.local> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} local New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setLocal = function(local) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentRating> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getContentRating = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.contentRating> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} contentRating New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setContentRating = function(contentRating) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.url> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getUrl = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.url> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} url New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setUrl = function(url) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.fullyFormattedAddress> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getFullyFormattedAddress = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.fullyFormattedAddress> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {String} fullyFormattedAddress New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setFullyFormattedAddress = function(fullyFormattedAddress) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.subThoroughfare> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getSubThoroughfare = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.subThoroughfare> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {String} subThoroughfare New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setSubThoroughfare = function(subThoroughfare) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.thoroughfare> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getThoroughfare = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.thoroughfare> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {String} thoroughfare New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setThoroughfare = function(thoroughfare) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.postalCode> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.getPostalCode = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.SearchableItemAttributeSet.postalCode> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {String} postalCode New value for the property. | |
*/ | |
Titanium.App.iOS.SearchableItemAttributeSet.prototype.setPostalCode = function(postalCode) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* itemContentType: String, | |
* displayName: String, | |
* alternateNames: Array<String>, | |
* path: String, | |
* contentURL: String, | |
* thumbnailURL: String, | |
* thumbnailData: (String|Titanium.Blob), | |
* relatedUniqueIdentifier: String, | |
* metadataModificationDate: String, | |
* contentType: String, | |
* contentTypeTree: Array<String>, | |
* keywords: Array<String>, | |
* title: String, | |
* subject: String, | |
* theme: String, | |
* contentDescription: String, | |
* identifier: String, | |
* audiences: Array<String>, | |
* fileSize: Number, | |
* pageCount: Number, | |
* pageWidth: Number, | |
* pageHeight: Number, | |
* securityMethod: String, | |
* creator: String, | |
* encodingApplications: Array<String>, | |
* kind: String, | |
* fontNames: Array<String>, | |
* audioSampleRate: Number, | |
* audioChannelCount: Number, | |
* tempo: Number, | |
* keySignature: String, | |
* timeSignature: String, | |
* audioEncodingApplication: String, | |
* composer: String, | |
* lyricist: String, | |
* album: String, | |
* artist: String, | |
* audioTrackNumber: Number, | |
* recordingDate: String, | |
* musicalGenre: String, | |
* generalMIDISequence: Number, | |
* musicalInstrumentCategory: String, | |
* musicalInstrumentName: String, | |
* supportsPhoneCall: Number, | |
* supportsNavigation: Number, | |
* containerTitle: String, | |
* containerDisplayName: String, | |
* containerIdentifier: String, | |
* containerOrder: Number, | |
* editors: Array<String>, | |
* participants: Array<String>, | |
* projects: Array<String>, | |
* downloadedDate: String, | |
* lastUsedDate: String, | |
* contentCreationDate: String, | |
* contentModificationDate: String, | |
* addedDate: String, | |
* contentSources: Array<String>, | |
* comment: String, | |
* copyright: String, | |
* duration: Number, | |
* contactKeywords: Array<String>, | |
* codecs: Array<String>, | |
* organizations: Array<String>, | |
* mediaTypes: Array<String>, | |
* version: String, | |
* role: String, | |
* streamable: Number, | |
* totalBitRate: Number, | |
* videoBitRate: Number, | |
* audioBitRate: Number, | |
* deliveryType: Number, | |
* languages: Array<String>, | |
* rights: Array<String>, | |
* publishers: Array<String>, | |
* contributors: Array<String>, | |
* coverage: Array<String>, | |
* rating: Number, | |
* ratingDescription: String, | |
* playCount: Number, | |
* information: String, | |
* director: String, | |
* producer: String, | |
* genre: String, | |
* performers: Array<String>, | |
* originalFormat: String, | |
* originalSource: String, | |
* local: Number, | |
* contentRating: Number, | |
* url: String, | |
* fullyFormattedAddress: String, | |
* subThoroughfare: String, | |
* thoroughfare: String, | |
* postalCode: String | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_SearchableItemAttributeSet; | |
/** | |
* The UserActivity module is used to enable device Handoff and to create User Activities. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description A UserActivity object requires the `activityType` property to be specified at creation time. | |
* Additional properties can be set either at creation or set individually after creation. | |
* | |
* Handoff will not work in the simulator. You must build and run on a compatible device. | |
* | |
* Handoff functionality depends on a few things: | |
* | |
* * You must be logged into the same iCloud account on each device you wish to use Handoff. | |
* * Handoff broadcasts activities via Bluetooth LE signals, so both the broadcasting and receiving devices must have Bluetooth LE 4.0 support. | |
* * Connect all devices to the same Wi-Fi network. | |
* | |
* Make sure you have two devices that are logged onto the same iCloud account. | |
* | |
* Since iOS 12, you can also configure the UserActivity API for handling Siri Shortcuts. See the | |
* below API's and example or refer to the [Apple Siri Shortcuts Docs](https://developer.apple.com/documentation/sirikit/donating_shortcuts?language=objc) | |
* for details. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserActivity = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.apiName; | |
/** | |
* Name of the activity type. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} activityType | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.activityType; | |
/** | |
* Set to `true` if the user activity can be publicly accessed by all iOS users. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} eligibleForPublicIndexing | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.eligibleForPublicIndexing; | |
/** | |
* Set to true if the user activity should be added to the on-device index. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} eligibleForSearch | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.eligibleForSearch; | |
/** | |
* Set to true if this user activity should be eligible to be handed off to another device | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} eligibleForHandoff | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.eligibleForHandoff; | |
/** | |
* A Boolean value that determines whether Siri can suggest the user activity as a shortcut to the user. | |
* | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @type {Boolean} eligibleForPrediction | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.eligibleForPrediction; | |
/** | |
* A value used to identify the user activity. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @type {String} persistentIdentifier | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.persistentIdentifier; | |
/** | |
* Absolute date after which the activity is no longer eligible to be indexed or handed off. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} expirationDate | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.expirationDate; | |
/** | |
* An array of string keywords representing words or phrases that might help the user to find the activity in the application history. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} keywords | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.keywords; | |
/** | |
* Set to true everytime you have updated the user activity and need the changes to be saved before handing it off to another device. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} needsSave | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.needsSave; | |
/** | |
* An array of String keys from the userInfo property which represent the minimal information about the user activity that should be stored for later restoration. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Array<String>} requiredUserInfoKeys | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.requiredUserInfoKeys; | |
/** | |
* Determines if user activities are supported (`true`) or not (`false`) by the device. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Boolean} supported | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.supported; | |
/** | |
* An optional, user-visible title for this activity such as a document name or web page title. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} title | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.title; | |
/** | |
* The userInfo dictionary contains application-specific state needed to continue an activity on another device. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {Dictionary} userInfo | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.userInfo; | |
/** | |
* When no suitable application is installed on a resuming device and the `webpageURL` property is set, | |
* the user activity will instead be continued in a web browser by loading the specified URL. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @type {String} webpageURL | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.webpageURL; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.applyProperties = function(props) {}; | |
/** | |
* Adds a Titanium.App.iOS.SearchableItemAttributeSet to the user activity. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Titanium.App.iOS.SearchableItemAttributeSet} contentAttributeSet SearchableItemAttributeSet object that contains the set of properties you want to display for a searchable activity. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.addContentAttributeSet = function(contentAttributeSet) {}; | |
/** | |
* Marks the activity as currently in use by the user. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.becomeCurrent = function() {}; | |
/** | |
* Invalidates an activity when it is no longer eligible for continuation. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.invalidate = function() {}; | |
/** | |
* Marks the activity as currently **not** in use and ineligible to be continued. | |
* | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.resignCurrent = function() {}; | |
/** | |
* Determines if user activities are supported (`true`) or not (`false`) by the device. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.isSupported = function() {}; | |
/** | |
* Deletes user activities created by your app that have the specified persistent identifiers. | |
* | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @param {Array<String>} persistentIdentifiers Array of persistent identifiers of user activity. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.deleteSavedUserActivitiesForPersistentIdentifiers = function(persistentIdentifiers) {}; | |
/** | |
* Deletes all user activities created by your app. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.deleteAllSavedUserActivities = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.bubbleParent> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.apiName> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.activityType> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getActivityType = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.activityType> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} activityType New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setActivityType = function(activityType) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.eligibleForPublicIndexing> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getEligibleForPublicIndexing = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.eligibleForPublicIndexing> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} eligibleForPublicIndexing New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setEligibleForPublicIndexing = function(eligibleForPublicIndexing) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.eligibleForSearch> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getEligibleForSearch = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.eligibleForSearch> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} eligibleForSearch New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setEligibleForSearch = function(eligibleForSearch) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.eligibleForHandoff> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getEligibleForHandoff = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.eligibleForHandoff> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} eligibleForHandoff New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setEligibleForHandoff = function(eligibleForHandoff) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.eligibleForPrediction> property. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getEligibleForPrediction = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.eligibleForPrediction> property. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @param {Boolean} eligibleForPrediction New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setEligibleForPrediction = function(eligibleForPrediction) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.persistentIdentifier> property. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getPersistentIdentifier = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.persistentIdentifier> property. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @param {String} persistentIdentifier New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setPersistentIdentifier = function(persistentIdentifier) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.expirationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getExpirationDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.expirationDate> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} expirationDate New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setExpirationDate = function(expirationDate) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.keywords> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getKeywords = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.keywords> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} keywords New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setKeywords = function(keywords) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.needsSave> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getNeedsSave = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.needsSave> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} needsSave New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setNeedsSave = function(needsSave) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.requiredUserInfoKeys> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Array<String>} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getRequiredUserInfoKeys = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.requiredUserInfoKeys> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Array<String>} requiredUserInfoKeys New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setRequiredUserInfoKeys = function(requiredUserInfoKeys) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.supported> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getSupported = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.supported> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Boolean} supported New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setSupported = function(supported) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.title> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.title> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} title New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setTitle = function(title) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.userInfo> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {Dictionary} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getUserInfo = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.userInfo> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Dictionary} userInfo New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setUserInfo = function(userInfo) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserActivity.webpageURL> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.getWebpageURL = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserActivity.webpageURL> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} webpageURL New value for the property. | |
*/ | |
Titanium.App.iOS.UserActivity.prototype.setWebpageURL = function(webpageURL) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* activityType: String, | |
* eligibleForPublicIndexing: Boolean, | |
* eligibleForSearch: Boolean, | |
* eligibleForHandoff: Boolean, | |
* eligibleForPrediction: Boolean, | |
* persistentIdentifier: String, | |
* expirationDate: String, | |
* keywords: Array<String>, | |
* needsSave: Boolean, | |
* requiredUserInfoKeys: Array<String>, | |
* supported: Boolean, | |
* title: String, | |
* userInfo: Dictionary, | |
* webpageURL: String | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_UserActivity; | |
/** | |
* The UserDefaults module is used for storing application-related data in property/value pairs | |
* that persist beyond application sessions and device power cycles. UserDefaults allows the suiteName | |
* of the UserDefaults to be specified at creation time. | |
* | |
* @extends {Titanium.App.Properties} | |
* @description Unlike Titanium.App.Properties, Titanium.App.iOS.UserDefaults does not pull properties defined in the `tiapp.xml` file. | |
* | |
* To create a UserDefaults object, use the <Titanium.App.iOS.createUserDefaults> method. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserDefaults = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.UserDefaults.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.UserDefaults.prototype.apiName; | |
/** | |
* Sets the name of the suite to be used to access UserDefaults. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @type {String} suiteName | |
*/ | |
Titanium.App.iOS.UserDefaults.prototype.suiteName; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.UserDefaults.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.UserDefaults.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.UserDefaults.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.UserDefaults.applyProperties = function(props) {}; | |
/** | |
* Returns the value of a property as a boolean data type. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Boolean=} default_ Default value to return if property does not exist. | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserDefaults.getBool = function(property, default_) {}; | |
/** | |
* Returns the value of a property as a double (double-precision, floating point) data type. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number=} default_ Default value to return if property does not exist. | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.UserDefaults.getDouble = function(property, default_) {}; | |
/** | |
* Returns the value of a property as an integer data type. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number=} default_ Default value to return if property does not exist. | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.UserDefaults.getInt = function(property, default_) {}; | |
/** | |
* Returns the value of a property as an array data type. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Array<Object>=} default_ Default value to return if property does not exist. | |
* @return {Array<Object>} | |
*/ | |
Titanium.App.iOS.UserDefaults.getList = function(property, default_) {}; | |
/** | |
* Returns the value of a property as an object. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Object=} default_ Default value to return if property does not exist. | |
* @return {Object} | |
*/ | |
Titanium.App.iOS.UserDefaults.getObject = function(property, default_) {}; | |
/** | |
* Returns the value of a property as a string data type. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {String=} default_ Default value to return if property does not exist. | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserDefaults.getString = function(property, default_) {}; | |
/** | |
* Indicates whether a property exists. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserDefaults.hasProperty = function(property) {}; | |
/** | |
* Returns an array of property names. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @return {Array<Object>} | |
*/ | |
Titanium.App.iOS.UserDefaults.listProperties = function() {}; | |
/** | |
* Removes a property if it exists, or does nothing otherwise. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
*/ | |
Titanium.App.iOS.UserDefaults.removeProperty = function(property) {}; | |
/** | |
* Removes all properties that have been set by the user on runtime, or does nothing otherwise. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserDefaults.removeAllProperties = function() {}; | |
/** | |
* Sets the value of a property as a boolean data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Boolean} value Property value. | |
*/ | |
Titanium.App.iOS.UserDefaults.setBool = function(property, value) {}; | |
/** | |
* Sets the value of a property as a double (double-precision, floating point) data type. The | |
* property will be created if it does not exist. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number} value Property value. | |
*/ | |
Titanium.App.iOS.UserDefaults.setDouble = function(property, value) {}; | |
/** | |
* Sets the value of a property as an integer data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Number} value Property value, within the range `-2,147,483,648` to `2,147,483,647`. | |
*/ | |
Titanium.App.iOS.UserDefaults.setInt = function(property, value) {}; | |
/** | |
* Sets the value of a property as an array data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Array<Object>} value Property value. | |
*/ | |
Titanium.App.iOS.UserDefaults.setList = function(property, value) {}; | |
/** | |
* Sets the value of a property as an object data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {Object} value Property value. | |
*/ | |
Titanium.App.iOS.UserDefaults.setObject = function(property, value) {}; | |
/** | |
* Sets the value of a property as a string data type. The property will be created if it | |
* does not exist. | |
* | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} property Name of property. | |
* @param {String} value Property value. | |
*/ | |
Titanium.App.iOS.UserDefaults.setString = function(property, value) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserDefaults.bubbleParent> property. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserDefaults.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserDefaults.bubbleParent> property. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.UserDefaults.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserDefaults.apiName> property. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserDefaults.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserDefaults.suiteName> property. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserDefaults.getSuiteName = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserDefaults.suiteName> property. | |
* @since 4.0.0 (iPhone), 4.0.0 (iPad) | |
* @param {String} suiteName New value for the property. | |
*/ | |
Titanium.App.iOS.UserDefaults.setSuiteName = function(suiteName) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* suiteName: String | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_UserDefaults; | |
/** | |
* An action the user selects in response to an interactive notification. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description To create a notification action, use the <Titanium.App.iOS.createUserNotificationAction> method. | |
* | |
* An notification action represents an option a user selects in response to an interactive | |
* notification. The notification action is represented as a button in the application UI. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserNotificationAction = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.apiName; | |
/** | |
* Selects how to activate the application. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Number} activationMode | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.activationMode; | |
/** | |
* Custom behavior the user notification supports. | |
* @since 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @type {Number} behavior | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.behavior; | |
/** | |
* Set to true if the action requires the device to be unlocked. On the Apple Watch actions never require authentication. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Boolean} authenticationRequired | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.authenticationRequired; | |
/** | |
* Set to true if the action causes destructive behavior to the user's data or the application. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Boolean} destructive | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.destructive; | |
/** | |
* Identifier for this action. Used to identify the action the user pressed. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {String} identifier | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.identifier; | |
/** | |
* Title of the button displayed in the notification. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {String} title | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.title; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationAction.bubbleParent> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserNotificationAction.bubbleParent> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationAction.apiName> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationAction.activationMode> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.getActivationMode = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserNotificationAction.activationMode> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {Number} activationMode New value for the property. | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.setActivationMode = function(activationMode) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationAction.behavior> property. | |
* @since 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.getBehavior = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserNotificationAction.behavior> property. | |
* @since 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @param {Number} behavior New value for the property. | |
*/ | |
Titanium.App.iOS.UserNotificationAction.prototype.setBehavior = function(behavior) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* activationMode: Number, | |
* behavior: Number, | |
* authenticationRequired: Boolean, | |
* destructive: Boolean, | |
* identifier: String, | |
* title: String | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_UserNotificationAction; | |
/** | |
* A set of notification actions to associate with a notification. | |
* @constructor | |
* @extends {Titanium.Proxy} | |
* @description To create a notification category, use the <Titanium.App.iOS.createUserNotificationCategory> method. | |
* | |
* A notification category represents a collection of <Titanium.App.iOS.UserNotificationAction> | |
* to associate with a specific notification. The notification category allows the application to | |
* customize the notification options based on which notification style is used. For alert dialogs, | |
* only four notification actions can be displayed, while all other notifications can only display two | |
* actions. | |
* | |
* To use a local interactive notification, you need to register the notification category using | |
* the <Titanium.App.iOS.registerUserNotificationSettings> method and send a notification using the | |
* <Titanium.App.iOS.scheduleLocalNotification> and pass the category identifier to the `category` | |
* property. | |
* | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserNotificationCategory = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.apiName; | |
/** | |
* Array of notification actions to associate with the group. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Array<Titanium.App.iOS.UserNotificationAction>} actionsForDefaultContext | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.actionsForDefaultContext; | |
/** | |
* Array of notification actions to display for non-dialog-style notification. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Array<Titanium.App.iOS.UserNotificationAction>} actionsForMinimalContext | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.actionsForMinimalContext; | |
/** | |
* A format string for the summary description used when the system groups the category's notifications. | |
* @since 7.4.0 (iPhone), 7.4.0 (iPad) | |
* @type {String} categorySummaryFormat | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.categorySummaryFormat; | |
/** | |
* Identifier for this category. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {String} identifier | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.identifier; | |
/** | |
* The intents related to notifications of this category. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Array<String>} intentIdentifiers | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.intentIdentifiers; | |
/** | |
* The placeholder text to display when notification previews are disabled for the app. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {String} hiddenPreviewsBodyPlaceholder | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.hiddenPreviewsBodyPlaceholder; | |
/** | |
* Options for how to handle notifications of this type. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @type {Array<Number>} options | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.options; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationCategory.bubbleParent> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserNotificationCategory.bubbleParent> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationCategory.apiName> property. | |
* @since 3.4.0 (iPhone), 3.4.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserNotificationCategory.prototype.getApiName = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* actionsForDefaultContext: Array<Titanium.App.iOS.UserNotificationAction>, | |
* actionsForMinimalContext: Array<Titanium.App.iOS.UserNotificationAction>, | |
* categorySummaryFormat: String, | |
* identifier: String, | |
* intentIdentifiers: Array<String>, | |
* hiddenPreviewsBodyPlaceholder: String, | |
* options: Array<Number> | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_UserNotificationCategory; | |
/** | |
* The top-level App iOS Notification Center module. It is used to control scheduled notifications | |
* and receive details about the system-wide notification settings. | |
* | |
* @extends {Titanium.Module} | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
*/ | |
Titanium.App.iOS.UserNotificationCenter = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.prototype.apiName; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.applyProperties = function(props) {}; | |
/** | |
* Fetches the pending notifications asynchronously. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {Callback<UserNotificationCallbackResponse>} callback The function that is being called after the notifications | |
* have been fetched. | |
* | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.getPendingNotifications = function(callback) {}; | |
/** | |
* Fetches the delivered notifications asynchronously. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {Callback<UserNotificationCallbackResponse>} callback The function that is being called after the notifications | |
* have been fetched. | |
* | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.getDeliveredNotifications = function(callback) {}; | |
/** | |
* Removes the specified pending notifications to prevent them from being triggered. | |
* If no notifications are specified, all pending notifications will be removed. | |
* | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {Array<UserNotificationDictionary>} notifications The pending notification to remove. If none specified, all pending notifications | |
* will be removed. | |
* | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.removePendingNotifications = function(notifications) {}; | |
/** | |
* Removes the specified delivered notifications from the notification-center. | |
* If no notifications are specified, all delivered notifications will be removed. | |
* | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {Array<UserNotificationDictionary>} notifications The delivered notification to remove. If none specified, all pending notifications | |
* will be removed. | |
* | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.removeDeliveredNotifications = function(notifications) {}; | |
/** | |
* Notification types and user notification categories the application is registered to use. | |
* | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {Callback<GetUserNotificationSettings>} callback The callback invoked when requesting user notification settings. | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.requestUserNotificationSettings = function(callback) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationCenter.bubbleParent> property. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.App.iOS.UserNotificationCenter.bubbleParent> property. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.App.iOS.UserNotificationCenter.apiName> property. | |
* @since 7.3.0 (iPhone), 7.3.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.App.iOS.UserNotificationCenter.getApiName = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean | |
* }} | |
*/ | |
Titanium.App.iOS._Dictionary_UserNotificationCenter; | |
/** | |
* A container for binary data. | |
* @extends {Titanium.Proxy} | |
* @description A `Blob` represents a chunk of binary information, often obtained through | |
* an [HTTPClient](Titanium.Network.HTTPClient) or by reading a [File](Titanium.Filesystem.File). | |
* | |
* Blobs are often used to store text or image data. | |
* The `Blob` object includes a number of properties and methods specific to image blobs. | |
* | |
* Android supports an [append](Titanium.Blob.append) method, but | |
* otherwise blobs are immutable. | |
* | |
* The <Titanium.Utils> module provides several utility methods for working with | |
* blobs, including methods for converting between blobs and Base64-encoded strings, | |
* and methods for generating SHA-1 and SHA-256 hashes and MD5 digests from blob data. | |
* | |
* The [Buffer](Titanium.Buffer) object can also contain binary data, and is | |
* more easily mutable. Extracting blob data to a buffer is somewhat roundabout: | |
* | |
* var blobStream = Ti.Stream.createStream({ source: myBlob, mode: Ti.Stream.MODE_READ }); | |
* var newBuffer = Ti.createBuffer({ length: myBlob.length }); | |
* var bytes = blobStream.read(newBuffer); | |
* | |
* Creating a blob from a buffer is much easier: | |
* | |
* var newBlob = myBuffer.toBlob(); | |
* | |
* In both cases, the conversion involves copying the data from one object to another, so | |
* you should be conscious of the amount of the data being copied. | |
* | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
*/ | |
Titanium.Blob = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Blob.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Blob.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Blob.prototype.lifecycleContainer; | |
/** | |
* File object represented by this blob, or `null` if this blob is not | |
* associated with a file. | |
* | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {Titanium.Filesystem.File} file | |
*/ | |
Titanium.Blob.prototype.file; | |
/** | |
* Length of this blob in bytes. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {Number} length | |
*/ | |
Titanium.Blob.prototype.length; | |
/** | |
* UTF-8 string representation of the data in this blob. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {String} text | |
*/ | |
Titanium.Blob.prototype.text; | |
/** | |
* Mime type of the data in this blob. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {String} mimeType | |
*/ | |
Titanium.Blob.prototype.mimeType; | |
/** | |
* If this blob represents an image, this is the height of the image in pixels. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {Number} height | |
*/ | |
Titanium.Blob.prototype.height; | |
/** | |
* If this blob represents an image, this is the width of the image in pixels. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {Number} width | |
*/ | |
Titanium.Blob.prototype.width; | |
/** | |
* If this blob represents a [File](Titanium.Filesystem.File), this is the file URL | |
* that represents it. | |
* | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {String} nativePath | |
*/ | |
Titanium.Blob.prototype.nativePath; | |
/** | |
* Size of the blob in pixels (for image blobs) or bytes (for all other blobs). | |
* | |
* @since 7.2.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @readonly | |
* @type {Number} size | |
*/ | |
Titanium.Blob.prototype.size; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Blob.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Blob.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Blob.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Blob.applyProperties = function(props) {}; | |
/** | |
* Returns a string representation of this blob. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Blob.toString = function() {}; | |
/** | |
* Appends the data from another blob to this blob. | |
* @since 0.9 (Android) | |
* @param {Titanium.Blob} blob Blob to append to this blob. | |
*/ | |
Titanium.Blob.append = function(blob) {}; | |
/** | |
* Creates a new blob by cropping the underlying image to the specified dimensions. | |
* @since 3.0.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {Dictionary<ImageAsCroppedDict>} options Image cropping options. | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Blob.imageAsCropped = function(options) {}; | |
/** | |
* Creates a new blob by resizing and scaling the underlying image to the specified dimensions. | |
* @since 3.0.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {Number} width Width to resize this image to. | |
* @param {Number} height Height to resize this image to. | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Blob.imageAsResized = function(width, height) {}; | |
/** | |
* Creates a new blob by compressing the underlying image to the specified quality. | |
* @since 6.1.0 (Android), 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @param {Number} quality Quality to compress this image to. From 0.0 (lowest quality) to 1.0 (highest quality). | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Blob.imageAsCompressed = function(quality) {}; | |
/** | |
* Returns a thumbnail version of the underlying image, optionally with a border and rounded corners. | |
* @since 3.0.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {Number} size Size of the thumbnail, in either width or height. | |
* @param {Number=} borderSize Width of the thumbnail's border. | |
* @param {Number=} cornerRadius Radius of the thumbnail's corners. | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Blob.imageAsThumbnail = function(size, borderSize, cornerRadius) {}; | |
/** | |
* Returns a copy of the underlying image with an added alpha channel. | |
* @since 3.0.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Blob.imageWithAlpha = function() {}; | |
/** | |
* Returns a copy of the underlying image with rounded corners added. | |
* @since 3.0.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {Number} cornerSize Size of the rounded corners in pixels. | |
* @param {Number=} borderSize Width of the border in pixels. | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Blob.imageWithRoundedCorner = function(cornerSize, borderSize) {}; | |
/** | |
* Returns a copy of the underlying image with an added transparent border. | |
* @since 3.0.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @param {Number} size Width of the transparent border in pixels. | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Blob.imageWithTransparentBorder = function(size) {}; | |
/** | |
* Gets the value of the <Titanium.Blob.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Blob.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Blob.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Blob.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Blob.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Blob.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Blob.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Blob.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Blob.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Blob.file> property. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {Titanium.Filesystem.File} | |
*/ | |
Titanium.Blob.getFile = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.length> property. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Blob.getLength = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.text> property. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Blob.getText = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.mimeType> property. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Blob.getMimeType = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.height> property. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Blob.getHeight = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.width> property. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Blob.getWidth = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.nativePath> property. | |
* @since 0.9 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Blob.getNativePath = function() {}; | |
/** | |
* Gets the value of the <Titanium.Blob.size> property. | |
* @since 7.2.0 (Android), 0.9 (iPhone), 0.9 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Blob.getSize = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_Blob; | |
/** | |
* Wrapper around <Titanium.Blob> that implements the <Titanium.IOStream> interface. | |
* @extends {Titanium.IOStream} | |
* @description Use the <Titanium.Stream.createStream> method to create a `BlobStream` instance from a | |
* `Blob`. | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.BlobStream = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.BlobStream.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.BlobStream.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.BlobStream.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.BlobStream.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.BlobStream.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.BlobStream.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.BlobStream.applyProperties = function(props) {}; | |
/** | |
* Reads data from this stream into a buffer. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Titanium.Buffer} buffer Buffer to read stream data into. | |
* @param {Number=} offset Offset into the buffer to start writing stream data. | |
* If specified, `length` must also be specified. | |
* | |
* @param {Number=} length Maximum number of bytes to read. | |
* If specified, `offset` must also be specified. | |
* | |
* @param {Callback<ReadCallbackArgs>=} resultsCallback Function to call with the results of the read operation. | |
* @return {Number} | |
*/ | |
Titanium.BlobStream.read = function(buffer, offset, length, resultsCallback) {}; | |
/** | |
* Writes data from a buffer to this stream. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Titanium.Buffer} buffer Buffer to write to this stream. | |
* @param {Number=} offset Offset in the buffer of the first byte to write to the stream. | |
* If specified, `length` must also be specified. | |
* | |
* @param {Number=} length Maximum number of bytes to write to the stream. | |
* If specified, `offset` must also be specified. | |
* | |
* @param {Callback<WriteCallbackArgs>=} resultsCallback Function to call with the results of the write operation. | |
* @return {Number} | |
*/ | |
Titanium.BlobStream.write = function(buffer, offset, length, resultsCallback) {}; | |
/** | |
* Indicates whether this stream is writable. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.BlobStream.isWritable = function() {}; | |
/** | |
* Indicates whether this stream is readable. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.BlobStream.isReadable = function() {}; | |
/** | |
* Closes this stream. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.BlobStream.close = function() {}; | |
/** | |
* Gets the value of the <Titanium.BlobStream.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.BlobStream.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.BlobStream.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.BlobStream.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.BlobStream.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.BlobStream.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.BlobStream.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.BlobStream.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.BlobStream.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.BlobStream.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_BlobStream; | |
/** | |
* Buffer is a mutable, resizable container for raw data. | |
* @extends {Titanium.Proxy} | |
* @description A `Buffer` works like a resizable array of byte values. | |
* | |
* Use the <Titanium.createBuffer> method to create a buffer. | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.Buffer = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Buffer.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Buffer.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Buffer.prototype.lifecycleContainer; | |
/** | |
* Length of the buffer in bytes. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @type {Number} length | |
*/ | |
Titanium.Buffer.prototype.length; | |
/** | |
* Data to be encoded. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @type {Number|String} value | |
*/ | |
Titanium.Buffer.prototype.value; | |
/** | |
* The type of data encoding to use with `value`. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @type {String} type | |
*/ | |
Titanium.Buffer.prototype.type; | |
/** | |
* Byte order of this buffer. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @type {Number} byteOrder | |
*/ | |
Titanium.Buffer.prototype.byteOrder; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Buffer.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Buffer.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Buffer.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Buffer.applyProperties = function(props) {}; | |
/** | |
* Appends `sourceBuffer` to the this buffer. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Titanium.Buffer} sourceBuffer Buffer to append to this buffer. | |
* @param {Number=} sourceOffset Offset to start reading buffer data from. | |
* If specified, `sourceLength` must also be specified. | |
* | |
* @param {Number=} sourceLength Number of bytes to read from `sourceBuffer`. | |
* If specified, `sourceOffset` must also be specified. | |
* | |
* @return {Number} | |
*/ | |
Titanium.Buffer.append = function(sourceBuffer, sourceOffset, sourceLength) {}; | |
/** | |
* Inserts data from `sourceBuffer` into this buffer at `offset`. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Titanium.Buffer} sourceBuffer Buffer holding data to insert into this buffer. | |
* @param {Number} offset Offset in this buffer to insert the first byte copied from | |
* `sourceBuffer`. | |
* | |
* @param {Number=} sourceOffset Offset in `sourceBuffer` of the first byte to insert. | |
* If specified, `sourceLength` must be specified as well. | |
* | |
* @param {Number=} sourceLength Number of bytes to insert from `sourceBuffer`. | |
* If specified, `sourceOffset` must be specified as well. | |
* | |
* @return {Number} | |
*/ | |
Titanium.Buffer.insert = function(sourceBuffer, offset, sourceOffset, sourceLength) {}; | |
/** | |
* Copies data from `sourceBuffer` into the current buffer at `offset`. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Titanium.Buffer} sourceBuffer Buffer to copy data from. | |
* @param {Number} offset Offset in this buffer for the first byte of the copied data. | |
* @param {Number=} sourceOffset Offset in `sourceBuffer` to copy data from. | |
* If specified, `sourceLength` must be specified as well. | |
* | |
* @param {Number=} sourceLength Number of bytes to copy from `sourceBuffer`. | |
* If specified, `sourceOffset` must be specified as well. | |
* | |
* @return {Number} | |
*/ | |
Titanium.Buffer.copy = function(sourceBuffer, offset, sourceOffset, sourceLength) {}; | |
/** | |
* Creates a complete or partial copy of this buffer. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Number=} offset Offset of first byte of this buffer to clone. | |
* If specified, `length` must be specified as well. | |
* | |
* @param {Number=} length Number of bytes of data to clone. | |
* @return {Titanium.Buffer} | |
*/ | |
Titanium.Buffer.clone = function(offset, length) {}; | |
/** | |
* Fills this buffer with the specified byte value. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Number} fillByte Byte to fill buffer with. | |
* @param {Number=} offset Offset of the first byte to set to `fillByte`. | |
* @param {Number=} length Number of bytes to fill. | |
*/ | |
Titanium.Buffer.fill = function(fillByte, offset, length) {}; | |
/** | |
* Clears this buffer's contents but does not change the size of the buffer. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.Buffer.clear = function() {}; | |
/** | |
* Releases the space allocated to the buffer, and sets its length to 0. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.Buffer.release = function() {}; | |
/** | |
* Converts this buffer to a String. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Buffer.toString = function() {}; | |
/** | |
* Converts this buffer to a <Titanium.Blob>. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Buffer.toBlob = function() {}; | |
/** | |
* Gets the value of the <Titanium.Buffer.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Buffer.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Buffer.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Buffer.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Buffer.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Buffer.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Buffer.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Buffer.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Buffer.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Buffer.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Buffer.length> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Buffer.getLength = function() {}; | |
/** | |
* Sets the value of the <Titanium.Buffer.length> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Number} length New value for the property. | |
*/ | |
Titanium.Buffer.setLength = function(length) {}; | |
/** | |
* Gets the value of the <Titanium.Buffer.value> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Number|String} | |
*/ | |
Titanium.Buffer.getValue = function() {}; | |
/** | |
* Sets the value of the <Titanium.Buffer.value> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Number|String} value New value for the property. | |
*/ | |
Titanium.Buffer.setValue = function(value) {}; | |
/** | |
* Gets the value of the <Titanium.Buffer.type> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Buffer.getType = function() {}; | |
/** | |
* Sets the value of the <Titanium.Buffer.type> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} type New value for the property. | |
*/ | |
Titanium.Buffer.setType = function(type) {}; | |
/** | |
* Gets the value of the <Titanium.Buffer.byteOrder> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Buffer.getByteOrder = function() {}; | |
/** | |
* Sets the value of the <Titanium.Buffer.byteOrder> property. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Number} byteOrder New value for the property. | |
*/ | |
Titanium.Buffer.setByteOrder = function(byteOrder) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* length: Number, | |
* value: (Number|String), | |
* type: String, | |
* byteOrder: Number | |
* }} | |
*/ | |
Titanium._Dictionary_Buffer; | |
/** | |
* Wrapper around <Titanium.Buffer> that implements the <Titanium.IOStream> interface. | |
* | |
* @extends {Titanium.IOStream} | |
* @description Use the <Titanium.Stream.createStream> method to create a `BufferStream` instance from a | |
* `Buffer`. | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.BufferStream = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.BufferStream.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.BufferStream.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.BufferStream.prototype.lifecycleContainer; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.BufferStream.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.BufferStream.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.BufferStream.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.BufferStream.applyProperties = function(props) {}; | |
/** | |
* Reads data from this stream into a buffer. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Titanium.Buffer} buffer Buffer to read stream data into. | |
* @param {Number=} offset Offset into the buffer to start writing stream data. | |
* If specified, `length` must also be specified. | |
* | |
* @param {Number=} length Maximum number of bytes to read. | |
* If specified, `offset` must also be specified. | |
* | |
* @param {Callback<ReadCallbackArgs>=} resultsCallback Function to call with the results of the read operation. | |
* @return {Number} | |
*/ | |
Titanium.BufferStream.read = function(buffer, offset, length, resultsCallback) {}; | |
/** | |
* Writes data from a buffer to this stream. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Titanium.Buffer} buffer Buffer to write to this stream. | |
* @param {Number=} offset Offset in the buffer of the first byte to write to the stream. | |
* If specified, `length` must also be specified. | |
* | |
* @param {Number=} length Maximum number of bytes to write to the stream. | |
* If specified, `offset` must also be specified. | |
* | |
* @param {Callback<WriteCallbackArgs>=} resultsCallback Function to call with the results of the write operation. | |
* @return {Number} | |
*/ | |
Titanium.BufferStream.write = function(buffer, offset, length, resultsCallback) {}; | |
/** | |
* Indicates whether this stream is writable. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.BufferStream.isWritable = function() {}; | |
/** | |
* Indicates whether this stream is readable. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.BufferStream.isReadable = function() {}; | |
/** | |
* Closes this stream. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.BufferStream.close = function() {}; | |
/** | |
* Gets the value of the <Titanium.BufferStream.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.BufferStream.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.BufferStream.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.BufferStream.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.BufferStream.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.BufferStream.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.BufferStream.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.BufferStream.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.BufferStream.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.BufferStream.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_BufferStream; | |
/** | |
* The Calendar module provides an API for accessing the native calendar functionality. | |
* | |
* @extends {Titanium.Module} | |
* @description This module supports retrieving information about existing events and creating new events. | |
* Modifying or deleting existing events and creating recurring events are only supported on iOS. | |
* | |
* Currently, on Android, calendar permissions must be explicitly configured in `tiapp.xml` in order to access the | |
* calendar. See "Common Requirements" in | |
* [tiapp.xml and timodule.xml Reference](https://docs.appcelerator.com/platform/latest/#!/guide/tiapp.xml_and_timodule.xml_Reference). | |
* | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
*/ | |
Titanium.Calendar = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Calendar.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Calendar.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Calendar.prototype.lifecycleContainer; | |
/** | |
* Reminder alert delivery method. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} METHOD_ALERT | |
*/ | |
Titanium.Calendar.METHOD_ALERT; | |
/** | |
* Reminder default delivery method. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} METHOD_DEFAULT | |
*/ | |
Titanium.Calendar.METHOD_DEFAULT; | |
/** | |
* Reminder email delivery method. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} METHOD_EMAIL | |
*/ | |
Titanium.Calendar.METHOD_EMAIL; | |
/** | |
* Reminder SMS delivery method. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} METHOD_SMS | |
*/ | |
Titanium.Calendar.METHOD_SMS; | |
/** | |
* Alert dismissed state. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} STATE_DISMISSED | |
*/ | |
Titanium.Calendar.STATE_DISMISSED; | |
/** | |
* Alert fired state. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} STATE_FIRED | |
*/ | |
Titanium.Calendar.STATE_FIRED; | |
/** | |
* Alert scheduled status. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} STATE_SCHEDULED | |
*/ | |
Titanium.Calendar.STATE_SCHEDULED; | |
/** | |
* Event has no status. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} STATUS_NONE | |
*/ | |
Titanium.Calendar.STATUS_NONE; | |
/** | |
* Event canceled status. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} STATUS_CANCELLED | |
*/ | |
Titanium.Calendar.STATUS_CANCELLED; | |
/** | |
* Event canceled status. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} STATUS_CANCELED | |
*/ | |
Titanium.Calendar.STATUS_CANCELED; | |
/** | |
* Event confirmed status. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} STATUS_CONFIRMED | |
*/ | |
Titanium.Calendar.STATUS_CONFIRMED; | |
/** | |
* Event tentative status. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} STATUS_TENTATIVE | |
*/ | |
Titanium.Calendar.STATUS_TENTATIVE; | |
/** | |
* Availability settings are not supported by the event's calendar. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AVAILABILITY_NOTSUPPORTED | |
*/ | |
Titanium.Calendar.AVAILABILITY_NOTSUPPORTED; | |
/** | |
* Event has a busy availability setting. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AVAILABILITY_BUSY | |
*/ | |
Titanium.Calendar.AVAILABILITY_BUSY; | |
/** | |
* Event has a free availability setting. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AVAILABILITY_FREE | |
*/ | |
Titanium.Calendar.AVAILABILITY_FREE; | |
/** | |
* Event has a tentative availability setting. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AVAILABILITY_TENTATIVE | |
*/ | |
Titanium.Calendar.AVAILABILITY_TENTATIVE; | |
/** | |
* Event has a tentative availability setting. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AVAILABILITY_UNAVAILABLE | |
*/ | |
Titanium.Calendar.AVAILABILITY_UNAVAILABLE; | |
/** | |
* An [eventsAuthorization](Titanium.Calendar.eventsAuthorization) value | |
* indicating that the application is authorized to use events in the Calendar. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_AUTHORIZED | |
*/ | |
Titanium.Calendar.AUTHORIZATION_AUTHORIZED; | |
/** | |
* An [eventsAuthorization](Titanium.Calendar.eventsAuthorization) value | |
* indicating that the application is not authorized to use events in the Calendar. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_DENIED | |
*/ | |
Titanium.Calendar.AUTHORIZATION_DENIED; | |
/** | |
* An [eventsAuthorization](Titanium.Calendar.eventsAuthorization) value | |
* indicating that the application is not authorized to use events in the Calendar. | |
* the user cannot change this application's status. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_RESTRICTED | |
*/ | |
Titanium.Calendar.AUTHORIZATION_RESTRICTED; | |
/** | |
* An [eventsAuthorization](Titanium.Calendar.eventsAuthorization) value | |
* indicating that the authorization state is unknown. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_UNKNOWN | |
*/ | |
Titanium.Calendar.AUTHORIZATION_UNKNOWN; | |
/** | |
* A [save](Titanium.Calendar.Event.save)/[remove](Titanium.Calendar.Event.remove) event value, | |
* indicating modifications to this event instance should affect only this instance. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} SPAN_THISEVENT | |
*/ | |
Titanium.Calendar.SPAN_THISEVENT; | |
/** | |
* A [save](Titanium.Calendar.Event.save)/[remove](Titanium.Calendar.Event.remove) event value, | |
* indicating modifications to this event instance should also affect future instances of this event. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} SPAN_FUTUREEVENTS | |
*/ | |
Titanium.Calendar.SPAN_FUTUREEVENTS; | |
/** | |
* Indicates a daily recurrence rule for a events reccurance frequency. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} RECURRENCEFREQUENCY_DAILY | |
*/ | |
Titanium.Calendar.RECURRENCEFREQUENCY_DAILY; | |
/** | |
* Indicates a weekly recurrence rule for a events reccurance frequency. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} RECURRENCEFREQUENCY_WEEKLY | |
*/ | |
Titanium.Calendar.RECURRENCEFREQUENCY_WEEKLY; | |
/** | |
* Indicates a monthly recurrence rule for a events reccurance frequency. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} RECURRENCEFREQUENCY_MONTHLY | |
*/ | |
Titanium.Calendar.RECURRENCEFREQUENCY_MONTHLY; | |
/** | |
* Indicates a yearly recurrence rule for a events reccurance frequency. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} RECURRENCEFREQUENCY_YEARLY | |
*/ | |
Titanium.Calendar.RECURRENCEFREQUENCY_YEARLY; | |
/** | |
* Event confidential visibility. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_CONFIDENTIAL | |
*/ | |
Titanium.Calendar.VISIBILITY_CONFIDENTIAL; | |
/** | |
* Event default visibility. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_DEFAULT | |
*/ | |
Titanium.Calendar.VISIBILITY_DEFAULT; | |
/** | |
* Event private visibility. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_PRIVATE | |
*/ | |
Titanium.Calendar.VISIBILITY_PRIVATE; | |
/** | |
* Event public visibility. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} VISIBILITY_PUBLIC | |
*/ | |
Titanium.Calendar.VISIBILITY_PUBLIC; | |
/** | |
* Attendee status is unknown. | |
* @since 6.2.0 (Android), 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_UNKNOWN | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_UNKNOWN; | |
/** | |
* Attendee status is pending. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_PENDING | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_PENDING; | |
/** | |
* Attendee status is accepted. | |
* @since 6.2.0 (Android), 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_ACCEPTED | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_ACCEPTED; | |
/** | |
* Attendee status is declined. | |
* @since 6.2.0 (Android), 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_DECLINED | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_DECLINED; | |
/** | |
* Attendee status is tentative. | |
* @since 6.2.0 (Android), 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_TENTATIVE | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_TENTATIVE; | |
/** | |
* Attendee status is invited. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_INVITED | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_INVITED; | |
/** | |
* There is no Attendee status. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_NONE | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_NONE; | |
/** | |
* Attendee status is delegated. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_DELEGATED | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_DELEGATED; | |
/** | |
* Attendee status is in process. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_STATUS_IN_PROCESS | |
*/ | |
Titanium.Calendar.ATTENDEE_STATUS_IN_PROCESS; | |
/** | |
* Relationship is attendee. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} RELATIONSHIP_ATTENDEE | |
*/ | |
Titanium.Calendar.RELATIONSHIP_ATTENDEE; | |
/** | |
* There is no relationship. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} RELATIONSHIP_NONE | |
*/ | |
Titanium.Calendar.RELATIONSHIP_NONE; | |
/** | |
* Attendee is organizer. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} RELATIONSHIP_ORGANIZER | |
*/ | |
Titanium.Calendar.RELATIONSHIP_ORGANIZER; | |
/** | |
* Attendee is performer. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} RELATIONSHIP_PERFORMER | |
*/ | |
Titanium.Calendar.RELATIONSHIP_PERFORMER; | |
/** | |
* Attendee is speaker. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} RELATIONSHIP_SPEAKER | |
*/ | |
Titanium.Calendar.RELATIONSHIP_SPEAKER; | |
/** | |
* Relationship is unknown. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} RELATIONSHIP_UNKNOWN | |
*/ | |
Titanium.Calendar.RELATIONSHIP_UNKNOWN; | |
/** | |
* Attendee role is unknown. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_ROLE_UNKNOWN | |
*/ | |
Titanium.Calendar.ATTENDEE_ROLE_UNKNOWN; | |
/** | |
* Attendee role is optional. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_ROLE_OPTIONAL | |
*/ | |
Titanium.Calendar.ATTENDEE_ROLE_OPTIONAL; | |
/** | |
* Attendee role is required. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_ROLE_REQUIRED | |
*/ | |
Titanium.Calendar.ATTENDEE_ROLE_REQUIRED; | |
/** | |
* Attendee role is chair. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_ROLE_CHAIR | |
*/ | |
Titanium.Calendar.ATTENDEE_ROLE_CHAIR; | |
/** | |
* Attendee is not a participant. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_ROLE_NON_PARTICIPANT | |
*/ | |
Titanium.Calendar.ATTENDEE_ROLE_NON_PARTICIPANT; | |
/** | |
* Attendee type is unknown. | |
* @since 6.2.0 (Android), 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_TYPE_UNKNOWN | |
*/ | |
Titanium.Calendar.ATTENDEE_TYPE_UNKNOWN; | |
/** | |
* Attendee type is person. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_TYPE_PERSON | |
*/ | |
Titanium.Calendar.ATTENDEE_TYPE_PERSON; | |
/** | |
* Attendee type is room. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_TYPE_ROOM | |
*/ | |
Titanium.Calendar.ATTENDEE_TYPE_ROOM; | |
/** | |
* Attendee type is resource. | |
* @since 6.2.0 (Android), 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_TYPE_RESOURCE | |
*/ | |
Titanium.Calendar.ATTENDEE_TYPE_RESOURCE; | |
/** | |
* There is not attendee type. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} ATTENDEE_TYPE_NONE | |
*/ | |
Titanium.Calendar.ATTENDEE_TYPE_NONE; | |
/** | |
* Attendee type is required. | |
* @since 6.2.0 (Android) | |
* @readonly | |
* @type {Number} ATTENDEE_TYPE_REQUIRED | |
*/ | |
Titanium.Calendar.ATTENDEE_TYPE_REQUIRED; | |
/** | |
* Attendee type is group. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} ATTENDEE_TYPE_GROUP | |
*/ | |
Titanium.Calendar.ATTENDEE_TYPE_GROUP; | |
/** | |
* A local calendar source. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {Number} SOURCE_TYPE_LOCAL | |
*/ | |
Titanium.Calendar.SOURCE_TYPE_LOCAL; | |
/** | |
* A microsoft exchange calendar source. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {Number} SOURCE_TYPE_EXCHANGE | |
*/ | |
Titanium.Calendar.SOURCE_TYPE_EXCHANGE; | |
/** | |
* A calDev calendar source. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {Number} SOURCE_TYPE_CALDAV | |
*/ | |
Titanium.Calendar.SOURCE_TYPE_CALDAV; | |
/** | |
* A mobileMe calendar source. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {Number} SOURCE_TYPE_MOBILEME | |
*/ | |
Titanium.Calendar.SOURCE_TYPE_MOBILEME; | |
/** | |
* A subscribed calendar source. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {Number} SOURCE_TYPE_SUBSCRIBED | |
*/ | |
Titanium.Calendar.SOURCE_TYPE_SUBSCRIBED; | |
/** | |
* A birthday calendar source. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {Number} SOURCE_TYPE_BIRTHDAYS | |
*/ | |
Titanium.Calendar.SOURCE_TYPE_BIRTHDAYS; | |
/** | |
* Returns an authorization constant indicating if the application has access to the events in the EventKit. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} eventsAuthorization | |
*/ | |
Titanium.Calendar.prototype.eventsAuthorization; | |
/** | |
* Returns an authorization constant indicating if the application has access to the events in the EventKit. | |
* @since 5.2.0 (iPhone), 5.2.0 (iPad) | |
* @readonly | |
* @type {Number} calendarAuthorization | |
*/ | |
Titanium.Calendar.prototype.calendarAuthorization; | |
/** | |
* All alerts in selected calendars. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Array<Titanium.Calendar.Alert>} allAlerts | |
*/ | |
Titanium.Calendar.prototype.allAlerts; | |
/** | |
* All calendars known to the native calendar app. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<Titanium.Calendar.Calendar>} allCalendars | |
*/ | |
Titanium.Calendar.prototype.allCalendars; | |
/** | |
* All calendars known to the native calendar app that can add, edit, and | |
* delete items in the calendar. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<Titanium.Calendar.Calendar>} allEditableCalendars | |
*/ | |
Titanium.Calendar.prototype.allEditableCalendars; | |
/** | |
* All calendars selected within the native calendar app, which may be a subset of `allCalendars`. | |
* | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Array<Titanium.Calendar.Calendar>} selectableCalendars | |
*/ | |
Titanium.Calendar.prototype.selectableCalendars; | |
/** | |
* Calendar that events are added to by default, as specified by user settings. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Titanium.Calendar.Calendar} defaultCalendar | |
*/ | |
Titanium.Calendar.prototype.defaultCalendar; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Calendar.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Calendar.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Calendar.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Calendar.applyProperties = function(props) {}; | |
/** | |
* Gets the calendar with the specified identifier. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} id Identifier of the calendar. | |
* @return {Titanium.Calendar.Calendar} | |
*/ | |
Titanium.Calendar.getCalendarById = function(id) {}; | |
/** | |
* Returns `true` if the app has calendar access. | |
* @since 5.1.0 (Android), 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.hasCalendarPermissions = function() {}; | |
/** | |
* Requests for calendar access. | |
* @since 5.1.0 (Android), 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @param {Callback<EventsAuthorizationResponse>} callback Function to call upon user decision to grant calendar access. | |
*/ | |
Titanium.Calendar.requestCalendarPermissions = function(callback) {}; | |
/** | |
* If authorization is unknown, the system will bring up a dialog requesting permission. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Callback<EventsAuthorizationResponse>} callback Callback function to execute when when authorization is no longer unknown. | |
*/ | |
Titanium.Calendar.requestEventsAuthorization = function(callback) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Calendar.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Calendar.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Calendar.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.eventsAuthorization> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.getEventsAuthorization = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.calendarAuthorization> property. | |
* @since 5.2.0 (iPhone), 5.2.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.getCalendarAuthorization = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.allAlerts> property. | |
* @since 3.2.0 (Android) | |
* @return {Array<Titanium.Calendar.Alert>} | |
*/ | |
Titanium.Calendar.getAllAlerts = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.allCalendars> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Titanium.Calendar.Calendar>} | |
*/ | |
Titanium.Calendar.getAllCalendars = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.allEditableCalendars> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Titanium.Calendar.Calendar>} | |
*/ | |
Titanium.Calendar.getAllEditableCalendars = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.selectableCalendars> property. | |
* @since 3.2.0 (Android) | |
* @return {Array<Titanium.Calendar.Calendar>} | |
*/ | |
Titanium.Calendar.getSelectableCalendars = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.defaultCalendar> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Titanium.Calendar.Calendar} | |
*/ | |
Titanium.Calendar.getDefaultCalendar = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_Calendar; | |
/** | |
* An object that represents a single alert for an event in an calendar. | |
* @extends {Titanium.Proxy} | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
*/ | |
Titanium.Calendar.Alert = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Calendar.Alert.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Calendar.Alert.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Calendar.Alert.prototype.lifecycleContainer; | |
/** | |
* The absolute date for the alarm. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Date} absoluteDate | |
*/ | |
Titanium.Calendar.Alert.prototype.absoluteDate; | |
/** | |
* The offset from the start of an event, at which the alarm fires. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Number} relativeOffset | |
*/ | |
Titanium.Calendar.Alert.prototype.relativeOffset; | |
/** | |
* Date/time at which this alert alarm is set to trigger. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Date} alarmTime | |
*/ | |
Titanium.Calendar.Alert.prototype.alarmTime; | |
/** | |
* Start date/time for the corresponding event. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Date} begin | |
*/ | |
Titanium.Calendar.Alert.prototype.begin; | |
/** | |
* End date/time for the corresponding event. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Date} end | |
*/ | |
Titanium.Calendar.Alert.prototype.end; | |
/** | |
* Identifier of the event for which this alert is set. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} eventId | |
*/ | |
Titanium.Calendar.Alert.prototype.eventId; | |
/** | |
* Identifier of this alert. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Calendar.Alert.prototype.id; | |
/** | |
* Reminder notice period in minutes, that determines how long prior to the event this alert | |
* should trigger. | |
* | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} minutes | |
*/ | |
Titanium.Calendar.Alert.prototype.minutes; | |
/** | |
* The current state of the alert. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} state | |
*/ | |
Titanium.Calendar.Alert.prototype.state; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Calendar.Alert.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Calendar.Alert.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Calendar.Alert.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Calendar.Alert.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Alert.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Alert.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Calendar.Alert.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Alert.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Calendar.Alert.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Alert.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Calendar.Alert.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.absoluteDate> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Date} | |
*/ | |
Titanium.Calendar.Alert.getAbsoluteDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Alert.absoluteDate> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Date} absoluteDate New value for the property. | |
*/ | |
Titanium.Calendar.Alert.setAbsoluteDate = function(absoluteDate) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.relativeOffset> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Alert.getRelativeOffset = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Alert.relativeOffset> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Number} relativeOffset New value for the property. | |
*/ | |
Titanium.Calendar.Alert.setRelativeOffset = function(relativeOffset) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.alarmTime> property. | |
* @since 3.2.0 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Calendar.Alert.getAlarmTime = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.begin> property. | |
* @since 3.2.0 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Calendar.Alert.getBegin = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.end> property. | |
* @since 3.2.0 (Android) | |
* @return {Date} | |
*/ | |
Titanium.Calendar.Alert.getEnd = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.eventId> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Alert.getEventId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.id> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Alert.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.minutes> property. | |
* @since 3.2.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Alert.getMinutes = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Alert.state> property. | |
* @since 3.2.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Alert.getState = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* absoluteDate: Date, | |
* relativeOffset: Number | |
* }} | |
*/ | |
Titanium.Calendar._Dictionary_Alert; | |
/** | |
* An object that represents a single attendee of an event. | |
* @extends {Titanium.Proxy} | |
* @description The API supports retrieving information about the attendee of an event. | |
* | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
*/ | |
Titanium.Calendar.Attendee = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Calendar.Attendee.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Calendar.Attendee.prototype.apiName; | |
/** | |
* Indicates whether this attendee is the event organizer. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Boolean} isOrganizer | |
*/ | |
Titanium.Calendar.Attendee.prototype.isOrganizer; | |
/** | |
* The attendee name. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {String} name | |
*/ | |
Titanium.Calendar.Attendee.prototype.name; | |
/** | |
* The attendee email. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {String} email | |
*/ | |
Titanium.Calendar.Attendee.prototype.email; | |
/** | |
* The role of the attendee. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} role | |
*/ | |
Titanium.Calendar.Attendee.prototype.role; | |
/** | |
* The type of the attendee. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} type | |
*/ | |
Titanium.Calendar.Attendee.prototype.type; | |
/** | |
* The status of the attendee. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Number} status | |
*/ | |
Titanium.Calendar.Attendee.prototype.status; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Calendar.Attendee.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Calendar.Attendee.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Calendar.Attendee.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Calendar.Attendee.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.bubbleParent> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Attendee.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Attendee.bubbleParent> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Calendar.Attendee.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.apiName> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Attendee.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.isOrganizer> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Attendee.getIsOrganizer = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.name> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Attendee.getName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.email> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Attendee.getEmail = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.role> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Attendee.getRole = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.type> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Attendee.getType = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Attendee.status> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Attendee.getStatus = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean | |
* }} | |
*/ | |
Titanium.Calendar._Dictionary_Attendee; | |
/** | |
* An object that represents a single calendar. | |
* @extends {Titanium.Proxy} | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
*/ | |
Titanium.Calendar.Calendar = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Calendar.Calendar.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Calendar.Calendar.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Calendar.Calendar.prototype.lifecycleContainer; | |
/** | |
* Indicates whether this calendar can be edited or deleted. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Boolean} hidden | |
*/ | |
Titanium.Calendar.Calendar.prototype.hidden; | |
/** | |
* Identifier of this calendar. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Calendar.Calendar.prototype.id; | |
/** | |
* Display name of this calendar. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {String} name | |
*/ | |
Titanium.Calendar.Calendar.prototype.name; | |
/** | |
* Indicates whether the calendar is selected. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Boolean} selected | |
*/ | |
Titanium.Calendar.Calendar.prototype.selected; | |
/** | |
* Displays the source title. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {String} sourceTitle | |
*/ | |
Titanium.Calendar.Calendar.prototype.sourceTitle; | |
/** | |
* Displays the source type. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {Number} sourceType | |
*/ | |
Titanium.Calendar.Calendar.prototype.sourceType; | |
/** | |
* Displays the source identifier. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @readonly | |
* @type {String} sourceIdentifier | |
*/ | |
Titanium.Calendar.Calendar.prototype.sourceIdentifier; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Calendar.Calendar.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Calendar.Calendar.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Calendar.Calendar.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Calendar.Calendar.applyProperties = function(props) {}; | |
/** | |
* Creates an event in this calendar. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Titanium.Calendar._Dictionary_Event} properties Properties of the event | |
* @return {Titanium.Calendar.Event} | |
*/ | |
Titanium.Calendar.Calendar.createEvent = function(properties) {}; | |
/** | |
* Gets the event with the specified identifier. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} id Identifier of the event. | |
* @return {Titanium.Calendar.Event} | |
*/ | |
Titanium.Calendar.Calendar.getEventById = function(id) {}; | |
/** | |
* Gets events that occur between two dates. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Date|String} date1 Start date. | |
* @param {Date|String} date2 End date. | |
* @return {Array<Titanium.Calendar.Event>} | |
*/ | |
Titanium.Calendar.Calendar.getEventsBetweenDates = function(date1, date2) {}; | |
/** | |
* Gets events that occur on a specified date. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Number} year Year of the events. | |
* @param {Number} month Month of the events, as a zero-based integer with January at 0 and December at 11. | |
* @param {Number} day Day of the month of the events. | |
* @return {Array<Titanium.Calendar.Event>} | |
*/ | |
Titanium.Calendar.Calendar.getEventsInDate = function(year, month, day) {}; | |
/** | |
* Gets events that occur during a specified month. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Number} year Year of the events. | |
* @param {Number} month Month of the events, as a zero-based integer with January at 0 and December at 11. | |
* @return {Array<Titanium.Calendar.Event>} | |
*/ | |
Titanium.Calendar.Calendar.getEventsInMonth = function(year, month) {}; | |
/** | |
* Gets all events that occur during a specified year. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Number} year Year of the events. | |
* @return {Array<Titanium.Calendar.Event>} | |
*/ | |
Titanium.Calendar.Calendar.getEventsInYear = function(year) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Calendar.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Calendar.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Calendar.Calendar.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Calendar.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Calendar.Calendar.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Calendar.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Calendar.Calendar.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.hidden> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Calendar.getHidden = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.id> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Calendar.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.name> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Calendar.getName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.selected> property. | |
* @since 3.2.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Calendar.getSelected = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.sourceTitle> property. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Calendar.getSourceTitle = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.sourceType> property. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Calendar.getSourceType = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Calendar.sourceIdentifier> property. | |
* @since 6.1.0 (iPhone), 6.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Calendar.getSourceIdentifier = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Calendar._Dictionary_Calendar; | |
/** | |
* An object that represents a single event in a calendar. | |
* @extends {Titanium.Proxy} | |
* @description The API supports retrieving information about existing events and creating new events. | |
* On iOS, existing events can be modified or deleted. On Android, only recurrence rules | |
* can be modified. | |
* | |
* See <Titanium.Calendar> for examples of retrieving event information and creating events. | |
* | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
*/ | |
Titanium.Calendar.Event = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Calendar.Event.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Calendar.Event.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Calendar.Event.prototype.lifecycleContainer; | |
/** | |
* Alarms associated with the calendar item, as an array of <Titanium.Calendar.Alert> objects. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Array<Titanium.Calendar.Alert>} alerts | |
*/ | |
Titanium.Calendar.Event.prototype.alerts; | |
/** | |
* Indicates whether this event is all day. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Boolean} allDay | |
*/ | |
Titanium.Calendar.Event.prototype.allDay; | |
/** | |
* Start date/time of this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Date} begin | |
*/ | |
Titanium.Calendar.Event.prototype.begin; | |
/** | |
* Notes for this event. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {String} notes | |
*/ | |
Titanium.Calendar.Event.prototype.notes; | |
/** | |
* Description of this event. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} description | |
*/ | |
Titanium.Calendar.Event.prototype.description; | |
/** | |
* End date/time of this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Date} end | |
*/ | |
Titanium.Calendar.Event.prototype.end; | |
/** | |
* Extended properties of this event. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Dictionary} extendedProperties | |
*/ | |
Titanium.Calendar.Event.prototype.extendedProperties; | |
/** | |
* Indicates whether an alarm is scheduled for this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Boolean} hasAlarm | |
*/ | |
Titanium.Calendar.Event.prototype.hasAlarm; | |
/** | |
* Identifier of this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Calendar.Event.prototype.id; | |
/** | |
* Location of this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {String} location | |
*/ | |
Titanium.Calendar.Event.prototype.location; | |
/** | |
* Existing reminders for this event. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Array<Titanium.Calendar.Reminder>} reminders | |
*/ | |
Titanium.Calendar.Event.prototype.reminders; | |
/** | |
* Status of this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} status | |
*/ | |
Titanium.Calendar.Event.prototype.status; | |
/** | |
* Availability of this event. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Number} availability | |
*/ | |
Titanium.Calendar.Event.prototype.availability; | |
/** | |
* Boolean value that indicates whether an event is a detached instance of a | |
* repeating event. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Boolean} isDetached | |
*/ | |
Titanium.Calendar.Event.prototype.isDetached; | |
/** | |
* Title of this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {String} title | |
*/ | |
Titanium.Calendar.Event.prototype.title; | |
/** | |
* The recurrence rules for the calendar item. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Array<Titanium.Calendar.RecurrenceRule>} recurrenceRules | |
*/ | |
Titanium.Calendar.Event.prototype.recurrenceRules; | |
/** | |
* Visibility of this event. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} visibility | |
*/ | |
Titanium.Calendar.Event.prototype.visibility; | |
/** | |
* The list of event attendees. This list will be empty if the event has no attendees. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @readonly | |
* @type {Array<Titanium.Calendar.Attendee>} attendees | |
*/ | |
Titanium.Calendar.Event.prototype.attendees; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Calendar.Event.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Calendar.Event.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Calendar.Event.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Calendar.Event.applyProperties = function(props) {}; | |
/** | |
* Creates an alert for this event. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Titanium.Calendar._Dictionary_Alert} data Properties for the alert. | |
* @return {Titanium.Calendar.Alert} | |
*/ | |
Titanium.Calendar.Event.createAlert = function(data) {}; | |
/** | |
* Creates a reminder for this event. | |
* @since 3.2.0 (Android) | |
* @param {Titanium.Calendar._Dictionary_Reminder} data Properties for the reminder. | |
* @return {Titanium.Calendar.Reminder} | |
*/ | |
Titanium.Calendar.Event.createReminder = function(data) {}; | |
/** | |
* Gets the value of the specified extended property. | |
* @since 3.2.0 (Android) | |
* @param {String} name Name of an existing extended property. | |
* @return {String} | |
*/ | |
Titanium.Calendar.Event.getExtendedProperty = function(name) {}; | |
/** | |
* Sets the value of the specified extended property. | |
* @since 3.2.0 (Android) | |
* @param {String} name Property name. | |
* @param {String} value Property value. | |
*/ | |
Titanium.Calendar.Event.setExtendedProperty = function(name, value) {}; | |
/** | |
* Creates an recurrence pattern for a recurring event. | |
* All of the properties for the recurrence rule must be set during creation. | |
* The recurrence rule properties cannot be modified. | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Titanium.Calendar._Dictionary_RecurrenceRule} data Properties for the recurrence rule. | |
* @return {Titanium.Calendar.RecurrenceRule} | |
*/ | |
Titanium.Calendar.Event.createRecurrenceRule = function(data) {}; | |
/** | |
* Saves changes to an event permanently. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Number} span The span to use. Indicates whether the save affects future instances of the | |
* event in the case of a recurring event. | |
* | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Event.save = function(span) {}; | |
/** | |
* Removes an event from the event store. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Number} span The span to use. Indicates whether to remove future instances of the event in | |
* the case of a recurring event. | |
* | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Event.remove = function(span) {}; | |
/** | |
* Updates the event's data with the current information in the Calendar database. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Event.refresh = function() {}; | |
/** | |
* Adds a recurrence rule to the recurrence rule array. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Titanium.Calendar.RecurrenceRule} rule The recurrence rule to be added. | |
*/ | |
Titanium.Calendar.Event.addRecurrenceRule = function(rule) {}; | |
/** | |
* Removes a recurrence rule to the recurrence rule array. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Titanium.Calendar.RecurrenceRule} rule The recurrence rule to be removed. | |
*/ | |
Titanium.Calendar.Event.removeRecurrenceRule = function(rule) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Event.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.bubbleParent> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Calendar.Event.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Event.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Calendar.Event.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Calendar.Event.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.alerts> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Titanium.Calendar.Alert>} | |
*/ | |
Titanium.Calendar.Event.getAlerts = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.alerts> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Array<Titanium.Calendar.Alert>} alerts New value for the property. | |
*/ | |
Titanium.Calendar.Event.setAlerts = function(alerts) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.allDay> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Event.getAllDay = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.allDay> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Boolean} allDay New value for the property. | |
*/ | |
Titanium.Calendar.Event.setAllDay = function(allDay) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.begin> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Date} | |
*/ | |
Titanium.Calendar.Event.getBegin = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.begin> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Date} begin New value for the property. | |
*/ | |
Titanium.Calendar.Event.setBegin = function(begin) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.notes> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Event.getNotes = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.notes> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} notes New value for the property. | |
*/ | |
Titanium.Calendar.Event.setNotes = function(notes) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.description> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Event.getDescription = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.end> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Date} | |
*/ | |
Titanium.Calendar.Event.getEnd = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.end> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Date} end New value for the property. | |
*/ | |
Titanium.Calendar.Event.setEnd = function(end) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.extendedProperties> property. | |
* @since 3.2.0 (Android) | |
* @return {Dictionary} | |
*/ | |
Titanium.Calendar.Event.getExtendedProperties = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.hasAlarm> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Event.getHasAlarm = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.id> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Event.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.location> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Event.getLocation = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.location> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} location New value for the property. | |
*/ | |
Titanium.Calendar.Event.setLocation = function(location) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.reminders> property. | |
* @since 3.2.0 (Android) | |
* @return {Array<Titanium.Calendar.Reminder>} | |
*/ | |
Titanium.Calendar.Event.getReminders = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.status> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Event.getStatus = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.availability> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Event.getAvailability = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.availability> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Number} availability New value for the property. | |
*/ | |
Titanium.Calendar.Event.setAvailability = function(availability) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.isDetached> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Event.getIsDetached = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.title> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Event.getTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.title> property. | |
* @since 3.2.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} title New value for the property. | |
*/ | |
Titanium.Calendar.Event.setTitle = function(title) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.recurrenceRules> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Titanium.Calendar.RecurrenceRule>} | |
*/ | |
Titanium.Calendar.Event.getRecurrenceRules = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Event.recurrenceRules> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Array<Titanium.Calendar.RecurrenceRule>} recurrenceRules New value for the property. | |
*/ | |
Titanium.Calendar.Event.setRecurrenceRules = function(recurrenceRules) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.visibility> property. | |
* @since 3.2.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Event.getVisibility = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Event.attendees> property. | |
* @since 6.0.0 (iPhone), 6.0.0 (iPad) | |
* @return {Array<Titanium.Calendar.Attendee>} | |
*/ | |
Titanium.Calendar.Event.getAttendees = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* alerts: Array<Titanium.Calendar.Alert>, | |
* allDay: Boolean, | |
* begin: Date, | |
* notes: String, | |
* end: Date, | |
* location: String, | |
* availability: Number, | |
* title: String, | |
* recurrenceRules: Array<Titanium.Calendar.RecurrenceRule> | |
* }} | |
*/ | |
Titanium.Calendar._Dictionary_Event; | |
/** | |
* An object that is used to describe the recurrence pattern for a recurring event. | |
* @extends {Titanium.Proxy} | |
* @description On Android there is no option to have multiple recurrence rules set for the same event. | |
* Android always uses only the first element in the array passed to [recurrenceRules](Titanium.Calendar.Event.recurrenceRules). | |
* | |
* In case of having [daysOfTheWeek](Titanium.Calendar.RecurrenceRule.daysOfTheWeek) and [daysOfTheMonth](Titanium.Calendar.RecurrenceRule.daysOfTheWeek) | |
* for an event with a recurrence rule of type [RECURRENCEFREQUENCY_MONTHLY](Titanium.Calendar.RECURRENCEFREQUENCY_MONTHLY) only | |
* [daysOfTheWeek] will be used. | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
*/ | |
Titanium.Calendar.RecurrenceRule = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 7.1.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 7.1.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.lifecycleContainer; | |
/** | |
* Identifier for the recurrence rule's calendar. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {String} calendarID | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.calendarID; | |
/** | |
* Frequency of the recurrence rule. | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} frequency | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.frequency; | |
/** | |
* The interval between instances of this recurrence. For example, a weekly | |
* recurrence rule with an interval of 2 occurs every other week. Must be greater than 0. | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Number} interval | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.interval; | |
/** | |
* The days of the week that the event occurs, as an array of objects `daysOfWeek` and `Week`. | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<daysOfTheWeekDictionary>} daysOfTheWeek | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.daysOfTheWeek; | |
/** | |
* The days of the month that the event occurs, as an array of number objects. | |
* Values can be from 1 to 31 and from -1 to -31. This parameter is only valid for | |
* recurrence rules of type | |
* [RECURRENCEFREQUENCY_MONTHLY](Titanium.Calendar.RECURRENCEFREQUENCY_MONTHLY). | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<Number>} daysOfTheMonth | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.daysOfTheMonth; | |
/** | |
* The months of the year that the event occurs, as an array of Number objects. | |
* Values can be from 1 to 12. This parameter is only valid for recurrence rules of | |
* type [RECURRENCEFREQUENCY_YEARLY](Titanium.Calendar.RECURRENCEFREQUENCY_YEARLY). | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<Number>} monthsOfTheYear | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.monthsOfTheYear; | |
/** | |
* The weeks of the year that the event occurs, as an array of number objects. | |
* Values can be from 1 to 53 and from -1 to -53. This parameter is only valid for | |
* recurrence rules of type [RECURRENCEFREQUENCY_YEARLY](Titanium.Calendar.RECURRENCEFREQUENCY_YEARLY). | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<Number>} weeksOfTheYear | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.weeksOfTheYear; | |
/** | |
* The days of the year that the event occurs, as an array of number objects. | |
* Values can be from 1 to 366 and from -1 to -366. This parameter is only valid for | |
* recurrence rules of type [RECURRENCEFREQUENCY_YEARLY](Titanium.Calendar.RECURRENCEFREQUENCY_YEARLY). | |
* | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<Number>} daysOfTheYear | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.daysOfTheYear; | |
/** | |
* An array of ordinal numbers that filters which recurrences to include in the | |
* recurrence rule's frequency. For example, a yearly recurrence rule that has a | |
* [daysOfTheWeek](Titanium.Calendar.RecurrenceRule.daysOfTheWeek) value that specifies | |
* Monday through Friday, and a `setPositions` array containing 2 and -1, occurs only | |
* on the second weekday and last weekday of every year. | |
* | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {Array<Number>} setPositions | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.setPositions; | |
/** | |
* End of a recurrence rule. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @readonly | |
* @type {recurrenceEndDictionary} end | |
*/ | |
Titanium.Calendar.RecurrenceRule.prototype.end; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Calendar.RecurrenceRule.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Calendar.RecurrenceRule.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Calendar.RecurrenceRule.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Calendar.RecurrenceRule.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.bubbleParent> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.RecurrenceRule.bubbleParent> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Calendar.RecurrenceRule.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.apiName> property. | |
* @since 7.1.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.lifecycleContainer> property. | |
* @since 7.1.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.RecurrenceRule.lifecycleContainer> property. | |
* @since 7.1.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Calendar.RecurrenceRule.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.calendarID> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getCalendarID = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.frequency> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getFrequency = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.interval> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getInterval = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.daysOfTheWeek> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<daysOfTheWeekDictionary>} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getDaysOfTheWeek = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.daysOfTheMonth> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Number>} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getDaysOfTheMonth = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.monthsOfTheYear> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Number>} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getMonthsOfTheYear = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.weeksOfTheYear> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Number>} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getWeeksOfTheYear = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.daysOfTheYear> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Number>} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getDaysOfTheYear = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.setPositions> property. | |
* @since 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {Array<Number>} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getSetPositions = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.RecurrenceRule.end> property. | |
* @since 7.1.0 (Android), 3.1.0 (iPhone), 3.1.0 (iPad) | |
* @return {recurrenceEndDictionary} | |
*/ | |
Titanium.Calendar.RecurrenceRule.getEnd = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Calendar._Dictionary_RecurrenceRule; | |
/** | |
* An object that represents a single reminder for an event in a calendar. | |
* @extends {Titanium.Proxy} | |
* @description Reminders should be created using the <Titanium.Calendar.Event.createReminder> method | |
* rather than directly. | |
* | |
* See <Titanium.Calendar> for examples of retrieving reminder information and creating | |
* reminders for events. | |
* | |
* @since 3.2.0 (Android) | |
*/ | |
Titanium.Calendar.Reminder = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.2.0 (Android) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Calendar.Reminder.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Calendar.Reminder.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Calendar.Reminder.prototype.lifecycleContainer; | |
/** | |
* Identifier of this reminder. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {String} id | |
*/ | |
Titanium.Calendar.Reminder.prototype.id; | |
/** | |
* Method by which this reminder will be delivered. | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} method | |
*/ | |
Titanium.Calendar.Reminder.prototype.method; | |
/** | |
* Reminder notice period in minutes, that determines how long prior to the event this reminder | |
* should trigger. | |
* | |
* @since 3.2.0 (Android) | |
* @readonly | |
* @type {Number} minutes | |
*/ | |
Titanium.Calendar.Reminder.prototype.minutes; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Calendar.Reminder.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 3.2.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Calendar.Reminder.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 3.2.0 (Android) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Calendar.Reminder.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.2.0 (Android) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Calendar.Reminder.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Reminder.bubbleParent> property. | |
* @since 3.2.0 (Android) | |
* @return {Boolean} | |
*/ | |
Titanium.Calendar.Reminder.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Reminder.bubbleParent> property. | |
* @since 3.2.0 (Android) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Calendar.Reminder.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Reminder.apiName> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Reminder.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Reminder.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Calendar.Reminder.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Calendar.Reminder.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Calendar.Reminder.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Reminder.id> property. | |
* @since 3.2.0 (Android) | |
* @return {String} | |
*/ | |
Titanium.Calendar.Reminder.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Reminder.method> property. | |
* @since 3.2.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Reminder.getMethod = function() {}; | |
/** | |
* Gets the value of the <Titanium.Calendar.Reminder.minutes> property. | |
* @since 3.2.0 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Calendar.Reminder.getMinutes = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium.Calendar._Dictionary_Reminder; | |
/** | |
* A module for translating between primitive types and raw byte streams. | |
* | |
* @extends {Titanium.Module} | |
* @description The `Codec` module can be used for encoding strings and numbers into [Buffer](Titanium.Buffer) | |
* objects, and decoding primitive types from buffers. | |
* | |
* #### Byte Order | |
* | |
* Multi-byte data can be stored in two different byte orders: big-endian or | |
* little-endian. In big-endian byte order, the most significant or highest-value | |
* byte is stored first. For example, the 4-byte integer 0xFEDCBA98 is made up of the | |
* bytes 0xFE, 0xDC, 0xBA and 0x98, from most-significant to least-significant. | |
* | |
* If we represent a buffer as an array of byte values, a big-endian encoding of | |
* 0xFEDCBA98 would look like this: | |
* | |
* [ 0xFE, 0xDC, 0xBA, 0x98 ] | |
* | |
* In little-endian order, the bytes would be stored in this order: | |
* | |
* [ 0x98, 0xBA, 0xDC, 0xFE ] | |
* | |
* For 8-bit character encodings, including ASCII, Latin-1 and UTF-8, byte order is not | |
* significant: the text is a sequence of individual bytes. | |
* | |
* For UTF-16, text is represented as a sequence of 16-bit values. For example, | |
* a capital T in UTF-16 is 0x0054, and lowercase i is 0x0069. If we encode the string | |
* "Ti" with UTF-16 in big-endian byte order, we get: | |
* | |
* [ 0x00, 0x54, 0x00, 0x69 ] | |
* | |
* In UTF-16 with little-endian byte order, "Ti" is encoded as: | |
* | |
* [ 0x54, 0x00, 0x69, 0x00 ] | |
* | |
* Note that the bytes for each character are stored least-significant byte first, but | |
* the order of the characters is unchanged. | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
*/ | |
Titanium.Codec = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Codec.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Codec.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Codec.prototype.lifecycleContainer; | |
/** | |
* ASCII character encoding.. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} CHARSET_ASCII | |
*/ | |
Titanium.Codec.CHARSET_ASCII; | |
/** | |
* ISO 8859-1 (Latin-1) character encoding. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} CHARSET_ISO_LATIN_1 | |
*/ | |
Titanium.Codec.CHARSET_ISO_LATIN_1; | |
/** | |
* UTF-8 character encoding. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} CHARSET_UTF8 | |
*/ | |
Titanium.Codec.CHARSET_UTF8; | |
/** | |
* UTF-16 character encoding with default byte order. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} CHARSET_UTF16 | |
*/ | |
Titanium.Codec.CHARSET_UTF16; | |
/** | |
* UTF-16 character encoding with big endian byte order. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} CHARSET_UTF16BE | |
*/ | |
Titanium.Codec.CHARSET_UTF16BE; | |
/** | |
* UTF-16 character encoding with little endian byte order. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} CHARSET_UTF16LE | |
*/ | |
Titanium.Codec.CHARSET_UTF16LE; | |
/** | |
* 8-bit integer encoding type. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} TYPE_BYTE | |
*/ | |
Titanium.Codec.TYPE_BYTE; | |
/** | |
* 16-bit integer encoding type. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} TYPE_SHORT | |
*/ | |
Titanium.Codec.TYPE_SHORT; | |
/** | |
* 32-bit integer encoding type. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} TYPE_INT | |
*/ | |
Titanium.Codec.TYPE_INT; | |
/** | |
* 32-bit single precision floating-point type. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} TYPE_FLOAT | |
*/ | |
Titanium.Codec.TYPE_FLOAT; | |
/** | |
* 64-bit integer encoding type. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} TYPE_LONG | |
*/ | |
Titanium.Codec.TYPE_LONG; | |
/** | |
* 64-bit double precision floating-point type. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {String} TYPE_DOUBLE | |
*/ | |
Titanium.Codec.TYPE_DOUBLE; | |
/** | |
* Big endian (network) byte order -- that is, the most significant byte first. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {Number} BIG_ENDIAN | |
*/ | |
Titanium.Codec.BIG_ENDIAN; | |
/** | |
* Little endian byte order -- that is, the least significant byte first. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @readonly | |
* @type {Number} LITTLE_ENDIAN | |
*/ | |
Titanium.Codec.LITTLE_ENDIAN; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Codec.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Codec.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Codec.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Codec.applyProperties = function(props) {}; | |
/** | |
* Get the OS native byte order (either <Titanium.Codec.BIG_ENDIAN> or | |
* <Titanium.Codec.LITTLE_ENDIAN>). | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Codec.getNativeByteOrder = function() {}; | |
/** | |
* Encodes a number and writes it to a buffer. | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {EncodeNumberDict} options Named parameters. | |
* @return {Number} | |
*/ | |
Titanium.Codec.encodeNumber = function(options) {}; | |
/** | |
* Decodes a number from the `source` buffer using the specified data type. | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {DecodeNumberDict} options Named parameters. | |
* @return {Number} | |
*/ | |
Titanium.Codec.decodeNumber = function(options) {}; | |
/** | |
* Encodes a string into a series of bytes in a buffer using the specified character set. | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {Dictionary<EncodeStringDict>} options Named parameters. | |
* @return {Number} | |
*/ | |
Titanium.Codec.encodeString = function(options) {}; | |
/** | |
* Decodes the source buffer into a String using the supplied character set. | |
* | |
* @since 1.7 (Android), 1.7 (iPhone), 1.7 (iPad) | |
* @param {DecodeStringDict} options Named parameters. | |
* @return {String} | |
*/ | |
Titanium.Codec.decodeString = function(options) {}; | |
/** | |
* Gets the value of the <Titanium.Codec.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Codec.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Codec.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Codec.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Codec.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Codec.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Codec.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Codec.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Codec.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Codec.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup) | |
* }} | |
*/ | |
Titanium._Dictionary_Codec; | |
/** | |
* The top-level Contacts module, used for accessing and modifying the system contacts address book. | |
* | |
* @extends {Titanium.Module} | |
* @description See examples for more information. | |
* | |
* #### iOS Platform Notes | |
* | |
* On iOS, the contacts database may be modified by an external application, causing any `Person` or | |
* `Group` objects you've retrieved to be out of sync with the database. The IDs of these objects are | |
* not guaranteed to remain the same, so updating an object when it is out of sync may have | |
* unpredictable results. | |
* | |
* To avoid this, listen for the [reload](Titanium.Contacts.reload) event. When you receive a | |
* `reload` event, you should assume that any existing `Person` or `Group` objects are invalid and | |
* reload them from the `Contacts` module before modifying them. | |
* | |
* See the examples for a sample use of the `reload` event. | |
* | |
* If 'ABAddressBookErrorDomain error 0' occurs, it implies that you are not allowed to add or edit | |
* certain fields. Check your default account in the iOS settings under contacts. If it's not 'iCloud', | |
* most likely it will not support fields such as alternateBirthday or socialProfile. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.Contacts = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Contacts.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Contacts.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Contacts.prototype.lifecycleContainer; | |
/** | |
* A boolean value that indicates whether to fetch the notes stored in contacts or not. | |
* @since 8.2.1 (iPhone), 8.2.1 (iPad) | |
* @type {Boolean} includeNote | |
*/ | |
Titanium.Contacts.prototype.includeNote; | |
/** | |
* Specifies that a contact is an organization. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {Number} CONTACTS_KIND_ORGANIZATION | |
*/ | |
Titanium.Contacts.CONTACTS_KIND_ORGANIZATION; | |
/** | |
* Specifies that a contact is a person. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {Number} CONTACTS_KIND_PERSON | |
*/ | |
Titanium.Contacts.CONTACTS_KIND_PERSON; | |
/** | |
* Specifies that group members will be sorted by first name. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {Number} CONTACTS_SORT_FIRST_NAME | |
*/ | |
Titanium.Contacts.CONTACTS_SORT_FIRST_NAME; | |
/** | |
* Specifies that group members will be sorted by last name. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {Number} CONTACTS_SORT_LAST_NAME | |
*/ | |
Titanium.Contacts.CONTACTS_SORT_LAST_NAME; | |
/** | |
* A [contactsAuthorization](Titanium.Contacts.contactsAuthorization) value | |
* indicating that the application is authorized to use the address book. | |
* | |
* @since 2.1.3 (Android), 2.1.3 (iPhone), 2.1.3 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_AUTHORIZED | |
*/ | |
Titanium.Contacts.AUTHORIZATION_AUTHORIZED; | |
/** | |
* A [contactsAuthorization](Titanium.Contacts.contactsAuthorization) value | |
* indicating that the application is not authorized to use the address book. | |
* | |
* @since 2.1.3 (Android), 2.1.3 (iPhone), 2.1.3 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_DENIED | |
*/ | |
Titanium.Contacts.AUTHORIZATION_DENIED; | |
/** | |
* A [contactsAuthorization](Titanium.Contacts.contactsAuthorization) value | |
* indicating that the application is not authorized to use the address book *and* | |
* the user cannot change this application's status. | |
* | |
* @since 2.1.3 (Android), 2.1.3 (iPhone), 2.1.3 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_RESTRICTED | |
*/ | |
Titanium.Contacts.AUTHORIZATION_RESTRICTED; | |
/** | |
* A [contactsAuthorization](Titanium.Contacts.contactsAuthorization) value | |
* indicating that the authorization state is unknown. | |
* | |
* @since 2.1.3 (Android), 2.1.3 (iPhone), 2.1.3 (iPad) | |
* @readonly | |
* @type {Number} AUTHORIZATION_UNKNOWN | |
*/ | |
Titanium.Contacts.AUTHORIZATION_UNKNOWN; | |
/** | |
* Returns an authorization constant indicating if the application has access to the address book. | |
* @since 2.1.3 (Android), 2.1.3 (iPhone), 2.1.3 (iPad) | |
* @readonly | |
* @type {Number} contactsAuthorization | |
*/ | |
Titanium.Contacts.prototype.contactsAuthorization; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Contacts.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Contacts.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Contacts.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Contacts.applyProperties = function(props) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Contacts.Group>. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @param {Titanium.Contacts._Dictionary_Group=} parameters Properties to set on a new object, including any in <Titanium.Contacts.Group> except | |
* those marked as non-creation or read-only. | |
* | |
* @return {Titanium.Contacts.Group} | |
*/ | |
Titanium.Contacts.createGroup = function(parameters) {}; | |
/** | |
* Creates and returns an instance of <Titanium.Contacts.Person>, and commits all pending | |
* changes to the underlying contacts database. | |
* | |
* @since 2.1.0 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Titanium.Contacts._Dictionary_Person=} parameters Properties to set on a new object, including any in <Titanium.Contacts.Person> except | |
* those marked as non-creation or read-only. | |
* | |
* @return {Titanium.Contacts.Person} | |
*/ | |
Titanium.Contacts.createPerson = function(parameters) {}; | |
/** | |
* Gets all groups. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @return {Array<Titanium.Contacts.Group>} | |
*/ | |
Titanium.Contacts.getAllGroups = function() {}; | |
/** | |
* Gets all people, unless a limit is specified. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} limit Maximum number of people. Android only. | |
* @return {Array<Titanium.Contacts.Person>} | |
*/ | |
Titanium.Contacts.getAllPeople = function(limit) {}; | |
/** | |
* Gets the group with the specified identifier. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} id Group identifier. | |
* @return {Titanium.Contacts.Group} | |
*/ | |
Titanium.Contacts.getGroupByID = function(id) {}; | |
/** | |
* Gets the group with the specified identifier. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {String} id Group identifier. | |
* @return {Titanium.Contacts.Group} | |
*/ | |
Titanium.Contacts.getGroupByIdentifier = function(id) {}; | |
/** | |
* Gets people with a `firstName`, `middleName` or `lastName` field, or a combination | |
* of these fields, that match the specified name. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name to match. | |
* @return {Array<Titanium.Contacts.Person>} | |
*/ | |
Titanium.Contacts.getPeopleWithName = function(name) {}; | |
/** | |
* Gets the person with the specified identifier. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} id Contact identifier. | |
* @return {Titanium.Contacts.Person} | |
*/ | |
Titanium.Contacts.getPersonByID = function(id) {}; | |
/** | |
* Gets the person with the specified identifier. | |
* @since 5.0.0 (Android), 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @param {Number} id Contact identifier. | |
* @return {Titanium.Contacts.Person} | |
*/ | |
Titanium.Contacts.getPersonByIdentifier = function(id) {}; | |
/** | |
* Removes a group from the address book. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @param {Titanium.Contacts.Group} group Contact group. | |
*/ | |
Titanium.Contacts.removeGroup = function(group) {}; | |
/** | |
* Removes a contact from the address book. | |
* @since 2.1.0 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Titanium.Contacts.Person} person Contact. | |
*/ | |
Titanium.Contacts.removePerson = function(person) {}; | |
/** | |
* Reverts all changes made by the previous save to the address book. Deprecated for >= iOS9. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.Contacts.revert = function() {}; | |
/** | |
* Commits all pending changes to the underlying contacts database. | |
* @since 3.0.0 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Array<Titanium.Contacts.Person>} contacts List of contacts to save. Used on Android only. | |
*/ | |
Titanium.Contacts.save = function(contacts) {}; | |
/** | |
* Displays a picker that allows a person to be selected. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {showContactsParams} params Argument containing parameters for this method. Optional on Android. | |
*/ | |
Titanium.Contacts.showContacts = function(params) {}; | |
/** | |
* Returns `true` if the app has contacts access. | |
* @since 5.1.0 (Android), 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Contacts.hasContactsPermissions = function() {}; | |
/** | |
* Requests for contacts access. | |
* @since 5.1.0 (Android), 5.1.0 (iPhone), 5.1.0 (iPad) | |
* @param {Callback<ContactsAuthorizationResponse>} callback Function to call upon user decision to grant contacts access. | |
*/ | |
Titanium.Contacts.requestContactsPermissions = function(callback) {}; | |
/** | |
* If authorization is unknown, will bring up a dialog requesting permission. | |
* @since 2.1.3 (Android), 2.1.3 (iPhone), 2.1.3 (iPad) | |
* @param {Callback<ContactsAuthorizationResponse>} callback Callback function to execute when when authorization is no longer unknown. | |
*/ | |
Titanium.Contacts.requestAuthorization = function(callback) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Contacts.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Contacts.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Contacts.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Contacts.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.includeNote> property. | |
* @since 8.2.1 (iPhone), 8.2.1 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Contacts.getIncludeNote = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.includeNote> property. | |
* @since 8.2.1 (iPhone), 8.2.1 (iPad) | |
* @param {Boolean} includeNote New value for the property. | |
*/ | |
Titanium.Contacts.setIncludeNote = function(includeNote) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.contactsAuthorization> property. | |
* @since 2.1.3 (Android), 2.1.3 (iPhone), 2.1.3 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Contacts.getContactsAuthorization = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* lifecycleContainer: (Titanium.UI.Window|Titanium.UI.TabGroup), | |
* includeNote: Boolean | |
* }} | |
*/ | |
Titanium._Dictionary_Contacts; | |
/** | |
* An object which represents a group in the system contacts address book. | |
* @extends {Titanium.Proxy} | |
* @description See examples in <Titanium.Contacts> for more information. | |
* | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
*/ | |
Titanium.Contacts.Group = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Contacts.Group.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Contacts.Group.prototype.apiName; | |
/** | |
* Name of this group. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @type {String} name | |
*/ | |
Titanium.Contacts.Group.prototype.name; | |
/** | |
* Record identifier of the group. Single value. Deprecated for iOS 9 and later. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @type {Number} recordId | |
*/ | |
Titanium.Contacts.Group.prototype.recordId; | |
/** | |
* Identifier of the group. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @readonly | |
* @type {String} identifier | |
*/ | |
Titanium.Contacts.Group.prototype.identifier; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Contacts.Group.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Contacts.Group.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Contacts.Group.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Contacts.Group.applyProperties = function(props) {}; | |
/** | |
* Adds a person to this group. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {Titanium.Contacts.Person} person Person to add. For >= iOS9, it is not required to | |
* call <Titanium.Contacts.save> after calling this method. | |
* | |
*/ | |
Titanium.Contacts.Group.add = function(person) {}; | |
/** | |
* Gets people that are members of this group. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @return {Array<Titanium.Contacts.Person>} | |
*/ | |
Titanium.Contacts.Group.members = function() {}; | |
/** | |
* Removes a person from this group. For >= iOS9, it is not | |
* required to call <Titanium.Contacts.save> after calling this method. | |
* | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {Titanium.Contacts.Person} person Person to remove. | |
*/ | |
Titanium.Contacts.Group.remove = function(person) {}; | |
/** | |
* Gets people that are members of this group, sorted in the specified order. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {Number} sortBy Method for sorting. | |
* | |
* @return {Array<Titanium.Contacts.Person>} | |
*/ | |
Titanium.Contacts.Group.sortedMembers = function(sortBy) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Group.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Contacts.Group.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Group.bubbleParent> property. | |
* @since 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Contacts.Group.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Group.apiName> property. | |
* @since 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Group.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Group.name> property. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Group.getName = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Group.name> property. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {String} name New value for the property. | |
*/ | |
Titanium.Contacts.Group.setName = function(name) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Group.recordId> property. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Contacts.Group.getRecordId = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Group.recordId> property. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @param {Number} recordId New value for the property. | |
*/ | |
Titanium.Contacts.Group.setRecordId = function(recordId) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Group.identifier> property. | |
* @since 1.4.0 (iPhone), 1.4.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Group.getIdentifier = function() {}; | |
/** | |
* @typedef {{ | |
* bubbleParent: Boolean, | |
* name: String, | |
* recordId: Number | |
* }} | |
*/ | |
Titanium.Contacts._Dictionary_Group; | |
/** | |
* An object that represents a contact record for a person or organization in the system contacts | |
* address book. | |
* | |
* @extends {Titanium.Proxy} | |
* @description A person object is created using <Titanium.Contacts.createPerson>. | |
* | |
* The following two kinds of properties exist for this object: | |
* | |
* * single value - contains either a `string` or `number` type value, an array of `string` type | |
* values, or `null` if unset. | |
* * multi-value - contains a dictionary with typical keys of `home`, `work` and/or `other`. Each | |
* key contains either a `string` type value, an array of `string` type values, or a dictionary | |
* containing key/value pairs with `string` type values. | |
* | |
* #### Adding and Modifying Properties | |
* | |
* Support for adding and modifying properties is currently supported on iOS and Android. | |
* | |
* #### Keys as Address Book UI Labels | |
* | |
* Keys act as labels in the address book user interface. | |
* | |
* Although there is limited support for custom, arbitrarily-named, keys when used with multi-value | |
* properties, there is no support them with single value properties. | |
* | |
* On iOS, creating custom keys is not recommended, and will lead to undefined results. | |
* | |
* If a label has been created by the user of the device and used with a multi-value property, it | |
* will exist as a key with the same name. | |
* | |
* See examples in <Titanium.Contacts> for more information. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
*/ | |
Titanium.Contacts.Person = function() {}; | |
/** | |
* Indicates if the proxy will bubble an event to its parent. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @type {Boolean} bubbleParent | |
*/ | |
Titanium.Contacts.Person.prototype.bubbleParent; | |
/** | |
* The name of the API that this proxy corresponds to. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @readonly | |
* @type {String} apiName | |
*/ | |
Titanium.Contacts.Person.prototype.apiName; | |
/** | |
* The Window or TabGroup whose Activity lifecycle should be triggered on the proxy. | |
* @since 3.6.0 (Android) | |
* @type {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer | |
*/ | |
Titanium.Contacts.Person.prototype.lifecycleContainer; | |
/** | |
* Addresses for the person. Multi-value. Read-only on Android. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Dictionary} address | |
*/ | |
Titanium.Contacts.Person.prototype.address; | |
/** | |
* Date of birth of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} birthday | |
*/ | |
Titanium.Contacts.Person.prototype.birthday; | |
/** | |
* Alternate birthday of the person. Single Dictionary. | |
* | |
* @since 3.6.0 (iPhone), 3.6.0 (iPad) | |
* @type {Dictionary} alternateBirthday | |
*/ | |
Titanium.Contacts.Person.prototype.alternateBirthday; | |
/** | |
* Date and time that the person record was created. Single value. Deprecated since iOS 9. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} created | |
*/ | |
Titanium.Contacts.Person.prototype.created; | |
/** | |
* Dates associated with the person. Multi-value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Dictionary} date | |
*/ | |
Titanium.Contacts.Person.prototype.date; | |
/** | |
* Department of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} department | |
*/ | |
Titanium.Contacts.Person.prototype.department; | |
/** | |
* Email addresses for the person. Multi-value. Read-only on Android. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Dictionary} email | |
*/ | |
Titanium.Contacts.Person.prototype.email; | |
/** | |
* First name of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} firstName | |
*/ | |
Titanium.Contacts.Person.prototype.firstName; | |
/** | |
* Phonetic first name of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} firstPhonetic | |
*/ | |
Titanium.Contacts.Person.prototype.firstPhonetic; | |
/** | |
* Localized full name of the person. Single value. Read-only on Android. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} fullName | |
*/ | |
Titanium.Contacts.Person.prototype.fullName; | |
/** | |
* Record identifier of the person. Single value. | |
* @since 0.8 (Android) | |
* @readonly | |
* @type {Number} id | |
*/ | |
Titanium.Contacts.Person.prototype.id; | |
/** | |
* Identifier of the person. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @readonly | |
* @type {String} identifier | |
*/ | |
Titanium.Contacts.Person.prototype.identifier; | |
/** | |
* Image for the person. Single value. Read-only for >= iOS9 | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Titanium.Blob} image | |
*/ | |
Titanium.Contacts.Person.prototype.image; | |
/** | |
* Instant messenger information of the person. Multi-value. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Dictionary} instantMessage | |
*/ | |
Titanium.Contacts.Person.prototype.instantMessage; | |
/** | |
* Social profile information of the person. Multi-value. | |
* | |
* @since 3.6.0 (iPhone), 3.6.0 (iPad) | |
* @type {Dictionary} socialProfile | |
*/ | |
Titanium.Contacts.Person.prototype.socialProfile; | |
/** | |
* Job title of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} jobTitle | |
*/ | |
Titanium.Contacts.Person.prototype.jobTitle; | |
/** | |
* Determines the type of information the person record contains; either person or organization. | |
* Read-only on Android. | |
* | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Number} kind | |
*/ | |
Titanium.Contacts.Person.prototype.kind; | |
/** | |
* Last name of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} lastName | |
*/ | |
Titanium.Contacts.Person.prototype.lastName; | |
/** | |
* Phonetic last name of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} lastPhonetic | |
*/ | |
Titanium.Contacts.Person.prototype.lastPhonetic; | |
/** | |
* Middle name of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} middleName | |
*/ | |
Titanium.Contacts.Person.prototype.middleName; | |
/** | |
* Phonetic middle name of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} middlePhonetic | |
*/ | |
Titanium.Contacts.Person.prototype.middlePhonetic; | |
/** | |
* Date and time that the person record was last modified. Single value. Deprecated since iOS 9. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} modified | |
*/ | |
Titanium.Contacts.Person.prototype.modified; | |
/** | |
* Nickname of the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} nickname | |
*/ | |
Titanium.Contacts.Person.prototype.nickname; | |
/** | |
* Notes for the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} note | |
*/ | |
Titanium.Contacts.Person.prototype.note; | |
/** | |
* Organization to which the person belongs. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {String} organization | |
*/ | |
Titanium.Contacts.Person.prototype.organization; | |
/** | |
* Phone numbers for the person. Multi-value. Read-only on Android. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Dictionary} phone | |
*/ | |
Titanium.Contacts.Person.prototype.phone; | |
/** | |
* Prefix for the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} prefix | |
*/ | |
Titanium.Contacts.Person.prototype.prefix; | |
/** | |
* Record identifier of the person. Single value. Deprecated since iOS 9. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @type {Number} recordId | |
*/ | |
Titanium.Contacts.Person.prototype.recordId; | |
/** | |
* Names of people to which the person is related. Multi-value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Dictionary} relatedNames | |
*/ | |
Titanium.Contacts.Person.prototype.relatedNames; | |
/** | |
* Suffix for the person. Single value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @readonly | |
* @type {String} suffix | |
*/ | |
Titanium.Contacts.Person.prototype.suffix; | |
/** | |
* URLs of webpages associated with the person. Multi-value. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @type {Dictionary} url | |
*/ | |
Titanium.Contacts.Person.prototype.url; | |
/** | |
* Adds the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to invoke when the event is fired. | |
*/ | |
Titanium.Contacts.Person.addEventListener = function(name, callback) {}; | |
/** | |
* Removes the specified callback as an event listener for the named event. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Callback<Object>} callback Callback function to remove. Must be the same function passed to `addEventListener`. | |
*/ | |
Titanium.Contacts.Person.removeEventListener = function(name, callback) {}; | |
/** | |
* Fires a synthesized event to any registered listeners. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} name Name of the event. | |
* @param {Dictionary} event A dictionary of keys and values to add to the <Titanium.Event> object sent to the listeners. | |
*/ | |
Titanium.Contacts.Person.fireEvent = function(name, event) {}; | |
/** | |
* Applies the properties to the proxy. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Dictionary} props A dictionary of properties to apply. | |
*/ | |
Titanium.Contacts.Person.applyProperties = function(props) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @return {Boolean} | |
*/ | |
Titanium.Contacts.Person.getBubbleParent = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.bubbleParent> property. | |
* @since 3.0.0 (Android), 3.0.0 (iPhone), 3.0.0 (iPad) | |
* @param {Boolean} bubbleParent New value for the property. | |
*/ | |
Titanium.Contacts.Person.setBubbleParent = function(bubbleParent) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.apiName> property. | |
* @since 3.2.0 (Android), 3.2.0 (iPhone), 3.2.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getApiName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @return {Titanium.UI.Window|Titanium.UI.TabGroup} | |
*/ | |
Titanium.Contacts.Person.getLifecycleContainer = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.lifecycleContainer> property. | |
* @since 3.6.0 (Android) | |
* @param {Titanium.UI.Window|Titanium.UI.TabGroup} lifecycleContainer New value for the property. | |
*/ | |
Titanium.Contacts.Person.setLifecycleContainer = function(lifecycleContainer) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.address> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Dictionary} | |
*/ | |
Titanium.Contacts.Person.getAddress = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.address> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} address New value for the property. | |
*/ | |
Titanium.Contacts.Person.setAddress = function(address) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.birthday> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getBirthday = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.birthday> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} birthday New value for the property. | |
*/ | |
Titanium.Contacts.Person.setBirthday = function(birthday) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.alternateBirthday> property. | |
* @since 3.6.0 (iPhone), 3.6.0 (iPad) | |
* @return {Dictionary} | |
*/ | |
Titanium.Contacts.Person.getAlternateBirthday = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.alternateBirthday> property. | |
* @since 3.6.0 (iPhone), 3.6.0 (iPad) | |
* @param {Dictionary} alternateBirthday New value for the property. | |
*/ | |
Titanium.Contacts.Person.setAlternateBirthday = function(alternateBirthday) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.created> property. | |
* @since 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getCreated = function() {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.date> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Dictionary} | |
*/ | |
Titanium.Contacts.Person.getDate = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.date> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} date New value for the property. | |
*/ | |
Titanium.Contacts.Person.setDate = function(date) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.department> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getDepartment = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.department> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} department New value for the property. | |
*/ | |
Titanium.Contacts.Person.setDepartment = function(department) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.email> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Dictionary} | |
*/ | |
Titanium.Contacts.Person.getEmail = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.email> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} email New value for the property. | |
*/ | |
Titanium.Contacts.Person.setEmail = function(email) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.firstName> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getFirstName = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.firstName> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} firstName New value for the property. | |
*/ | |
Titanium.Contacts.Person.setFirstName = function(firstName) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.firstPhonetic> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getFirstPhonetic = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.firstPhonetic> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} firstPhonetic New value for the property. | |
*/ | |
Titanium.Contacts.Person.setFirstPhonetic = function(firstPhonetic) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.fullName> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getFullName = function() {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.id> property. | |
* @since 0.8 (Android) | |
* @return {Number} | |
*/ | |
Titanium.Contacts.Person.getId = function() {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.identifier> property. | |
* @since 5.0.0 (iPhone), 5.0.0 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getIdentifier = function() {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.image> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Titanium.Blob} | |
*/ | |
Titanium.Contacts.Person.getImage = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.image> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Titanium.Blob} image New value for the property. | |
*/ | |
Titanium.Contacts.Person.setImage = function(image) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.instantMessage> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Dictionary} | |
*/ | |
Titanium.Contacts.Person.getInstantMessage = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.instantMessage> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Dictionary} instantMessage New value for the property. | |
*/ | |
Titanium.Contacts.Person.setInstantMessage = function(instantMessage) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.socialProfile> property. | |
* @since 3.6.0 (iPhone), 3.6.0 (iPad) | |
* @return {Dictionary} | |
*/ | |
Titanium.Contacts.Person.getSocialProfile = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.socialProfile> property. | |
* @since 3.6.0 (iPhone), 3.6.0 (iPad) | |
* @param {Dictionary} socialProfile New value for the property. | |
*/ | |
Titanium.Contacts.Person.setSocialProfile = function(socialProfile) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.jobTitle> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getJobTitle = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.jobTitle> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} jobTitle New value for the property. | |
*/ | |
Titanium.Contacts.Person.setJobTitle = function(jobTitle) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.kind> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {Number} | |
*/ | |
Titanium.Contacts.Person.getKind = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.kind> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {Number} kind New value for the property. | |
*/ | |
Titanium.Contacts.Person.setKind = function(kind) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.lastName> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getLastName = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.lastName> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} lastName New value for the property. | |
*/ | |
Titanium.Contacts.Person.setLastName = function(lastName) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.lastPhonetic> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getLastPhonetic = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.lastPhonetic> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} lastPhonetic New value for the property. | |
*/ | |
Titanium.Contacts.Person.setLastPhonetic = function(lastPhonetic) {}; | |
/** | |
* Gets the value of the <Titanium.Contacts.Person.middleName> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @return {String} | |
*/ | |
Titanium.Contacts.Person.getMiddleName = function() {}; | |
/** | |
* Sets the value of the <Titanium.Contacts.Person.middleName> property. | |
* @since 0.8 (Android), 0.8 (iPhone), 0.8 (iPad) | |
* @param {String} middleName New value for the property. | |
*/ | |
Titanium.Contacts.Person.setMiddleName = function(middleName) {}; | |
/** | |
* Gets the value of th |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment