RubyGems - rhodes - Versions diffs - 3.3.5 → 3.4.2 - Mend

rhodes 3.3.5 → 3.4.2

Files changed (1678) hide show

@@ -1,51 +0,0 @@
-# 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.hide_popup
-Closes the current popup window.
-## Alert.play_file(file_name.ext, media_type)
-Play the file if the media type is supported by the phone. The file must in the application; for example, /apps/public/test-file.mp3.
-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_popup( { :message, :title, :icon, :buttons, :callback } )
-Bring the application up front and show a popup message.
-:message – text displayed in the popup window.
-:title – title of the popup window.
-:icon – path to an image, or :alert for ! icon, :question for ? icon, :info for information icon.
-:buttons – array of buttons defined by id and title. Specify either by hash with :id and :title keys, or by string.
-:callback – url called when button is clicked. @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.vibrate(duration_in_milliseconds)
-Vibrate the device.
-`duration_in_milliseconds` - vibrate for the number of milliseconds, up to 25500; if 0 or no duration is specified, vibrate for 2500 milliseconds.
-## Alert.show_status(title, status_text, hide_button_label)
-Show status messages. The status window will close after clicking on hide button.
-status_text – text displayed in status window
-hide_button_label – label of hide button

data/doc/files.txt DELETED

	@@ -1,4 +0,0 @@
1	- # Optional Files
2	-
3	-
4	-

data/doc/rhodes-api.txt DELETED

