HomeyAPIV3

An authenticated Homey API. Do not construct this class manually.

Extends

Classes

Instance Methods

__

__(input): string|null

Translates an i18n-object (e.g. { en: 'My String', nl: 'Mijn tekst' } to a string. Uses the language of Homey as defined in Homey.

Parameters

Name Type Description
input
object
en
string

English translation

nl
string

Dutch translation

}

Returns

  • The translated string, or null
string | null

Example

homeyApi.__({
  en: 'Hello',
  nl: 'Hallo',
  fr: 'Bonjour',
}); // returns "Hello" if Homey is set to English

hasRole

hasRole(roleId)

Check the current role.

Parameters

Name Type Description
roleId
string

The role ID, e.g. owner, manager, user or guest.

isConnected

isConnected(): Boolean

If Homey is connected to Socket.io.

Returns

Boolean