-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
working on updating the titanium desktop externs. All externs are gen…
…erated now from documention yml files from official titanium github project. Still needs finishing.
- Loading branch information
Showing
828 changed files
with
14,241 additions
and
5,985 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
namespace: Titanium | ||
type: module | ||
description: | | ||
This is the top-level Titanium module, containing all Titanium APIs. | ||
Titanium API objects generally follow the setProperty()/getProperty() | ||
pattern, but you may also use accessors for most operations For example: | ||
<pre><code> | ||
var window = Titanium.UI.currentWindow; | ||
window.setHeight(300); // Set the window height to 300 pixels. | ||
window.height = 300; // The same. | ||
</code></pre> | ||
since: 0.2.0 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
namespace: Titanium.ALL | ||
type: property | ||
description: The ALL event constant. This can be used for listening for all events. | ||
since: 0.6.0 | ||
platforms: ['osx', 'linux', 'win32'] | ||
returns: String |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
namespace: Titanium.API | ||
type: module | ||
description: A module for holding core Titanium functionality. | ||
since: 0.2.0 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
namespace: Titanium.API.APP_UPDATE | ||
type: property | ||
description: A constant representing an application update component type. | ||
since: 0.4.0 | ||
platforms: ['osx', 'linux', 'win32'] | ||
returns: Number |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
namespace: Titanium.API.Application | ||
type: object | ||
description: | | ||
An object representing a Titanium application, either the currently running | ||
application or one on disk. | ||
since: 0.4.0 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.getArgumentValue | ||
type: method | ||
description: | | ||
Find the value for a given argument. You may either pass | ||
'param' or '--param' and this method will find the command-line | ||
value for '--param=<value>'. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: | ||
- [String, argument, The name of the argument to find the value for.] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
namespace: Titanium.API.Application.getArguments | ||
type: method | ||
description: | | ||
Retrieve a list of command-line arguments passed to this application. This | ||
list will include the first argument, which is the path to the executable. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<String> | ||
parameters: [] |
13 changes: 13 additions & 0 deletions
13
apidoc/Titanium/API/Application/getAvailableComponents.yml
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
namespace: Titanium.API.Application.getAvailableComponents | ||
type: method | ||
description: | | ||
Return a list of all available (installed and bundled) components | ||
for this application. This is simply the list returned by | ||
API.getInstalledComponents() plus any components bundled with the | ||
application. Note that bundled components do not have a version | ||
currently. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
namespace: Titanium.API.Application.getAvailableModules | ||
type: method | ||
description: | | ||
Return a list of all available (installed and bundled) modules | ||
for this application. This is simply the list returned by | ||
API.getInstalledModules() plus any components bundled with the | ||
application. Note that bundled components do not have a version | ||
currently. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
namespace: Titanium.API.Application.getAvailableRuntimes | ||
type: method | ||
description: | | ||
Return a list of all available (installed and bundled) runtimes | ||
for this application. This is simply the list returned by | ||
API.getInstalledModules() plus any components bundled with the | ||
application. Note that bundled components do not have a version | ||
currently. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
namespace: Titanium.API.Application.getBundledComponents | ||
type: method | ||
description: | | ||
Return a list of all bundled components for this for this application. | ||
Bundled components currently live inside the application contents directory | ||
in the following directories: | ||
<ul> | ||
<li>My App.app/Contents/modules</li> | ||
<li>My App.app/Contents/runtime</li> | ||
<li>My App.app/Contents/sdk</li> | ||
<li>My App.app/Contents/mobilesdk</li> | ||
</ul> | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.getBundledModules | ||
type: method | ||
description: Return a list of all modules bundled with this application | ||
description: | | ||
Return a list of all bundled modules for this for this application. | ||
Bundled modules currently live inside the application contents directory | ||
in the "My App.app/Contents/modules" directory. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
namespace: Titanium.API.Application.getBundledRuntimes | ||
type: method | ||
description: | | ||
Return a list of all bundled runtimes for this for this application. | ||
A bundled runtime currently live inside the application contents directory | ||
in the "My App.app/Contents/runtime" directory. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.getComponents | ||
type: method | ||
description: | | ||
Return a list of all resolved components for this for this application. | ||
Resolved components may either be installed or bundled components. | ||
Note that currently bundled components returned in this list do not have | ||
a version. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.getDataPath | ||
type: method | ||
description: | | ||
Get the path to the application's user data directory. This path is | ||
guaranteed to be writable (as opposed to the application directory | ||
which should not be written to) and is suitable for storing any | ||
application files. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
namespace: Titanium.API.Application.getDependencies | ||
type: method | ||
description: | | ||
Get a list of this application's dependencies. Dependencies | ||
are defined in the application manifest file. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Dependency> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
namespace: Titanium.API.Application.getExecutablePath | ||
type: method | ||
description: | | ||
Get the path to this application's executable. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
namespace: Titanium.API.Application.getGUID | ||
type: method | ||
description: | | ||
Get this application globally unique identifier. This is | ||
currently defined in the application manifest. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
namespace: Titanium.API.Application.getID | ||
type: method | ||
description: | | ||
Get this human readable id currently defined in both the | ||
application manifest and the application's tiapp.xml file. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
namespace: Titanium.API.Application.getManifest | ||
type: method | ||
description: | | ||
Get the contents of this application's manifest as an array | ||
of string pairs (array of size 2). Each entry in the manifest | ||
is a simple key-value pair. Comments are ignored. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<Array<String>> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
namespace: Titanium.API.Application.getManifestPath | ||
type: method | ||
description: "Get the path to this application's manifest" | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.getModules | ||
type: method | ||
description: | | ||
Return a list of all resolved modules for this for this application. | ||
Resolved components may either be installed or bundled components. | ||
Note that currently bundled components returned in this list do not have | ||
a version. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Component> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
namespace: Titanium.API.Application.getName | ||
type: method | ||
description: "Get this application's name." | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.getPID | ||
type: method | ||
description: Retrieve the process identifier of this application | ||
description: | | ||
Retrieve the process identifier of this application. If this application | ||
is not the currently running application, this method will returned | ||
<tt>undefined</tt>. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Number | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
namespace: Titanium.API.Application.getPath | ||
type: method | ||
description: | | ||
Get this application's path. Note that this is the top-level path of | ||
application, not the path to the application contents directory. On | ||
OS X currently, the application contents directory is "[app path]/Contents" | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
namespace: Titanium.API.Application.getResourcesPath | ||
type: method | ||
description: | | ||
Return the path to this application's resources directory. This directory | ||
is the 'Resources' subdirectory of the application contents directory. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.getRuntime | ||
type: method | ||
description: | | ||
Return the resolved runtime for this for this application. | ||
Resolved components may either be installed or bundled components. | ||
Note that currently bundled components returned from this method | ||
do not have a version. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: API.Component | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
namespace: Titanium.API.Application.getVersion | ||
type: method | ||
description: "Get this application's version." | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
namespace: Titanium.API.Application.hasArgument | ||
type: method | ||
description: | | ||
Determine if the given argument is in the argument list. | ||
You may either pass 'param' or '--param' and this method will | ||
find the command-line argument. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Boolean | ||
parameters: | ||
- [String, argument, The name of the argument to search for.] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
namespace: Titanium.API.Application.isCurrent | ||
type: method | ||
description: Returns whether or not this is the currently running application. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Boolean | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
namespace: Titanium.API.Application.resolveDependencies | ||
type: method | ||
description: | | ||
Attempt to resolve all the dependencies for this application. Resolved components | ||
should be accessible through API.Application.getComponents afterward. Note that | ||
the currently running applicaiton should already have all of its dependencies resolved. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: Array<API.Dependency> | ||
parameters: [] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
namespace: Titanium.API.CRITICAL | ||
type: property | ||
description: | | ||
A constant representing CRITICAL logger severity. | ||
The severity levels in order from least severe to most severe are: | ||
<ol> | ||
<li>TRACE</li> | ||
<li>DEBUG</li> | ||
<li>INFO</li> | ||
<li>NOTICE</li> | ||
<li>WARN</li> | ||
<li>ERROR</li> | ||
<li>CRITICAL</li> | ||
<li>FATAL</li> | ||
</ol> | ||
since: 0.4.0 | ||
platforms: ['osx', 'linux', 'win32'] | ||
returns: Number |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
namespace: Titanium.API.Component | ||
type: object | ||
description: | | ||
An object representing a Titanium component, which may be either a module, | ||
runtime, SDK, Mobile SDK or application update. | ||
since: 0.4.0 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
namespace: Titanium.API.Component.getName | ||
type: method | ||
description: Get the name of this component. | ||
since: 0.4.0 | ||
platforms: [osx, linux, win32] | ||
returns: String | ||
parameters: [] |
Oops, something went wrong.