@@ -1,147 +0,0 @@
-# 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](/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](/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](/rhodes/application#application-helpers) are helper methods for the model view (.erb) files.
-The [RhoSupport Class](/rhodes/application#rhosupport-class) has methods to encode and decode URLs.
-## User Interface Classes
-The [WebView Class](/rhodes/ui#control-webview-from-controller-actions) lets you call on the WebView directly from your model controller files.
-The [Application Menu methods](/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](/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](/rhodes/ui#native-toolbar-control) let you create and remove toolbars at runtime.
-The [Navigation bar for the iPhone](/rhodes/ui#navigation-bar) supports a title, a back button, and a right button.
-The [DateTimePicker Class](/rhodes/ui#datetime-picker) allow the user to choose date or time.
-## Rhodes Configuration Properties Class
-The [RhoConfig Class](/rhodes/configuration#run-time-configuration) allow access to the configuration properties in rhoconfig.txt.
-## Device Capabilities Classes
-The [System Class](/rhodes/device-caps#system-class) provides access to system information.
-The [GeoLocation Class](/rhodes/device-caps#geolocation) allows you to access geological information using Ruby calls in your controller.
-The [RhoContact Class](/rhodes/device-caps#pim-contacts) provides access to a device's phone book and contacts.
-The [RhoEvent Class](/rhodes/device-caps#pim-calendarevents) provides access to a device's calendar and events.
-The [Camera Class](/rhodes/device-caps#camera) lets you take a picture and choose a picture from an album.
-The [Barcode Class](/rhodes/device-caps#barcode) allows the device to recognize a barcode.
-The [SignatureTool Class](/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](/rhodes/device-caps#bluetooth) makes a connection between your Bluetooth-equipped device and another Bluetooth-equipped device.
-The [BluetoothSession Class](/rhodes/device-caps#bluetooth) controls the session between your Bluetooth-equipped device and another Bluetooth-equipped device.
-The [NFC Classes](/rhodes/nfc) provide access to Near Field Communication functionality, which is currently only supported on Android.
-The [RingtoneManager Class](/rhodes/ringtonemanager-api) allows you to view and play a device's ringtones.
-The [Alert Class](/rhodes/alert-api) lets you call system alert methods for popup, vibrate, or playing audio files.
-The [Timer Class](/rhodes/timer-api) lets the device use a timer.
-The [MapView Class](/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](/rhodes/device-caps#file-system-access) allows access to the Rhodes file structure.
-## Rhom and Database Classes
-The [Rhom Class](/rhodes/rhom#rhom-api) allows access to the Rhodes mini database object mapper, performing database operation on Rho model objects.
-The [RhomSource Class](/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](/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](/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](/rhodes/test-log-debug#logging) accesses error messages.
-## Alphabetical List Of Classes and Function Types
-The [Alert Class](/rhodes/device-caps#alerts) lets you call system alert methods for popup, vibrate, or playing audio files.
-The [AppApplication Class](/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](/rhodes/application#application-helpers) are helper methods for the model view (.erb) files.
-The [Barcode Class](/rhodes/device-caps#barcode) allows the device to recognize a barcode.
-The [BluetoothManager Class](/rhodes/device-caps#bluetooth) makes a connection between your Bluetooth-equipped device and another Bluetooth-equipped device.
-The [BluetoothSession Class](/rhodes/device-caps#bluetooth) controls the session between your Bluetooth-equipped device and another Bluetooth-equipped device.
-The [Camera Class](/rhodes/device-caps#camera) lets you take a picture and choose a picture from an album.
-The [DateTimePicker Class](/rhodes/ui#datetime-picker) allow the user to choose date or time.
-The [File Class](/rhodes/device-caps#file-system-access) allows access to the Rhodes file structure.
-The [GeoLocation Class](/rhodes/device-caps#geolocation) allows you to access geological information using Ruby calls in your controller.
-The [MapView Class](/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](/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](/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](/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](/rhodes/ui#native-toolbar-control) let you create and remove toolbars at runtime.
-The [NFC Classes](/rhodes/nfc) provide access to Near Field Communication functionality, which is currently only supported on Android.
-The [Navigation bar for the iPhone](/rhodes/ui#navigation-bar) supports a title, a back button, and a right button.
-The [RhoConfig Class](/rhodes/configuration#run-time-configuration) allow access to the configuration properties in rhoconfig.txt.
-The [RhoContact Class](/rhodes/device-caps#pim-contacts) provides access to a device's phone book and contacts.
-The [RhoError Class](/rhodes/test-log-debug#logging) accesses error messages.
-The [RhoEvent Class](/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](/rhodes/rhom#rhom-api) allows access to the Rhodes mini database object mapper, performing database operation on Rho model objects.
-The [Rhom database functions](/rhodes/rhom#resetting-the-database) allow you to reset the Rhom database.
-The [RhomSource Class](/rhodes/rhom#accessing-sync-info-with-rhomsource) exposes sync information, which you can use for alerts, status pages, and so on.
-The [RhoSupport Class](/rhodes/application#rhosupport-class) has methods to encode and decode URLs.
-The [RingtoneManager Class](/rhodes/device-caps#ringtone-manager) allows you to view and play a device's ringtones.
-The [SignatureTool Class](/rhodes/device-caps#signature-capture) allows the device to take a signature and save it as an image with the method take_signature.
-The [SyncEngine Class](/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](/rhodes/device-caps#system-class) provides access to system information.
-The [Timer Class](/rhodes/device-caps#timer) lets the device use a timer.
-The [WebView Class](/rhodes/ui#control-webview-from-controller-actions) lets you call on the WebView directly from your model controller files.

data/doc/scanner.txt DELETED

@@ -1,507 +0,0 @@
-# Scanner API - Use a Scanner
-The [Scanner Class API](http://docs.rhomobile.com/rhodes/scanner) provides access to control the functionality of the device's scanner.
-## Scanner.enumerate(callback_url)
-Returns into callback a list of scanners present on the device
-### Parameters
-callback_url - callback to call
-## Scanner.enable
-Enables the default scanner if no scanner is currently enabled
-## Scanner.disable
-Disables the currently enabled scanner. This reverts the scanner to its default state
-and flushes any current decoder settings
-## Scanner.setProperties(params)
-Sets multiple properties
-### Parameters
-params - hash array of properties and values
-[list of possible properties which can be set](http://docs.rhomobile.com/rhodes/scanner#propereties)
-## Scanner.setPropertyByName(name, val)
-Sets property by name
-### Parameters
-name - property's name
-val - property's value
-[list of possible properties which can be set](http://docs.rhomobile.com/rhodes/scanner#propereties)
-## Scanner.start(callback_url)
-Performs a soft trigger start
-### Returns(into callback)
-data - The data decoded by the scanner or imaging device
-source - The source device and human readable decoder type of the decoded barcode or symbol
-type - Hex value representing the decoder type
-time - The time at which the decode occurred (hh:mm:ss)
-length - The length of the decoded barcode or symbol
-event - The type of event which has occurred at the scanner.
-This field will be either 'Decode' for barcode scanning or a message from a Bluetooth scanner.
-### Parameters
-callback_url - callback to call
-## Scanner.stop
-Performs a soft trigger stop
-## Propereties
-Items listed in this section indicate parameters, or attributes which can be set.
-####enabled
-Enables the specified scanner.
-Possible Values:ID of Scanner, obtained via EnumScanner.
-Default: SCN1
-####Decoder Name
-Sets each Decoders' parameters. Refer to the "Decoders" Section of this help file to know available
-decoders and Their Parameters.
-Possible Values:Decoder Property.
-Default: Refer to the "Decoders" Section
-####autoEnter
-If "enabled" then automatically append an Enter to the end of any barcodes scanned.
-This feature is only available when a decodeEvent is not specified and is useful for submitting forms.
-Possible Values:'enabled' / 'disabled'.
-Default: 'Disabled'
-####autoTab
-If "enabled" then automatically appends a Tab to the end of any barcodes scanned.
-This feature is only available when a decodeEvent is not specified and is useful for advancing to the next
-input field.
-Possible Values:'enabled' / 'disabled'.
-Default: Disabled
-####linearSecurityLevel
-Describes the linear security level used during decoding.
-Possible values:
-redundancyAndLength:
-  Two times redundancy based on redundancy flags and code length.
-shortOrCodabar:
-  Two times redundancy if short barcode or Codabar.
-longAndShort:
-  Two times redundancy for long barcodes, three times for short barcodes.
-allTwice:
-  Two times redundancy for all barcodes.
-allThrice:
-  Three times redundancy for all barcodes.
-Applicable scanner types: Laser and Imager
-Default: Device specific
-####scanTimeout
-Maximum time in milliseconds that laser scanners will emit a beam or imager scanners will enable the imager. A value of 0 indicates an infinite timeout. This parameter is compatibile with aimType:trigger, aimType:timedHold, aimType:timedRelease and aimType:pressAndRelease
-Possible Values:milliseconds
-Applicable scanner types: Laser and Imager
-Default: 5000
-####rasterMode
-Describes the type of vertical rastering to use.
-Possible Values:
-none:
-  No vertical rastering.
-openAlways:
-  Vertical rastering is always full open.  To adjust the rastering height use the rasterHeight property.
-smart:
-  Vertical rastering mode is 'Smart'.
-cyclone:
-  Vertical rastering mode is 'Cyclone'.
-Applicable scanner types: Laser Only
-Default: Device specific
-####rasterHeight
-Vertical rastering height to use, as a percentage, when rasterMode:openAlways is applied.
-Possible Values:0 - 100
-Applicable scanner types: Laser Only
-Default: Device specific
-####aimType
-Describes the type of aiming to use.
-Possible values:
-trigger:
-  Standard trigger mode.  Holding the trigger will start a decoding session.
-  The decoding session ends when a barcode is decoded, scanTimeout occurs or the trigger is released.
-timedHold:
-  Aiming lasts for the time specified by 'timedAimDuration' before decoding.
-  The decode will last until the barcode is decoded or scanTimeout occurs.
-timedRelease:
-  Aiming lasts until trigger is released.
-  If the timedAimDuration has expired when the trigger is released then a decode session is started
-  until a barcode is decoded or for the remaining time equal to the scanTimeout value.
-presentation:
-  Only applicable to Kiosk devices, the scanner illuminates when movement is detected
-  in the range of the scanner window.  The scanner must be initiated with a softscan
-  using the scanner.start() method.
-pressAndRelease:
-  Scan will continue after the trigger is released until scanTimeout occurs.
-continuousRead:
-  Once the trigger is pulled barcodes will continue to be scanned whilst the trigger
-  is held, enabling rapid scanning, to be used in conjunction with sameSymbolTimeout
-  and differentSymbolTimeout.  This value is ignored if viewfinderMode is set to
-  'dynamicReticle'
-Applicable scanner types: Laser and Imager
-Default: Device specific
-####timedAimDuration
-Duration in milliseconds for aimType:timedHold and aimType:timedRelease
-Possible Values:milliseconds
-Applicable scanner types: Laser and Imager
-Default: Device specific
-####sameSymbolTimeout
-When the aimType:continuousRead property is applied this value defines the interval between which the same barcode can be decoded twice. The value is specified in milliseconds, use 0 to indicate no interval between successive reads. Use this value to prevent accidental duplicate scans.
-Possible Values:milliseconds
-Applicable scanner types: Laser and Imager
-Default: 2500
-differentSymbolTimeout:[Value]  When the aimType:continuousRead property is applied this value defines the interval between which different barcodes can be scanned. The value is specified in milliseconds, use 0 to indicate no interval between successive reads. Use this setting to allow time for the operator to reaim the device between successive scans.
-Possible Values:milliseconds
-Applicable scanner types: Laser and Imager
-Default: 500
-####aimMode
-Describes the aiming mode to used.
-Possible values:
-none:
-  No Aiming (Can be overridden by picklistMode).
-dot:
-  Laser barcode readers will show a dot for aiming.
-slab:
-  Laser barcode readers will show a slab for aiming.
-reticle:
-  Imager barcode readers will show a reticle for aiming
-Applicable scanner types: Laser and Imager
-Default: Device specific
-####picklistMode
-Allows the imager to decode only the barcode that is directly under the cross-hair / center of the reticle. This feature is most useful in applications where multiple barcodes may appear in the field of view during a decode session and only one of them is targeted for decode. When enabled picklistMode will override aimMode if no aiming is chosen and use aimMode:reticle. This mode will also interact with viewfinderMode, see the EMDK for C help file for more information. Enabling picklist mode may adversely affect overall decoding performance.
-Possible values:
-disabled:
-  Disables picklist mode so any barcode within the field of view can be decoded.
-hardwareReticle:
-  Enables picklist mode so that only the barcode under the projected reticle can
-  be decoded.  If the imager does not support a projected reticle then the
-  behaviour is the same as softwareReticle.
-softwareReticle:
-  Enables picklist mode so that only the barcode in the center of the image is
-  decoded.  This is most useful when used in conjunction with static and
-  dynamic reticle viewfinder modes.
-Applicable scanner types: Imager Only
-Default: Device specific
-####viewfinderMode
-Configures the mode of the scanner viewfinder window. This attribute is not supported on all Scanners
-and will interact with the picklistMode parameter, see the EMDK for C help file for more information.
-Possible values:
-enabled:
-  Only the viewfinder is enabled (not the reticle).  Displays a viewfinder on the
-  screen showing the image being captured by the camera.
-disabled:
-  The viewfinder will not be displayed during aiming or scanning.
-staticReticle:
-  Displays the viewfinder as well as draws a red reticle in the center of the image
-  which helps with tracking the barcode.
-dynamicReticle:
-  Displays the viewfinder as well as draws a red reticle in the center of the image.
-  If the barcode in the image is 'decodable' the reticle turns green to indicate
-  this.  This mode requires a second trigger press to decode the barcode after the
-  reticle turns green.
-Applicable scanner types: Imager Only
-Default: Device specific
-####viewfinderX
-When scanning a barcode using an imager scanner the viewfinder preview window will appear this number of pixels from the left hand side of the screen. The images displayed in the viewfinder will be scaled as appropriate.
-Possible Values:pixels
-Applicable scanner types: Imager Only
-Default: Device specific
-####viewfinderY
-When scanning a barcode using an imager scanner the viewfinder preview window will appear this number
-of pixels from the top of the screen. The images displayed in the viewfinder will be scaled as appropriate.
-Possible Values:pixels
-Applicable scanner types: Imager Only
-Default: Device specific
-####viewfinderWidth
-When scanning a barcode using an imager scanner the viewfinder preview window will be this number of pixels wide. The images displayed in the viewfinder will be scaled as appropriate.
-Possible Values:pixels
-Applicable scanner types: Imager Only
-Default: Device specific
-####viewfinderHeight
-When scanning a barcode using an imager scanner the viewfinder preview window will be this number of pixels high. The images displayed in the viewfinder will be scaled as appropriate.
-Possible Values:pixels
-Applicable scanner types: Imager Only
-Default: Device specific
-####viewfinderFeedback
-Configures the feedback given after a successful scan in milliseconds. This value is ignored if aimType is set to continuousRead and no feedback will be given.
-Possible values:
-disabled:
-  No feedback is given after a successful decode.
-enabled:
-  The last image that was successfully decoded is displayed.  The time for which
-  the image is displayed can be configured by the viewfinderFeedbackTime parameter.
-reticle:
-  The last image that was successfully decoded is displayed along with a red reticle
-  in the center of the image.  The time for which the image is displayed can be
-  configured by the viewfinderFeedbackTime parameter.
-Applicable scanner types: Imager Only
-Default: Device specific
-####viewfinderFeedbackTime
-If the viewfinderFeedback:enabled or viewfinderFeedback:reticle are applied then the decoded barcode will remain on the screen for this duration.
-Possible Values:milliseconds
-Applicable scanner types: Imager Only
-Default: Device specific
-####focusMode
-Sets the focus mode in use.
-Possible values:
-fixed:
-  Use fixed focus.
-auto:
-  Use auto focus.
-Applicable scanner types: Imager Only
-Default: Device specific
-####illuminationMode
-Selects the illumination mode to use.
-Possible values:
-auto:
-  Auto-exposure algorithms will decide whether illumination is required or not.
-alwaysOn:
-  External illumination is always on.
-alwaysOff:
-  External illumination is always off.
-Applicable scanner types: Imager Only
-Default: Device specific
-####dpmMode
-Allows Direct Part Marking (DPM) barcodes to be read when true but may adversely affect overall decoding performance. DPM is a way of stamping barcodes directly on physical objects and is only available on DPM terminals.
-Possible Values:true / false
-Applicable scanner types: Imager Only
-Default: Device specific
-####inverse1dMode
-Allows the user to select inverse 1D barcodes for decoding.
-Possible values:
-enabled:
-  Inverse 1D symbology decoding is enabled.
-disabled:
-  Inverse 1D symbology decoding is disabled.
-auto:
-  Allows decoding of both positive and inverse 1D symbologies
-Applicable scanner types: Imager Only
-Default: Device specific
-####poorQuality1dMode
-Allows poor quality 1D barcodes to be read when true but this will adversely affect the overall decoding performance.
-Possible Values:true / false
-Applicable scanner types: Imager Only
-Default: Device specific
-####narrowBeam
-Enables or disables narrow beam width.
-Possible Values:true / false
-Applicable scanner types: Laser Only
-Default: Device specific
-####dbpMode
-Describes the type of Digital Bar Pulse (DBP) being produced by the scan engine.
-Possible values:
-normal:
-  Tells the engine to produce normal DBP.
-composite:
-  Tells the engine to produce composite DBP, which is 2 different sets of DBP data
-  multiplexed together for better decode performance.  In order to enable this mode
-  it must be supported by the scanner.
-Applicable scanner types: Laser Only
-Default: Device specific
-####klasseEins
-Enables or disables the Klasse Eins laser on time function.
-Possible Values:true / false
-Applicable scanner types: Laser Only
-Default: Device specific
-####adaptiveScanning
-Enables or disables adaptive scanning. When set to true, the scan engine will automatically toggle between 2 scan angles, wide and narrow, allowing the scan engine to decode barcodes both in close proximity and far away (~100 inches). Adaptive scanning is only supported in high performance, long working range scan engines such as SE960.
-Possible Values:true / false
-Applicable scanner types: Laser Only
-Default: Device specific
-####bidirectionalRedundancy
-Enables or disables bidirectional redundancy.
-Possible Values:true / false
-Applicable scanner types: Laser Only
-Default: Device specific
-####connectionIdleTimeout
-Specifies the time, in seconds, that an external scanner will be allowed to remain idle before the connection is terminated to conserve power.
-Possible Values:seconds
-Applicable scanner types: Bluetooth Only
-Default: Device specific
-####disconnectBtOnDisable
-Forces the scanner to disconnect from the terminal when it is 'disabled'. Since the scanner is disabled when you navigate to a new page, set this value to false if you want to maintain the bluetooth connection to your remote scanner.
-Possible Values:true / false
-Applicable scanner types: Bluetooth Only
-Default: false