All Configuration

Configuration Field/Keys

KeyDescription

showUrl

boolean Determines if the URL will be displayed to the user. Defaults to false.

showTitle

boolean Determines if the webpage title is displayed to the user. Defaults to false.

allowCookiePreview

boolean Determines if user can view the cookies for the current URL. This is used for development purposes. Defaults to false.

fixOrientation

boolean Determines if the view is fixed to portrait. Defaults to false.

allowUrlEdit

boolean Determines if the user is allowed to edit the URL. Defaults to false.

defaultHomepage

string URL of the website to be visited when the browser application is clicked. Defaults to a blank URL.

enablePinchToZoom

boolean Determines if the user is allowed to pinch to zoom within the webpage. Defaults to false.

allowInsecureSites

boolean Determines if the user is allowed to visit insecure websites. Defaults to false.

allowCameraAccess

boolean Determines if the website can access the camera. Defaults to false.

allowAudioCapture

boolean Determines if the website can access the microphone. Defaults to false.

allowPrinterAccess

boolean Determines if the website can access the printers. Defaults to false.

allowPopupWindows

boolean Determines if the website can display pop-up windows over webpage content within the browser. Defaults to false.

logLevel

string Determines the level of log to be logged in Support Agent. Valid values are verbose, debug, info, or error. If set, only the level of logs set and below will be logged. Defaults to info.

openInDesktopMode

boolean If used in a browserOverrides object and set to true, the browser will open the website with a user agent to tell the browser to render it in desktop mode. Defaults to false.

allowThirdPartyCookies

boolean Determines if the website can use/store third-party cookies. Defaults to false.

enableEmsApi

boolean Enable the Launcher Provider, Keyboard, and Scanner APIs to be used from a webpage. Defaults to false.

userAgent

string A replacement user agent string to send to the server; the server will process data from the application as if it was coming from a different web browser, as defined by the string. If not specified, will default to the device-provided user agent string. Can be overridden by the value in a shortcut's browserOverrides.

customScriptPath

string The file location, using the file path on the device or an asset, of a Javascript file applied to implement a custom behavior on the BlueFletch Browser.

customStylePath

string The file locataion, using the file path on the device or an asset, of a CSS file applied to implement custom styles on the BlueFletch Browser.

createDataWedgeProfile

boolean Determines whether or not a DataWedge profile will be automatically created for the BlueFletch Browser when the application is first launched. Defaults to true (profile is automatically created). Applicable to Zebra devices only.

disableBackButton

boolean If true, the Android Back button will be disabled while a Browser web app is open. Default is false.

disableBackButtonMessage

string If disableBackButton is true, a toast message will display the defined text string upon tapping Android Back button. Text defaults to "Back button has been disabled for this app". To not display any toast for a particular web app while Back button is disabled, define this value with an empty string within the web app's browserOverrides object.

useWideViewPort

boolean Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. Default is true.

scannerDisableProfile

boolean When using the Javascript Scanner interface logic, the Scanner.disable and Scanner.unregister functions will disable the scanner hardware on Zebra devices. Set this flag to 'false' to ignore scan events and not disable the scanner hardware. Default is true, introduced in version 2.0.10

webauthnPaths

string Comma-delimited list of hosts where the WebAuthn (FIDO2) interfaces will be enabled within the Browser. If set and the current page matches the host, Browser will allow the use of FIDO2 with NFC security keys on that page.

clearCacheOnExit

boolean If set true, when the browser closes, will invoke logic to clear cache. Default is false. Introduced in version 2.3.4

clearCookiesOnExit

boolean If set true, when browser closes, will invoke logic to clear cookies. Default is false. Introduced in version 2.3.4

Notes

  • If the "allowCameraAccess" or "allowCookiePreview" is set to true, the overflow menu and title will be shown. If both are set to false, the overflow menu will be hidden.

  • If the "showUrl" or "showTitle" or "allowUrlEdit" is set to true, the toolbar will be shown. If all three are set to false, the toolbar will be hidden.

  • If the "defaultHomepage" is not set, the browser will not launch when the user clicks on the browser application and an error will be displayed.

Sample Browser Configuration

"browser": {
    "showUrl": false,
    "showTitle": false,
    "allowCookiePreview": false,
    "fixOrientation": false,
    "allowUrlEdit": false,
    "defaultHomepage": "https://bluefletch.com",
    "enablePinchToZoom": false,
    "allowInsecureSites": false,
    "allowCameraAccess": false,
    "allowAudioCapture": false,
    "allowPrinterAccess": false,
    "enableEmsApi": false,
    "logLevel": "info",
    "createDataWedgeProfile": true,
    "disableBackButton": false   
},
"browserRestrictions:" : {
    "allowList" : [],
    "blockList" : []
}

Last updated