Extension qnx.navigator.overlay

qnx.navigator.overlay

Allow access to the UI resources on the overlay webview

Methods

hide

Remove the UI element specified by the type key in the arguments
Parameters:
Name Type Description
args Object The UI element and parameters.
Example
(voice)
{
     type: {String}, // the type of UI element: voice|notice|info
}

init

Set the overlayWebview object to the URL specified
Parameters:
Name Type Description
args URL for overlay; point back to the Navigator application

show

Display the UI element specified by the type key in the arguments
Parameters:
Name Type Description
args Object The UI element and parameters
Example
 for voice (1):
{
     type: {String}, // 'voice' the type of UI element
     opts: {Object}  {
         state: {String}, //time required to navigate the entire route, in seconds
                     }
}
for voice (2):
{
     type: {String}, // 'voice' the type of UI element
     opts: {Object}  {
         results: {Object}   {
             utterance: {String},
             confidence: {Number}
                             } 
                     }
}
for notice:
{
     type: {String}, //  'notice' the type of UI element
     opts: {Object}  {
         text: {String}, // the text contained within the notice
         title: {String}, // the title of the notice
         stay: {Boolean}, // if true, the notice must be dismissed by touch
         stayTime: {Time}, // in milliseconds
         klass: {String}, // optional class for css styling ie. notice, error, success
                     }
}