plugin

bim. Namespace

plugin

Description:

  • Collection of functions that manage plugin. Manages the overall life cycle of the plugin, such as created, resumed, and destroyed. Manages the information of the plugin by offering getters and setters.

Source:
Properties:
Name Type Description
onCreate function

Callback function called when plugin is created. See bim.plugin.onCreate for more details.

onResume function

Callback function called when plugin is resumed. See bim.plugin.onResume for more details.

onDestroy function

Callback function called when plugin is destroyed. See bim.plugin.onDestroy for more details.

name Object

Object to control the name of the plugin. See bim.plugin.name for more details.

token Object

Object to control the token of the plugin. See bim.plugin.token for more details.

id Object

Object to control the id of the plugin. See bim.plugin.id for more details.

path Object

Object saving the location information of the plugin. See bim.plugin.path for more details.

Members

(static) name :Object

Description:

  • Manages Plugin Name with private variable. Provides getter & setter.

Source:
Properties:
Name Type Description
set function

Set Plugin Name to private variable __name__ with parameter passed over.

get function

Get Plugin Name from private variable __name__.

Manages Plugin Name with private variable. Provides getter & setter.

Type:
  • Object

(static) token :Object

Description:

  • Manage Plugin Token with private variable. Provides getter & setter.

Source:
Properties:
Name Type Description
set function

Set Plugin Token to private variable __token__.

Makes an error when reading file "key" fails.
get function

Get Plugin Token from private variable __token__.

Manage Plugin Token with private variable. Provides getter & setter.

Type:
  • Object

(static) id :Object

Description:

  • Manage Plugin ID with private variable. Provides getter & setter.

Source:
Properties:
Name Type Description
set function

Set Plugin ID to private variable __pluginId__ with parameter passed over.

get function

Get Plugin ID from private variable __pluginId__.

Manage Plugin ID with private variable. Provides getter & setter.

Type:
  • Object

(static) path :Object

Description:

  • Object saving the location information of the plugin.

Source:
Properties:
Name Type Description
current string

window.location.href
options Object
Properties
Name Type Description
hash string

window.location.hash
host string

window.location.host
hostname string

window.location.hostname
href string

window.location.href
origin string

window.location.origin
pathname string

window.location.pathname
port string

window.location.port
protocol string

window.location.protocol
search string

window.location.search

Object saving the location information of the plugin.

Type:
  • Object

Methods

(static) onCreate(params)

Description:

  • Callback function called when plugin is created.

Source:
Parameters:
Name Type Description
params *

(static) onResume(params)

Description:

  • Callback function called when plugin is resumed.

Source:
Parameters:
Name Type Description
params *

(static) onDestroy(params)

Description:

  • Callback function called when plugin is destroyed.

Source:
Parameters:
Name Type Description
params *