Merge pull request #652 from cb1kenobi/master

Mobile web import and API doc updates TIMOB-5741 TIMOB-5858 TIMOB-6010 TIMOB-5995 TIMOB-6026 TIMOB-6027 TIMOB-6028

SConstruct

@@ -69,7 +69,7 @@ if clean and os.path.exists('iphone/iphone/build'):
 
 # TEMP until android is merged
 build_type = 'full'
-build_dirs = ['iphone', 'android']
+build_dirs = ['iphone', 'android', 'mobileweb']
 force_iphone = False
 
 if ARGUMENTS.get('iphone',0):
@@ -84,6 +84,10 @@ if ARGUMENTS.get('ipad',0):
 	build_type='ipad'
 	build_dirs=['ipad']
 
+if ARGUMENTS.get('mobileweb',0):
+	build_type='mobileweb'
+	build_dirs=['mobileweb']
+
 if ARGUMENTS.get('force_iphone',0):
 	force_iphone = True
 
@@ -130,6 +134,15 @@ if build_type in ['full', 'iphone', 'ipad'] and not only_package \
 	finally:
 		os.chdir(d)
 
+if build_type in ['full', 'mobileweb'] and not only_package:
+	d = os.getcwd()
+	os.chdir('mobileweb')
+	try:
+		if clean: build_type = "clean"
+		# nothing to do... yet
+	finally:
+		os.chdir(d)
+
 def install_mobilesdk(version_tag):
 	if (platform.system() == "Darwin"):
 		os_names = { "Windows":"win32", "Linux":"linux", "Darwin":"osx" }
@@ -143,13 +156,14 @@ def package_sdk(target, source, env):
 	android = build_type in ['full', 'android']
 	iphone = build_type in ['full', 'iphone']
 	ipad = build_type in ['full', 'ipad']
+	mobileweb = build_type in ['full', 'mobileweb']
 	package_all = ARGUMENTS.get('package_all', 0)
 	version_tag = ARGUMENTS.get('version_tag', version)
 	print "Packaging MobileSDK (%s)..." % version_tag
 	if package_all:
-		package.Packager().build_all_platforms(os.path.abspath('dist'), version, android, iphone, ipad, version_tag)
+		package.Packager().build_all_platforms(os.path.abspath('dist'), version, android, iphone, ipad, mobileweb, version_tag)
 	else:
-		package.Packager().build(os.path.abspath('dist'), version, android, iphone, ipad, version_tag)
+		package.Packager().build(os.path.abspath('dist'), version, android, iphone, ipad, mobileweb, version_tag)
 	if install and not clean:
 		install_mobilesdk(version_tag)
 

apidoc/Global/String/String.yml

@@ -1,6 +1,7 @@
 ---
 name: Global.String
 description: The Javascript built-in String type. The APIs here are Titanium specific extensions. TODO this is just a placeholder
+platforms: [android, iphone, ipad]
 methods:
   - name: format
   - name: formatCurrency

apidoc/Titanium/App/App.yml

@@ -6,6 +6,7 @@ since: "0.1"
 methods:
   - name: getArguments
     description: return the arguments passed to the application on startup as a dictionary
+    platforms: [android, iphone, ipad]
     returns:
         type: Object
 events:
@@ -14,6 +15,7 @@ events:
     properties:
       - name: state
         description: the proximity state value
+    platforms: [android, iphone, ipad]
   - name: resume
     description: fired when an iOS application will enter the foreground due to iOS 4's multitasking.
         This does not include pauses due to notifications or calls. See

apidoc/Titanium/BlobStream.yml

@@ -4,4 +4,4 @@ extends: Titanium.IOStream
 description: Wrapper around `Titanium.Blob` that implements the `Titanium.IOStream` interface
 since: "1.7"
 createable: false
-
+platforms: [android, iphone, ipad]

apidoc/Titanium/Buffer.yml

@@ -3,6 +3,7 @@ name: Titanium.Buffer
 description: Buffer is a container for raw data. A buffer is created by the method `Titanium.createBuffer`.
 extends: Titanium.Proxy
 since: "1.7"
+platforms: [android, iphone, ipad]
 
 properties:
   - name: length

apidoc/Titanium/BufferStream.yml

