InterfaceClient()

The UI socket handler

new InterfaceClient()

Extends

  • IO

Events

get_userconfig_all

Retrieve the user config properties
Parameters:
Name Type Description
key string the key to save under
value boolean | number | string the object to save
Fires:

get_userconfig_all:result

Result call for `get_userconfig_all` that contains the requested data
Parameters:
Name Type Description
userconfig Object.<string, (boolean|number|string)> the key/value pairs

set_userconfig_key

Save/update a key/value pair to the user config and broadcast to the other clients
Parameters:
Name Type Description
key string the key to save under
value boolean | number | string the object to save
Fires:

set_userconfig_key:result

Result broadcast for `set_userconfig_key` that pushes an updated user config key/value pair
Parameters:
Name Type Description
key string the key to save under
value boolean | number | string the object to save