diff --git a/apidoc/NodeJS/assert.yml b/apidoc/NodeJS/assert.yml index a68f12fa991..c2dc5b7d80d 100644 --- a/apidoc/NodeJS/assert.yml +++ b/apidoc/NodeJS/assert.yml @@ -75,7 +75,7 @@ methods: Besides the async nature to await the completion behaves identically to `assert.doesNotThrow()`. parameters: - name: asyncFn - type: [ Function, Promise ] + type: [ Function, Promise ] summary: function to invoke - name: error type: [ RegExp, Function ] @@ -259,7 +259,7 @@ methods: If specified, `message` will be the message provided by the `AssertionError` if the `asyncFn` fails to reject. parameters: - name: asyncFn - type: [ Function, Promise ] + type: [ Function, Promise ] summary: function to invoke - name: error type: [ RegExp, Function, Object, Error ] diff --git a/apidoc/NodeJS/fs.yml b/apidoc/NodeJS/fs.yml index a8074e4b091..3d8b3ab1647 100644 --- a/apidoc/NodeJS/fs.yml +++ b/apidoc/NodeJS/fs.yml @@ -99,7 +99,7 @@ methods: default: fs.constants.F_OK optional: true - name: callback - type: Function + type: Callback summary: typical async callback function - name: accessSync @@ -133,7 +133,7 @@ methods: summary: options optional: true - name: callback - type: Function + type: Callback summary: typical async callback function - name: appendFileSync @@ -164,7 +164,7 @@ methods: type: [ String, Number ] summary: new mode/permissions - name: callback - type: Function + type: Callback summary: typical async callback function - name: chmodSync @@ -196,7 +196,7 @@ methods: type: Number summary: new group - name: callback - type: Function + type: Callback summary: typical async callback function - name: chownSync @@ -225,7 +225,7 @@ methods: type: Number summary: file descriptor - name: callback - type: Function + type: Callback summary: typical async callback function - name: closeSync @@ -260,7 +260,7 @@ methods: optional: true default: 0 - name: callback - type: Function + type: Callback summary: typical async callback function - name: copyFileSync @@ -297,7 +297,7 @@ methods: summary: file path - name: callback - type: Function + type: Callback summary: atypical async callback function that received the result as a single boolean arguments - name: existsSync(path) @@ -322,7 +322,7 @@ methods: type: [ String, Number ] summary: new mode/permissions - name: callback - type: Function + type: Callback summary: typical async callback function - name: fchmodSync @@ -354,7 +354,7 @@ methods: type: Number summary: new group - name: callback - type: Function + type: Callback summary: typical async callback function - name: fchownSync @@ -383,7 +383,7 @@ methods: type: Number summary: file descriptor - name: callback - type: Function + type: Callback summary: typical async callback function - name: fdatasyncSync @@ -410,7 +410,7 @@ methods: optional: true summary: options - name: callback - type: Function + type: Callback summary: typical async callback function - name: fstatSync @@ -437,7 +437,7 @@ methods: optional: true summary: options - name: callback - type: Function + type: Callback summary: typical async callback function - name: lstatSync @@ -470,7 +470,7 @@ methods: optional: true summary: options - name: callback - type: Function + type: Callback summary: typical async callback function. The second argument is an optional path `string`. - name: mkdirSync @@ -509,7 +509,7 @@ methods: optional: true summary: encoding if `string` - name: callback - type: Function + type: Callback summary: typical async callback function. The second argument is the generated path `string`. - name: mkdtempSync @@ -551,7 +551,7 @@ methods: optional: true default: 0o666 - name: callback - type: Function + type: Callback summary: typical async callback function, the second argument is an integer representing a file descriptor # Not implemented: @@ -611,7 +611,7 @@ methods: type: Number summary: where to begin reading from in the file. *Unused/unsupported in Titanium.* - name: callback - type: Function + type: Callback summary: async callback function - name: readdir @@ -630,7 +630,7 @@ methods: summary: options optional: true - name: callback - type: Function> + type: Callback summary: | Typical async callback function. The second argument is an array of results which may be `String`s, s, or s @@ -665,7 +665,7 @@ methods: summary: encoding `string`, or an options object optional: true - name: callback - type: Function + type: Callback summary: typical async callback function, the second argument is either a `string` or a - name: readFileSync @@ -726,7 +726,7 @@ methods: # TODO: define a type for fs.realpath.options optional: true - name: callback - type: Function + type: Callback summary: typical async callback function - name: realpath.native @@ -748,7 +748,7 @@ methods: # TODO: define a type for fs.realpath.options optional: true - name: callback - type: Function + type: Callback summary: typical async callback function - name: realpathSync @@ -798,7 +798,7 @@ methods: type: [ String, buffer.Buffer ] summary: destination file path - name: callback - type: Function + type: Callback summary: typical async callback function - name: renameSync @@ -822,7 +822,7 @@ methods: summary: options optional: true - name: callback - type: Function + type: Callback summary: typical async callback function # Not implemented: @@ -880,7 +880,7 @@ methods: optional: true summary: fs.stat.options - name: callback - type: Function + type: Callback summary: typical async callback function - name: statSync @@ -909,7 +909,7 @@ methods: type: [ String, buffer.Buffer ] summary: the symlink path - name: callback - type: Function + type: Callback summary: typical async callback function - name: symlinkSync @@ -939,7 +939,7 @@ methods: default: 0 summary: target length to truncate to - name: callback - type: Function + type: Callback summary: typical async callback function - name: truncateSync @@ -964,7 +964,7 @@ methods: type: [ String, buffer.Buffer ] summary: file path - name: callback - type: Function + type: Callback summary: typical async callback function - name: unlinkSync @@ -1006,7 +1006,7 @@ methods: type: [ Number, String, Date ] summary: modification time - name: callback - type: Function + type: Callback summary: typical async callback function - name: utimesSync @@ -1083,7 +1083,7 @@ methods: summary: offset from the beginning of the file where this data should be written (if data to be written is a `Buffer`) optional: true - name: callback - type: Function + type: Callback summary: typical async callback function - name: writeFile @@ -1105,7 +1105,7 @@ methods: summary: from the beginning of the file where this data should be written optional: true - name: callback - type: Function + type: Callback summary: typical async callback function - name: writeFileSync @@ -1753,3 +1753,66 @@ summary: | Instances of `fs.ReadStream` are created and returned using the `fs.createReadStream()` function. **NOTE:** Titanium defines an empty class for this type. No methods/properties are implemented! + +--- +name: fs.StatsResponse +since: '8.3.0' +summary: Argument passed to the fs.Stats callback functions +properties: + - name: error + type: Error + summary: The error if one occurred + - name: stats + type: fs.Stats + summary: The fs.Stats object + +--- +name: fs.StringResponse +since: '8.3.0' +summary: Argument passed to callback functions expecting a string result +properties: + - name: error + type: Error + summary: The error if one occurred + - name: path + type: String + summary: The string result (typically a path) + +--- +name: fs.NumberResponse +since: '8.3.0' +summary: Argument passed to callback functions expecting a number result +properties: + - name: error + type: Error + summary: The error if one occurred + - name: fd + type: Number + summary: The file descriptor + +--- +name: fs.ReadResponse +since: '8.3.0' +summary: Argument passed to the read callback function +properties: + - name: error + type: Error + summary: The error if one occurred + - name: bytesRead + type: Number + summary: Number of bytes read + - name: buffer + type: buffer.Buffer + summary: The buffer that was read into + +--- +name: fs.ArrayResponse +since: '8.3.0' +summary: Argument passed to callback functions expecting an array result +properties: + - name: error + type: Error + summary: The error if one occurred + - name: files + type: Array + summary: Array of file names diff --git a/apidoc/Titanium/Android/Android.yml b/apidoc/Titanium/Android/Android.yml index b9d02f8c10e..6eeb096b29e 100644 --- a/apidoc/Titanium/Android/Android.yml +++ b/apidoc/Titanium/Android/Android.yml @@ -244,7 +244,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise since: "5.4.0" - name: isServiceRunning @@ -2585,3 +2585,4 @@ properties: name: RequestPermissionAccessResult summary: Argument passed to the callback when a request finishes successfully or erroneously. extends: ErrorResponse + diff --git a/apidoc/Titanium/Blob.yml b/apidoc/Titanium/Blob.yml index 9e3fbd8c6c3..fa4be54553d 100644 --- a/apidoc/Titanium/Blob.yml +++ b/apidoc/Titanium/Blob.yml @@ -301,5 +301,5 @@ methods: - name: arrayBuffer returns: - type: Promise + type: Promise summary: Returns a `Promise` that resolves with the contents of the blob as binary data contained in an `ArrayBuffer`. diff --git a/apidoc/Titanium/Calendar/Calendar.yml b/apidoc/Titanium/Calendar/Calendar.yml index b51c18b9ef2..b5bc102102d 100644 --- a/apidoc/Titanium/Calendar/Calendar.yml +++ b/apidoc/Titanium/Calendar/Calendar.yml @@ -76,7 +76,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise platforms: [iphone, ipad, android, macos] since: "5.1.0" diff --git a/apidoc/Titanium/Contacts/Contacts.yml b/apidoc/Titanium/Contacts/Contacts.yml index a767f63e706..4bec4c38362 100644 --- a/apidoc/Titanium/Contacts/Contacts.yml +++ b/apidoc/Titanium/Contacts/Contacts.yml @@ -193,7 +193,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise since: {android: "5.1.0", iphone: "5.1.0", ipad: "5.1.0", macos: "9.2.0"} properties: diff --git a/apidoc/Titanium/Database/DB.yml b/apidoc/Titanium/Database/DB.yml index 140bd51f0c4..b2cea6f36a8 100644 --- a/apidoc/Titanium/Database/DB.yml +++ b/apidoc/Titanium/Database/DB.yml @@ -82,7 +82,7 @@ methods: type: Callback optional: true returns: - type: Promise + type: Promise summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. since: { android: "8.1.0", iphone: "8.1.0", ipad: "8.1.0" } @@ -114,7 +114,7 @@ methods: type: Callback> optional: true returns: - type: Promise> + type: Promise summary: | On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. If the `Promise` is rejected, the `Error` will have custom properties indicating the `index` of the failed query, and the partial `results` up to that failure. See . @@ -183,3 +183,4 @@ properties: summary: Index of the failed query type: Number since: { android: "8.1.0", iphone: "8.1.0", ipad: "8.1.0" } + diff --git a/apidoc/Titanium/Filesystem/Filesystem.yml b/apidoc/Titanium/Filesystem/Filesystem.yml index b5cbf66b32d..1cc92f14375 100644 --- a/apidoc/Titanium/Filesystem/Filesystem.yml +++ b/apidoc/Titanium/Filesystem/Filesystem.yml @@ -151,7 +151,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise platforms: [android] since: "5.4.0" diff --git a/apidoc/Titanium/Geolocation/Android/Android.yml b/apidoc/Titanium/Geolocation/Android/Android.yml index 3b95709696b..295d97449fc 100644 --- a/apidoc/Titanium/Geolocation/Android/Android.yml +++ b/apidoc/Titanium/Geolocation/Android/Android.yml @@ -52,11 +52,9 @@ description: | module are ignored: * [Geolocation.accuracy](Titanium.Geolocation.accuracy) - * [Geolocation.frequency](Titanium.Geolocation.frequency) - * [Geolocation.preferredProvider](Titanium.Geolocation.preferredProvider) - When `manualMode` is `false`, the `accuracy`, `frequency` and `preferredProvider` - settings from are used to configure location updates. + When `manualMode` is `false`, the `accuracy` + setting from is used to configure location updates. Any location providers and location rules set in are retained, but they have no effect. @@ -167,9 +165,8 @@ properties: If `true`, location updates are controlled by the location providers and location rules configured in this module. - If `false`, location updates are configured using the [accuracy](Titanium.Geolocation.accuracy), - [frequency](Titanium.Geolocation.frequency) and [preferredProvider](Titanium.Geolocation.preferredProvider) - properties in the module. + If `false`, location updates are configured using the [accuracy](Titanium.Geolocation.accuracy) + property in the module. type: Boolean default: false diff --git a/apidoc/Titanium/Geolocation/Geolocation.yml b/apidoc/Titanium/Geolocation/Geolocation.yml index 028361c50d4..23cc1f7772b 100644 --- a/apidoc/Titanium/Geolocation/Geolocation.yml +++ b/apidoc/Titanium/Geolocation/Geolocation.yml @@ -215,7 +215,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise - name: getCurrentHeading summary: Retrieves the current compass heading. @@ -228,7 +228,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise - name: getCurrentPosition summary: Retrieves the last known location from the device. @@ -246,7 +246,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise - name: hasLocationPermissions summary: Returns `true` if the app has location access. @@ -299,7 +299,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise since: "5.1.0" - name: requestTemporaryFullAccuracyAuthorization @@ -382,7 +382,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise events: - name: calibration diff --git a/apidoc/Titanium/Media/Media.yml b/apidoc/Titanium/Media/Media.yml index 8e6a97e518e..4e8cc24cad8 100644 --- a/apidoc/Titanium/Media/Media.yml +++ b/apidoc/Titanium/Media/Media.yml @@ -301,7 +301,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise platforms: [iphone, ipad, android, macos] since: "5.1.0" @@ -350,7 +350,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise platforms: [android, iphone, ipad, macos] since: android: "9.3.0" @@ -460,7 +460,7 @@ methods: optional: true returns: summary: On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument. - type: Promise + type: Promise events: - name: cameraready @@ -804,6 +804,12 @@ properties: permission: read-only since: "7.5.0" + - name: AUDIO_STATE_WAITING_FOR_QUEUE + summary: Player is waiting for queued data. + type: Number + permission: read-only + since: "7.5.0" + - name: VERTICAL_ALIGN_CENTER summary: Vertical align center type: Number @@ -2460,3 +2466,4 @@ properties: - name: size summary: Size of the video in bytes type: Number + diff --git a/apidoc/Titanium/Network/HTTPClient.yml b/apidoc/Titanium/Network/HTTPClient.yml index 0ea7d9d304c..911235657ae 100644 --- a/apidoc/Titanium/Network/HTTPClient.yml +++ b/apidoc/Titanium/Network/HTTPClient.yml @@ -368,7 +368,6 @@ properties: Set this parameter when authentication against NTLM domains along with the [username](Titanium.Network.HTTPClient.username) and [password](Titanium.Network.HTTPClient.password) properties. iOS supports NTLM authentication natively. - Android can be extended using the [addAuthFactory](Titanium.Network.HTTPClient.addAuthFactory) method. Must be set before calling [open](Titanium.Network.HTTPClient.open). type: String default: Undefined diff --git a/apidoc/Titanium/Titanium.yml b/apidoc/Titanium/Titanium.yml index 07419991c78..9b7c2450b12 100644 --- a/apidoc/Titanium/Titanium.yml +++ b/apidoc/Titanium/Titanium.yml @@ -112,3 +112,8 @@ properties: summary: The byte order of this buffer. optional: true default: The OS native byte order is used by default. See + +--- +name: Void +summary: A return type without a value. + diff --git a/apidoc/Titanium/UI/WebView.yml b/apidoc/Titanium/UI/WebView.yml index 2b27eebd68a..5699efd967d 100644 --- a/apidoc/Titanium/UI/WebView.yml +++ b/apidoc/Titanium/UI/WebView.yml @@ -136,8 +136,8 @@ description: | You must also call [pause](Titanium.UI.WebView.pause) when the current activity is paused, to prevent plugin content from continuing to run in the background. Call [resume](Titanium.UI.WebView.resume) when the current activity is resumed. You can - do this by adding listeners for the [Activity.pause](Titanium.Android.Activity.pause) - and [Activity.resume](Titanium.Android.Activity.resume) events. + do this by adding listeners for the [App.pause](Titanium.App.pause) + and [App.resume](Titanium.App.resume) events. **Accessing Cookies** diff --git a/apidoc/Titanium/UI/Window.yml b/apidoc/Titanium/UI/Window.yml index 017595c17ad..ba0d4e2abca 100644 --- a/apidoc/Titanium/UI/Window.yml +++ b/apidoc/Titanium/UI/Window.yml @@ -515,7 +515,7 @@ methods: type: [Titanium.UI.Animation, Dictionary, closeWindowParams] optional: true returns: - type: Promise + type: Promise summary: | Starting in SDK 10.0.0, this method returns a `Promise` that will be resolved once the window is closed, akin to adding a one-time listener for the `close` event. If the window fails to close (for example, because @@ -555,7 +555,7 @@ methods: type: openWindowParams optional: true returns: - type: Promise + type: Promise summary: | Starting in SDK 10.0.0, this method returns a `Promise` that will be resolved once the window is opened, akin to adding a one-time listener for the `open` event. If the window fails to open (for example, because @@ -1153,7 +1153,7 @@ properties: description: | This was separated from the event. You need to define this callback if you explicitly want to override the back button behavior. - type: Callback + type: Callback platforms: [android] - name: orientationModes