@@ -4,4 +4,4 @@ extends: Titanium.IOStream
 description: Wrapper around `Titanium.Buffer` that implements the `Titanium.IOStream` interface
 since: "1.7"
 createable: false
-
+platforms: [android, iphone, ipad]

apidoc/Titanium/Codec/Codec.yml

@@ -3,6 +3,7 @@ name: Titanium.Codec
 description: A module for converting Numbers and Strings to and from a <Titanium.Buffer>.
 extends: Titanium.Module
 since: "1.7"
+platforms: [android, iphone, ipad]
 
 properties:
   - name: CHARSET_ASCII

apidoc/Titanium/Contacts/Contacts.yml

@@ -3,6 +3,7 @@ name: Titanium.Contacts
 description: The top level Contacts module.  The Contacts module is used accessing the device Address Book.  (Read-only on Android.)
 extends: Titanium.Module
 since: "0.8"
+platforms: [android, iphone, ipad]
 methods:
   - name: createGroup
     description: create and return an instance of <a href="Titanium.Contacts.Group.html">Titanium.Contacts.Group</a>

apidoc/Titanium/Contacts/Person.yml

@@ -3,6 +3,7 @@ name: Titanium.Contacts.Person
 description: An object which represents a person in the contacts database.
 extends: Titanium.Proxy
 since: "0.8"
+platforms: [android, iphone, ipad]
 properties:
   - name: url
     description: |

apidoc/Titanium/Database/Database.yml

@@ -15,6 +15,7 @@ methods:
       - name: name
         description: the name of the database
         type: String
+    platforms: [android, iphone, ipad]
   - name: open
     description: open a database. if it doesn't yet exist, create it.
     returns:

apidoc/Titanium/Event.yml

@@ -2,6 +2,7 @@
 name: Titanium.Event
 description: The base for all events
 since: "0.1"
+platforms: [android, iphone, ipad]
 properties:
   - name: source
     description: the source object that fired the event

apidoc/Titanium/Facebook/Facebook.yml

@@ -10,6 +10,7 @@ description: |
     You must still set Ti.Facebook.appid within your app itself to use the facebook module.  This property is used only for configuring your app to interface with the facebook login process.
 extends: Titanium.Module
 since: "0.8"
+platforms: [android, iphone, ipad]
 methods:
   - name: authorize
     description: Login the user (if not already logged in) and authorize your application.  Be sure to set your desired `permissions` and your `appid` before calling this.

apidoc/Titanium/Facebook/LoginButton.yml

@@ -3,6 +3,7 @@ name: Titanium.Facebook.LoginButton
 description: The Login Button created by <Titanium.Facebook.createLoginButton>.  This is a Facebook-themed button that does not require a click event handler or any listeners.  It "just works" and changes its label to reflect the current state of the Facebook session.  For example, if the user is already logged in, this button will show "Logout".
 extends: Titanium.UI.View
 since: "0.8"
+platforms: [android, iphone, ipad]
 properties:
   - name: style
     description: set to "wide" to show a wider version of the button that displays "Connect with Facebook" instead of just "Connect".

apidoc/Titanium/Filesystem/File.yml

@@ -3,6 +3,7 @@ name: Titanium.Filesystem.File
 description: The File object which support various filesystem based operations.
 extends: Titanium.Proxy
 since: "0.1"
+platforms: [android, iphone, ipad]
 methods:
   - name: createDirectory
     description: create a directory at the path for the file object

apidoc/Titanium/Filesystem/FileStream.yml

