Browser

Utility api functions to control browser behaviour

isSupported() ⇒ boolean

Validate if browser is supported

reload()

Trigger a reload of the writer based on current hash held internally in the api

getHash() ⇒ string

Deprecated

getId() ⇒ string

Get the pathname in the browser location bar.

setHash(hash) ⇒ string

Deprecated

Parameters

Param

Type

Description

hash

string

Required - New hash value to set

setId(id) ⇒ string

Set the pathname as id in the browser url.

Parameters

Param

Type

Description

id

string

Required - to set

addExternalScript(scriptSource) ⇒ Promise

Adds a script tag in html document

Parameters

Param

Type

Description

scriptSource

string

Required - Script URL

openInNewWindow()

Open an URL in a new window

Parameters

Param

Description

instructions.

getUrl(instructions)

Gets an URL from the specific instructions

Parameters

Param

Type

Description

instructions

Object

Required -

instructions.url

string

Required - @deprecated. Not used

instructions.hash

string

Required - @deprecated. Use instructions.pathname instead

instructions.id

string

Required - Creates an url.href with id as pathname

Last updated