rhodes 3.1.0.beta.1 → 3.1.0.beta.2

data/doc/rhodes-api.txt

@@ -0,0 +1,150 @@
+# Rhodes API Reference
+
+This API reference contains links to all the Rhodes classes. It first lists them by function, and then alphabetically.
+
+## Application Classes
+
+The [Model Controller Class](http://docs.rhomobile.com/rhodes/application#modelviewcontroller)  contains several generated methods that perform basic CRUD on the Application Model object. The generated code is in the modelname_controller.rb file.
+
+The [AppApplication Class](http://docs.rhomobile.com/rhodes/application#appapplication-class) contains methods that coordinate the startup of a Rhodes application. You place these methods in the application.rb file.
+
+The [Application Helpers](http://docs.rhomobile.com/rhodes/application#application-helpers) are helper methods for the model view (.erb) files.
+
+The [RhoSupport Class](http://docs.rhomobile.com/rhodes/application#rhosupport-class) has methods to encode and decode URLs. 
+
+## User Interface Classes
+
+The [WebView Class](http://docs.rhomobile.com/rhodes/ui#control-webview-from-controller-actions) lets you call on the WebView directly from your model controller files.
+
+The [Application Menu methods](http://docs.rhomobile.com/rhodes/ui#application-menu) lets you change the native application menu items. You can write these methods in the application.rb file.
+
+The [user defined menu-toolbar-tabbar actions](http://docs.rhomobile.com/rhodes/ui#user-defined-menutoolbartabbar-actions) lets you perform such actions as back, forward, home, and close with user define menus, toolbars, and tabbars.
+
+The [NativeToolbar Class](http://docs.rhomobile.com/rhodes/ui#native-toolbar-control) let you create and remove toolbars at runtime.
+
+The [Navigation bar for the iPhone](http://docs.rhomobile.com/rhodes/ui#navigation-bar) supports a title, a back button, and a right button.
+
+The [DateTimePicker Class](http://docs.rhomobile.com/rhodes/ui#datetime-picker) allow the user to choose date or time.
+
+## Rhodes Configuration Properties Class
+
+The [RhoConfig Class](http://docs.rhomobile.com/rhodes/configuration#run-time-configuration) allow access to the configuration properties in rhoconfig.txt.
+
+## Device Capabilities Classes
+
+The [System Class](http://docs.rhomobile.com/rhodes/device-caps#system-class) provides access to system information.
+
+The [GeoLocation Class API](http://docs.rhomobile.com/rhodes/device-caps#geolocation) allows you to access geological information using Ruby calls in your controller.
+
+The [RhoContact Class](http://docs.rhomobile.com/rhodes/device-caps#pim-contacts) provides access to a device's phone book and contacts.
+
+The [RhoEvent Class](http://docs.rhomobile.com/rhodes/device-caps#pim-calendarevents) provides access to a device's calendar and events.
+
+The [Camera Class](http://docs.rhomobile.com/rhodes/device-caps#camera) lets you take a picture and choose a picture from an album.
+
+The [Barcode Class](http://docs.rhomobile.com/rhodes/device-caps#barcode) allows the device to recognize a barcode.
+
+The [SignatureTool Class](http://docs.rhomobile.com/rhodes/device-caps#signature-capture) allows the device to take a signature and save it as an image with the method take_signature.
+
+The [BluetoothManager Class](http://docs.rhomobile.com/rhodes/device-caps#bluetooth) makes a connection between your Bluetooth-equipped device and another Bluetooth-equipped device.
+
+The [BluetoothSession Class](http://docs.rhomobile.com/rhodes/device-caps#bluetooth) controls the session between your Bluetooth-equipped device and another Bluetooth-equipped device.
+
+The [NFC Classes Class](http://docs.rhomobile.com/rhodes/nfc) provides access to Near Field Communication functionality, which is currently only supported on Android.
+
+ZZZ Filled in
+The [RingtoneManager Class](http://docs.rhomobile.com/rhodes/device-caps#ringtone-manager) allows you to view and play a device's ringtones.
+
+ZZZZ Filled in
+The [Alert Class](alert-api) lets you call system alert methods for popup, vibrate, or playing audio files.
+
+ZZZZ Filled in
+The [Timer Class](timer-api) lets the device use a timer.
+
+The [MapView Class](http://docs.rhomobile.com/rhodes/device-caps#mapview) provides an embeddable map interface with the create method and various settings and annotations depending on the map provider (such as Google).
+
+The [File Class](http://docs.rhomobile.com/rhodes/device-caps#file-system-access) allows access to the Rhodes file structure.
+
+## Rhom and Database Classes
+
+The [Rhom Class](http://docs.rhomobile.com/rhodes/rhom#rhom-api) allows access to the Rhodes mini database object mapper, performing database operation on Rho model objects.
+
+The [RhomSource Class](http://docs.rhomobile.com/rhodes/rhom#accessing-sync-info-with-rhomsource) exposes sync information, which you can use for alerts, status pages, and so on.
+
+The [Rhom database functions](http://docs.rhomobile.com/rhodes/rhom#resetting-the-database) allow you to reset the Rhom database.
+
+## SyncEngine Class - Sync the Rhodes Model with the RhoSync Server
+
+The [SyncEngine Class](http://docs.rhomobile.com/rhodes/synchronization#syncengine-api) allows you to synchronize data for the Rhodes model and handle updates between the Rhodes application and the RhoSync server.
+
+## Logging, Testing, Error Classes
+
+The logging Ruby class, RhoLog, has the methods info and error which take 2 strings and writes them to the rholog.txt file. The first string is the category, the second string is the message.
+
+The [RhoError Class](http://docs.rhomobile.com/rhodes/test-log-debug#logging) accesses error messages.
+
+## Alphabetical List Of Classes and Function Types
+
+The [Alert Class](http://docs.rhomobile.com/rhodes/device-caps#alerts) lets you call system alert methods for popup, vibrate, or playing audio files.
+
+The [AppApplication Class](http://docs.rhomobile.com/rhodes/application#appapplication-class) contains methods that coordinate the startup of a Rhodes application. You place these methods in the application.rb file.
+
+The [Application Helpers](http://docs.rhomobile.com/rhodes/application#application-helpers) are helper methods for the model view (.erb) files.
+
+The [Barcode Class](http://docs.rhomobile.com/rhodes/device-caps#barcode) allows the device to recognize a barcode.
+
+The [BluetoothManager Class](http://docs.rhomobile.com/rhodes/device-caps#bluetooth) makes a connection between your Bluetooth-equipped device and another Bluetooth-equipped device.
+
+The [BluetoothSession Class](http://docs.rhomobile.com/rhodes/device-caps#bluetooth) controls the session between your Bluetooth-equipped device and another Bluetooth-equipped device.
+
+The [Camera Class](http://docs.rhomobile.com/rhodes/device-caps#camera) lets you take a picture and choose a picture from an album.
+
+The [DateTimePicker Class](http://docs.rhomobile.com/rhodes/ui#datetime-picker) allow the user to choose date or time.
+
+The [File Class](http://docs.rhomobile.com/rhodes/device-caps#file-system-access) allows access to the Rhodes file structure.
+
+The [GeoLocation Class API](http://docs.rhomobile.com/rhodes/device-caps#geolocation) allows you to access geological information using Ruby calls in your controller.
+
+The [MapView Class](http://docs.rhomobile.com/rhodes/device-caps#mapview) provides an embeddable map interface with the create method and various settings and annotations depending on the map provider (such as Google).
+
+The [Model Controller Class](http://docs.rhomobile.com/rhodes/application#modelviewcontroller)  contains several generated methods that perform basic CRUD on the Application Model object. The generated code is in the modelname_controller.rb file.
+
+The [Menu methods for Applications](http://docs.rhomobile.com/rhodes/ui#application-menu) lets you change the native application menu items. You can write these methods in the application.rb file.
+
+The [menu-toolbar-tabbar user defined actions](http://docs.rhomobile.com/rhodes/ui#user-defined-menutoolbartabbar-actions) lets you perform such actions as back, forward, home, and close with user define menus, toolbars, and tabbars.
+
+The [NativeToolbar Class](http://docs.rhomobile.com/rhodes/ui#native-toolbar-control) let you create and remove toolbars at runtime.
+
+The [NFC Classes Class](http://docs.rhomobile.com/rhodes/nfc) provides access to Near Field Communication functionality, which is currently only supported on Android.
+
+The [Navigation bar for the iPhone](http://docs.rhomobile.com/rhodes/ui#navigation-bar) supports a title, a back button, and a right button.
+
+The [RhoConfig Class](http://docs.rhomobile.com/rhodes/configuration#run-time-configuration) allow access to the configuration properties in rhoconfig.txt.
+
+The [RhoContact Class](http://docs.rhomobile.com/rhodes/device-caps#pim-contacts) provides access to a device's phone book and contacts.
+
+The [RhoError Class](http://docs.rhomobile.com/rhodes/test-log-debug#logging) accesses error messages.
+
+The [RhoEvent Class](http://docs.rhomobile.com/rhodes/device-caps#pim-calendarevents) provides access to a device's calendar and events.
+
+The logging Ruby class, RhoLog, has the methods info and error which take 2 strings and writes them to the rholog.txt file. The first string is the category, the second string is the message.
+
+The [Rhom Class](http://docs.rhomobile.com/rhodes/rhom#rhom-api) allows access to the Rhodes mini database object mapper, performing database operation on Rho model objects.
+
+The [Rhom database functions](http://docs.rhomobile.com/rhodes/rhom#resetting-the-database) allow you to reset the Rhom database.
+
+The [RhomSource Class](http://docs.rhomobile.com/rhodes/rhom#accessing-sync-info-with-rhomsource) exposes sync information, which you can use for alerts, status pages, and so on.
+
+The [RhoSupport Class](http://docs.rhomobile.com/rhodes/application#rhosupport-class) has methods to encode and decode URLs. 
+
+The [RingtoneManager Class](http://docs.rhomobile.com/rhodes/device-caps#ringtone-manager) allows you to view and play a device's ringtones.
+
+The [SignatureTool Class](http://docs.rhomobile.com/rhodes/device-caps#signature-capture) allows the device to take a signature and save it as an image with the method take_signature.
+
+he [SyncEngine Class](http://docs.rhomobile.com/rhodes/synchronization#syncengine-api) allows you to synchronize data for the Rhodes model and handle updates between the Rhodes application and the RhoSync server.
+
+The [System Class](http://docs.rhomobile.com/rhodes/device-caps#system-class) provides access to system information.
+
+The [Timer Class](http://docs.rhomobile.com/rhodes/device-caps#timer) lets the device use a timer.
+
+The [WebView Class](http://docs.rhomobile.com/rhodes/ui#control-webview-from-controller-actions) lets you call on the WebView directly from your model controller files.

data/doc/rhodes-api/alert-api.txt

@@ -0,0 +1,102 @@
+# Alert API - Popup, Vibrate, Play for System Alerts
+
+The [Alert Class API](http://docs.rhomobile.com/rhodes/device-caps#alerts) lets you call system alert methods for popup, vibrate, or playing audio files.
+
+## Alert.show_popup "message"
+
+Alert.show_popup( { :message, :title, :icon, :buttons, :callback } )
+
+Bring the application up front and show a popup message.
+
+### Returns
+
+Nil.
+
+### Parameters
+
+:message – text to be displayed in popup window
+:title – title of the popup window
+:icon – image to be displayed in popup window. Its value can be one of the following predefined values, or a path to an image file.
+ * :alert – ‘!’ icon
+ * :question – ‘?’ icon
+ * :info – informational icon
+:buttons – array of buttons for popup window. Each button defined by its id and title. Button can be specified by Hash with :id and :title keys or just String – in this case both id and title will be set to this value.
+:callback – url to be called when any of the button will be clicked. This callback will be called with @params hash containing three keys: :button_id, :button_title and :button_index.
+
+#### Example
+
+	:::ruby
+	Alert.show_popup( {
+    	  :message => 'Some message', 
+	  :title => 'Custom title', 
+	  :icon => '/public/images/icon.png',
+	  :buttons => ["Yes", "No", 
+	    {:id => 'cancel', :title => 'Cancel all'}],
+	    :callback => url_for(:action => :on_dissmiss_popup) } )
+
+### Alert.hide_popup
+
+Closes the current popup window.
+
+### Returns
+
+None.
+
+## Alert.vibrate(duration_in_milliseconds)
+
+Vibrate the device.
+
+### Returns
+
+None.
+
+### Parameters
+
+duration_in_milliseconds - vibrate for the specified number of milliseconds, up to 25500; if 0 or no duration is specified, it will vibrate for 2500 millisecond.
+
+### Example
+
+	:::ruby
+	Alert.vibrate(2000)
+
+## Alert.play_file(file_name.ext, media_type)
+
+Play the specified file if the media type is supported by the phone. The file should be included in the application. For example, if file is in public folder, file name will be /apps/public/test-file.mp3. 
+
+### Returns
+
+None.
+
+### Parameters
+
+file_name.ext - The path to the file name, ending in the file name and extension.
+
+media_type - Media type can be specified explicitly, or can be recognized from the file extension. Known file extensions are:
+ * .mp3 – audio/mpeg
+ * .wav – audio/x-wav
+
+## Alert.show_status(title, status_text, hide_button_label)
+
+Show status messages. The status window will close after clicking on hide button.
+
+### Returns
+
+None.
+
+### Parameters
+
+status_text – text to be displayed in status window
+hide_button_label – label of hide button
+
+### Example
+
+	:::ruby
+	def sync_notify
+	  status = @params['status'] ? @params['status'] : ""
+	  Alert.show_status( 
+	    "Status", 
+	    "#{@params['source_name']} : #{status}", 
+	    Rho::RhoMessages.get_message('hide'))
+	end
+
+

data/doc/rhodes-api/ringtonemanager-api.txt

@@ -0,0 +1,50 @@
+# RingtoneManager API - View and Play Ringtones
+
+The [RingtoneManager Class allows you to view and play a device's ringtones.
+
+## RingtoneManager.get_all_ringtones
+
+Get all ringtones on the device.
+
+### Returns
+
+A hash containing key/value pairs, where the key is the user-friendly name of ringtone, and the value is its full file name.
+
+### Parameters
+
+None.
+
+### Example
+
+	:::ruby
+	@ringtones = RingtoneManager::get_all_ringtones
+
+## RingtoneManager.play @ringtones['my_ringtone']
+
+Play a ringtone.
+
+### Returns
+
+None.
+
+### Parameters
+
+The ringtone to play from the hash.
+
+## RingtoneManager.stop
+
+Stop playing a ringtone. Can safely be called even if no ringtone is playing.
+
+Currently implemented for Android, Blackberry and Windows mobile. On Blackberry, only the user installed ringtones are accessible. System preinstalled ringtones are not accessible due to Blackberry limitations.
+
+### Returns
+
+None.
+
+### Parameters
+
+None.
+
+
+
+

data/doc/rhodes-api/timer-api.txt

@@ -0,0 +1,39 @@
+# Timer API - Use a Timer
+
+The [Timer Class API](http://docs.rhomobile.com/rhodes/device-caps#timer) lets the device use a timer.
+
+## Timer.start(interval_milliseconds, callback_url, callback_data)
+
+Start the timer and call the callback when the timer has run.
+
+### Returns
+
+None.
+
+### Parameters
+
+interval_milliseconds - Duration of timer in milliseconds.
+callback_url - callback to call at end of timer duration.
+callback_data - data for callback.
+
+### Example
+
+	:::ruby
+	Rho::Timer.start(5000, (url_for :action => :timer_callback), "test")
+
+## stop(callback_url)
+
+Stop the timer by callback.
+
+### Returns
+
+None.
+
+### Parameters
+
+callback_url - the callback_url for this timer; stopped by this method.
+
+
+
+
+

data/rhodes.gemspec

@@ -3,7 +3,7 @@ require "lib/rhodes.rb"
 
 Gem::Specification.new do |s|
   s.name = %q{rhodes}
-  s.version = "3.1.0.beta.1"
+  s.version = "3.1.0.beta.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rhomobile"]

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: rhodes
 version: !ruby/object:Gem::Version 
-  hash: 62196433
+  hash: 62196439
   prerelease: 6
   segments: 
   - 3
   - 1
   - 0
   - beta
-  - 1
-  version: 3.1.0.beta.1
+  - 2
+  version: 3.1.0.beta.2
 platform: ruby
 authors: 
 - Rhomobile
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-05 00:00:00 -07:00
+date: 2011-08-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -162,6 +162,10 @@ files:
 - doc/linea.txt
 - doc/nfc.txt
 - doc/release.txt
+- doc/rhodes-api/alert-api.txt
+- doc/rhodes-api/ringtonemanager-api.txt
+- doc/rhodes-api/timer-api.txt
+- doc/rhodes-api.txt
 - doc/rhom.txt
 - doc/simulator.txt
 - doc/standard-css.txt
@@ -1020,6 +1024,7 @@ files:
 - lib/test/rho_stubs.rb
 - lib/test/syncdb.sqlite
 - LICENSE
+- Manifest.txt
 - platform/android/build/android.rake
 - platform/android/build/android_tools.rb
 - platform/android/build/androidcommon.rb