@@ -4,6 +4,7 @@ description: Wrapper around `Titanium.Filesystem.File` that implements the `Tita
 extends: Titanium.IOStream
 since: "1.7"
 createable: false
+platforms: [android, iphone, ipad]
 methods:
   - name: close
     description: closes file stream, exception is thrown on error

apidoc/Titanium/Filesystem/Filesystem.yml

@@ -4,6 +4,7 @@ description: The top level Filesystem module.  The Filesystem module is used for
     directories on the device.
 extends: Titanium.Module
 since: "0.1"
+platforms: [android, iphone, ipad]
 methods:
   - name: createTempDirectory
     description: create temp file and return a <Titanium.Filesystem.File>

apidoc/Titanium/Geolocation/Geolocation.yml

@@ -13,12 +13,14 @@ methods:
       - name: callback
         description: function to invoke on success or failure. The event object contains the properties described as the `place` dictionary in <Titanium.Geolocation.reverseGeocoder>.
         type: Callback<Object>
+    platforms: [android, iphone, ipad]
   - name: getCurrentHeading
     description: retrieve the current compass heading.
     parameters:
       - name: callback
         description: function to invoke on success or failure of obtaining the current heading. See heading event in <Titanium.Geolocation>.
         type: Callback<Object>
+    platforms: [android, iphone, ipad]
   - name: getCurrentPosition
     description: retrieve the last known location from the device. On Android, the radios are not turned on to update the location. On iOS the radios MAY be used if the location is too "old".
     parameters:
@@ -38,9 +40,10 @@ methods:
         description: |
             function to invoke on success or failure. The event object passed contains a `places` array of zero or more place dictionaries. Each `place` dictionary contains the following properties: `street`, `street1`, `city`, `region1`, `region2`, `postalCode`, `country`, `countryCode`, `longitude`, `latitude`, `displayAddress`, `address`.
         type: Callback<Object>
+    platforms: [android, iphone, ipad]
   - name: setShowCalibration
     description: configure the calibration UI. set the false to disable the calibration display.
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
 events:
   - name: calibration
     description: fired when the device detects interface and requires calibration. when this event is fired, the calibration UI is being displayed to the end user.
@@ -58,6 +61,7 @@ events:
       - name: heading
         description: |
             heading results dictionary with the following sub-pro perties: `magneticHeading`, `trueHeading`, `accuracy`, `x`, `y`, `z`, `timestamp`.
+    platforms: [android, iphone, ipad]
   - name: location
     description: fired when a location event is received
     properties:
@@ -100,45 +104,45 @@ properties:
     description: authorization constant
     type: Number
     permission: read-only
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
   - name: AUTHORIZATION_DENIED
     description: authorization constant (user disabled authorization)
     type: Number
     permission: read-only
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
   - name: AUTHORIZATION_RESTRICTED
     description: authorization constant (system disabled authorization)
     type: Number
     permission: read-only
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
   - name: AUTHORIZATION_UNKNOWN
     description: authorization constant
     type: Number
     permission: read-only
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
   - name: ERROR_DENIED
     description: error constant
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
     type: Number
     permission: read-only
   - name: ERROR_HEADING_FAILURE
     description: error constant
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
     type: Number
     permission: read-only
   - name: ERROR_LOCATION_UNKNOWN
     description: error constant
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
     type: Number
     permission: read-only
   - name: ERROR_NETWORK
     description: error constant
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
     type: Number
     permission: read-only
   - name: ERROR_REGION_MONITORING_DELAYED
     description: error constant
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
     permission: read-only
     osver:
         ios:
@@ -148,28 +152,28 @@ properties:
     description: error constant
     type: Number
     permission: read-only
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
     osver:
         ios:
             min: "4.0"
   - name: ERROR_REGION_MONITORING_FAILURE
     description: error constant
     type: Number
     permission: read-only
-    platforms: [iphone, ipad]
+    platforms: [iphone, ipad, mobileweb]
     osver:
         ios:
             min: "4.0"
   - name: PROVIDER_GPS
     description: The GPS location provider
     type: String
     permission: read-only
-    platforms: [android]
+    platforms: [android, mobileweb]
   - name: PROVIDER_NETWORK
     description: The Network location provider
     type: String
     permission: read-only
-    platforms: [android]
+    platforms: [android, mobileweb]
   - name: distanceFilter
     description: The minimum change of position (in meters) before a 'location' event is fired. Default is 0, meaning that location events are continuously generated.
     type: Number

apidoc/Titanium/Gesture/Gesture.yml

@@ -9,16 +9,19 @@ properties:
     type: Boolean
     description: True if current window is considered portrait by the device, false otherwise
     permission: read-only
+    platforms: [android, iphone, ipad]
 
   - name: landscape
     type: Boolean
     description: True if current window is considered landscape by the device, false otherwise
     permission: read-only
+    platforms: [android, iphone, ipad]
 
   - name: orientation
     type: Number
     description: Orientation of the current window.  Value will be one of the following - <Titanium.UI.PORTRAIT>, <Titanium.UI.UPSIDE_PORTRAIT>, <Titanium.UI.LANDSCAPE_LEFT>, <Titanium.UI.LANDSCAPE_RIGHT> or <Titanium.UI.UNKNOWN>
     permission: read-only
+    platforms: [android, iphone, ipad]
 
 events:
   - name: orientationchange

apidoc/Titanium/IOStream.yml

@@ -4,6 +4,7 @@ description: IOStream is the interface that all stream types implement
 since: "1.7"
 extends: Titanium.Proxy
 createable: false
+platforms: [android, iphone, ipad]
 
 methods:
   - name: read

apidoc/Titanium/Locale/Locale.yml

@@ -3,6 +3,7 @@ name: Titanium.Locale
 description: The top level Locale module.  The Locale module works with localization files to which are generated during compilation into the operating system specific localization formats. The Locale module provides locale-specific strings which can be referenced at runtime.  Additionally, the module contains a few methods and properties for querying device locale information.
 extends: Titanium.Module
 since: "1.5"
+platforms: [android, iphone, ipad]
 methods:
   - name: formatTelephoneNumber
     description: format a telephone number according to the current locale.

apidoc/Titanium/Map/Annotation.yml

@@ -3,6 +3,7 @@ name: Titanium.Map.Annotation
 description: An Annotation object that is created by the method <Titanium.Map.createAnnotation>. This object gives you low level control over annotations that can be added to a Map View.
 extends: Titanium.Proxy
 since: "0.9"
+platforms: [android, iphone, ipad]
 properties:
   - name: animate
     description: boolean to indicate whether the pin should animate when dropped

apidoc/Titanium/Map/Map.yml

@@ -3,6 +3,7 @@ name: Titanium.Map
 description: The top level Map module.  The Map module is used for creating in-application native maps.
 extends: Titanium.Module
 since: "0.8"
+platforms: [android, iphone, ipad]
 properties:
   - name: HYBRID_TYPE
     description: Displays a satellite image of the area with road and road name information layered on top.

apidoc/Titanium/Map/MapView.yml

@@ -3,6 +3,7 @@ name: Titanium.Map.MapView
 description: The MapView is an object created by <Titanium.Map.createMapView> and is used for embedding native mapping capabilities as a view in your application.  With native maps, you can control the mapping location, the type of map, the zoom level and you can add custom annotations directly to the map.
 extends: Titanium.UI.View
 since: "0.8"
+platforms: [android, iphone, ipad]
 methods:
   - name: addAnnotation
     description: add a new annotation to the map

apidoc/Titanium/Media/AudioPlayer.yml

@@ -3,6 +3,7 @@ name: Titanium.Media.AudioPlayer
 description: The AudioPlayer object is returned by <Titanium.Media.createAudioPlayer> and is used for streaming audio to the device and low-level control of the audio playback.
 extends: Titanium.Proxy
 since: "0.9"
+platforms: [android, iphone, ipad]
 methods:
   - name: pause
     description: pause playback

apidoc/Titanium/Media/Media.yml

@@ -3,6 +3,7 @@ name: Titanium.Media
 description: The top level Media module.  The Media module is used accessing the device's media related  functionality such as playing audio or recording video.
 extends: Titanium.Module
 since: "0.1"
+platforms: [android, iphone, ipad]
 methods:
   - name: beep
     description: play a device beep notification

apidoc/Titanium/Media/Sound.yml

@@ -3,6 +3,7 @@ name: Titanium.Media.Sound
 description: The Sound object is returned by <Titanium.Media.createSound> and is useful for playing basic sounds. The Sound object loads the entire media resource in memory before playing.  If you need to support streaming, use the <Titanium.Media.createAudioPlayer> API.
 extends: Titanium.Proxy
 since: "0.8"
+platforms: [android, iphone, ipad]
 methods:
   - name: getTime
     description: return the current time position of the audio

apidoc/Titanium/Media/VideoPlayer.yml

@@ -3,6 +3,7 @@ name: Titanium.Media.VideoPlayer
 description: The VideoPlayer object is returned by <Titanium.Media.createVideoPlayer> and is useful for playing videos.
 extends: Titanium.UI.View
 since: "0.9"
+platforms: [android, iphone, ipad]
 methods:
   - name: animate
     description: animate the view