ApiDialog Class Reference

Classes
class	DialogId

Static Public Member Functions
static int	showMessage (String message, int buttons, boolean waitForFeedback, int maxTime) throws GeneralException
	Shows dialog window with a message. More...
static void	flashMessage (String message, int maxTime) throws GeneralException
	Shows flash message. More...
static void	closeDialogs (int maxTime) throws GeneralException
	Closes all open dialogs (typically menu). More...
static void	showDialog (int dialogId, int maxTime) throws GeneralException
	Shows the specified menu dialog given by the identifier. More...

Member Function Documentation

closeDialogs()

static void closeDialogs ( int  maxTime ) throws GeneralException

static

Closes all open dialogs (typically menu).

After the call navigation returns to the map view.

Parameters

maxTime

Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

References Api.getInstance(), and Api.getService().

flashMessage()

static void flashMessage ( String  message, int  maxTime  ) throws GeneralException

static

Shows flash message.

Parameters

message	Text of the message to be shown.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

References Api.getInstance(), and Api.getService().

showDialog()

static void showDialog ( int  dialogId, int  maxTime  ) throws GeneralException

static

Shows the specified menu dialog given by the identifier.

Please note the list of identifiers DialogId might grow in future.

Parameters

dialogId	identifier of the memnu dialog
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

References Api.getInstance(), and Api.getService().

showMessage()

static int showMessage ( String  message, int  buttons, boolean  waitForFeedback, int  maxTime  ) throws GeneralException

static

Shows dialog window with a message.

Parameters

message	Text of the message to be shown.
buttons	Type of used buttons.
waitForFeedback	Determines whether Application returns reply before user click the button. true - Application will return reply after user click the button. false - Application will return reply immediately.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Returns

int instance which contains information which button clicked.

• 101 - Cancel/No button.
• 201 - Ok/Yes button.

Notes:
ShowMessage shows dialog over full device screen with take message.
It is possible to use following button types:

• 1 - MbOk
• 2 - MbOkCancel
• 3 - MbYesNo

Exceptions

GeneralException

the general exception

References Api.getInstance(), and Api.getService().