IDA Commands

IDA commands are used to invoke a device action or program action by the Velocity client. These values can be specified in many of the special META tags described above, as URLs for the user to click on, or called inside JavaScript functions.

For example:

<a href="ida:IDA_SESSION_DISCONNECT">Close the session</a>

-Or-

<script language=javascript>function OnError( ){

Disconnect the Session location.href = "ida:IDA_SESSION_DISCONNECT" ;

// Alternate Method document.location = "ida:IDA_SESSION_DISCONNECT" ;

// Another Alternate Method window.navigate ( "ida:IDA_SESSION_DISCONNECT" ) ;

}</script>

It is recommended that each IDA command be preceded by the IDA prefix; however, the command will generally work without the prefix.

The following are IDA commands supported by the Velocity client:

IDA_BEEP

Causes the device to emit a standard beep (single tone).

IDA_ERROR_BEEP

Causes the device to emit an error beep (two tones).

IDA_COLDBOOT

Causes the device to perform a cold boot.

IDA_COLDBOOT_PROMPT

Gives the user the option to perform a cold boot or cancel the action.

IDA_KEYBOARD_WEB,
IDA_KEYBOARD_SHOW, or IDA_KEYBOARD_UP

Cause the on-screen keyboard to be displayed.

IDA_KEYBOARD_NUM or IDA_KEYBOARD_NUMERIC

Cause the numeric on-screen keyboard to be displayed.

IDA_KEYBOARD_NONE, IDA_KEYBOARD_HIDE, or IDA_KEYBOARD_DOWN

Cause the standard and numeric on-screen keyboards to be hidden.

IDA_PROGRAM_EXIT

Causes the device to exit the current program.

IDA_PROGRAM_EXIT_PROMPT

Prompts the user to exit the program or cancel the action.

IDA_REPRINT

Causes the last data supplied to the printer to be sent again. The print data will remain available until something else is printed or until the session is disconnected.

IDA_SESSION_S1
IDA_SESSION_S2
IDA_SESSION_S3
IDA_SESSION_S4

Cause the device to switch to the specified session.

IDA_SCAN_DISABLE or IDA_SCAN_SUSPEND

Disable the bar code scanner. When the bar code scanner is disabled, pressing the mobile device trigger will have no effect.

IDA_SCAN_ENABLE or
IDA_SCAN_RESUME

Enable the bar code scanner. The bar code scanner will not scan for bar codes unless the mobile device trigger is pulled. You can use the META tag OnStartup with an action of IDA_SCAN_ENABLE or IDA_SCAN_DISABLE to change the scanner state only when the page is first loaded.

IDA_SCAN_FORWARD

Disables the barcode scanner and processes a trigger press as a key press. This command only functions on scanners that support trigger-press forwarding; on all other scanners, the command performs the same action as IDA_SCAN_DISABLE.

IDA_SESSION_DISCONNECT

Disconnects the session and closes the Velocity client.

IDA_SESSION_DISCONNECT_PROMPT

Prompts the user to disconnect the session and close the Velocity client, or cancel the action.

IDA_SESSION_NEXT

Opens a new session.

IDA_SESSION_PREVIOUS or IDA_SESSION_PREV

Causes the device to return to the previous session.

IDA_SIP_SHOW or
IDA_SIP_UP

Cause the SIP on-screen keyboard to become visible.

IDA_SIP_HIDE or
IDA_SIP_DOWN

Cause the SIP on-screen keyboard to become hidden.

IDA_SIP_TOGGLE or
IDA_SIP_TOGGLEHIDE

Toggle the SIP on-screen keyboard between visible and hidden.

IDA_SUSPEND or
IDA_SUSPEND_DEVICE

Cause the device to suspend itself. For CE devices, this is similar to pressing the power button.

IDA_SUSPEND_PROMPT

Prompts the user to suspend the device or cancel the action.

IDA_URL_BACK or
IDA_BACK

Displays the screen previous to the current screen. If there are no previous screens, no action will be taken.

IDA_URL_BACK_DISABLE or IDA_BACK_DISABLE

Disable the Back menu option so it cannot be selected by the user. The IDA_URL_BACK or IDA_BACK commands are not affected and will still work.

