Interface ObnizOptions

Hierarchy

  • ObnizOptions

Properties

access_token? auto_connect? binary? debug_dom_id? local_connect? obnizid_dialog? reset_obniz_on_ws_disconnection?

Properties

Optional access_token

access_token?: null | string

If you specified access_token to your obniz Board. set it's key to this parameter.

Default

null

Optional auto_connect

auto_connect?: boolean

obniz.js automatically connect to cloud API after instantiate soon. falset to disable it. The interval of auto connect become longer.

Default

true

Optional binary

binary?: boolean

compressed format. not json. It set to false, then local_connect can't be used

Default

true

Optional debug_dom_id

debug_dom_id?: string

In HTML, online status and debug info will be showed in DOM which has this id.

Default

'obniz-debug'

Optional local_connect

local_connect?: boolean

obniz.js try to connect locally after cloud api established if possible. true will be ignored when binary was set to false

Default

true

Optional obnizid_dialog

obnizid_dialog?: boolean

With 'true', create input interface of obniz id If non-obniz Id string was passed on create Obniz instance. (HTML only)

Default

true

Optional reset_obniz_on_ws_disconnection

reset_obniz_on_ws_disconnection?: boolean

With 'true', obniz cloud will reset your obniz Board after all websocket connection to an obniz Board was closed.

Default

true

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc