You are currently viewing the Homey Apps SDK v2 documentation. New apps should use Homey Apps SDK v3 ››

Homey.ManagerSettings

const { ManagerSettings } = require('homey');

Table of Contents

Methods

get(key) → {Mixed}

Get a setting.

Parameters:
Name Type Description
key string
Returns:
Type:
Mixed

value

getKeys() → {Array.<String>}

Get all settings keys.

Returns:
Type:
Array.<String>

set(key, value)

Set a setting.

Parameters:
Name Type Description
key string
value Mixed

unset(key)

Unset (delete) a setting.

Parameters:
Name Type Description
key string

Events

.on('set')

Fires when a setting has been set.

Parameters:
Name Type Description
key String

.on('unset')

Fires when a setting has been unset.

Parameters:
Name Type Description
key String