IDA_URL_BACK_ENABLE or IDA_BACK_ENABLE

Enable the Back menu option so it can be selected by the user. The menu option could still be disabled if there is no page to go back to.

IDA_URL_FORWARD or IDA_FORWARD

Displays the screen that was being displayed before the last Back command. If there is no such screen, no action will be taken.

IDA_URL_FORWARD_DISABLE or
IDA_FORWARD_DISABLE

Disable the Forward menu option so it cannot be selected by the user. The IDA_URL_FORWARD or IDA_FORWARD commands are not affected and will still work.

IDA_URL_FORWARD_ENABLE or
IDA_FORWARD_ENABLE

Enable the Forward menu option so it can be selected by the user. The menu option could still be disabled if there is no page to return to.

IDA_URL_HOME or
IDA_HOME

Cause the Velocity client to proceed to the location specified by the current host profile. This location is completely independent from any other web browsers on the device.

IDA_URL_HOME_DISABLE or IDA_HOME_DISABLE

Disable the Home menu option so it cannot be selected by the user. The IDA_URL_HOME or IDA_HOME commands are not affected and will still work.

IDA_URL_HOME_ENABLE or IDA_HOME_ENABLE

Enable the Home menu option so it can be selected by the user.

IDA_URL_REFRESH or
IDA_REFRESH

Cause the web page to be reloaded. The server will be queried to verify that the page contents are up-to-date.

IDA_URL_STOP or
IDA_STOP

Cause the web page to stop loading. If the web page is already fully loaded, this action has no effect.

IDA_WARMBOOT

Causes the device to perform a warm boot.

IDA_WARMBOOT_PROMPT

Prompts the user to perform a warm boot or cancel the action.

IDA_ZOOM_DISABLE or IDA_FONT_DISABLE or IDA_ZOOM_LEVEL_DISABLE

Disable the Text Size menu so it cannot be selected by the user. The IDA options to set the zoom level (text size) are not affected and will still work.

IDA_ZOOM_ENABLE or IDA_FONT_ENABLE or
IDA_ZOOM_LEVEL_ENABLE

Enable the Text Size menu so it can be selected by the user.

IDA_ZOOM_LARGER or IDA_FONT_LARGER or
IDA_ZOOM_3 or
IDA_ZOOM_LEVEL_3 or
IDA_ZOOM_LEVEL_LARGER

Displays the text using a large text size. This setting is global and affect other browsers on the device.

IDA_ZOOM_LARGEST or IDA_FONT_LARGEST or IDA_ZOOM_4 or
IDA_ZOOM_LEVEL_4 or
IDA_ZOOM_LEVEL_LARGEST

Displays the text using the largest text size supported by the browser. This setting is global and affects other browsers on the device.

IDA_ZOOM_MEDIUM or IDA_FONT_MEDIUM or
IDA_ZOOM_2 or
IDA_ZOOM_LEVEL_2 or
IDA_ZOOM_LEVEL_MEDIUM

Displays the text using a medium text size. This setting is global and affects other browsers on the device.

IDA_ZOOM_MINUS or
IDA_FONT_MINUS or
IDA_ZOOM_LEVEL_MINUS

Displays the text using the next-smaller text size than the current text size. This setting is global and affects other browsers on the device.

IDA_ZOOM_PLUS or
IDA_FONT_PLUS or
IDA_ZOOM_LEVEL_PLUS

Displays the text using the next-larger text size than the current text size. This setting is global and affects other browsers on the device.

IDA_ZOOM_SMALLER or IDA_FONT_SMALLER or IDA_ZOOM_1 or
IDA_ZOOM_LEVEL_1 or
IDA_ZOOM_LEVEL_SMALLER

Displays the text using a small text size. This setting is global and affects other browsers on the device.

IDA_ZOOM_SMALLEST or IDA_FONT_SMALLEST or
IDA_ZOOM_0 or
IDA_ZOOM_LEVEL_0 or
IDA_ZOOM_LEVEL_SMALLEST

Displays the text using the smallest text size supported by the browser. This setting is global and affects other browsers on the device.

 

Privacy and Legal