App

App as returned by HomeyAPIV2.ManagerApps.

Extends

Instance Properties

author

author: object

Type

  • object

autoupdate

autoupdate: boolean

Type

  • boolean

brandColor

brandColor: string

Type

  • string

channel

channel: string

Type

  • string

compatibility

compatibility: string

Type

  • string

crashed

crashed: boolean

Type

  • boolean

crashedMessage

crashedMessage: string

Type

  • string

enabled

enabled: boolean

Type

  • boolean

exitCode

exitCode: number

Type

  • number

exitCount

exitCount: number

Type

  • number

exitSignal

exitSignal: string

Type

  • string

hasDrivers

hasDrivers: boolean

Type

  • boolean

homey

homey: HomeyAPIV3

The Homey of the Item.

Type

icon

icon: string

Type

  • string

iconObj

iconObj: object

Type

  • object

id

id: string

Type

  • string

images

images: object

Type

  • object

manager

manager: HomeyAPIV3.Manager

The Manager of the Item.

Type

name

name: string

Type

  • string

origin

origin: string

Type

  • string

permissions

permissions: array

Type

  • array

ready

ready: boolean

Type

  • boolean

sdk

sdk: number

Type

  • number

session

session: string

Type

  • string

settings

settings: boolean

Type

  • boolean

state

state: string

Type

  • string

updateAvailable

updateAvailable: object

Type

  • object

uri

uri: string

The URI of the Item, e.g. homey:foo:bar.

Type

  • string

usage

usage: object

Type

  • object

version

version: string

Type

  • string

Instance Methods

call

(async) call(opts): Promise.<any>

Call the app's API endpoint.

Parameters

Name Type Description
opts 		Object
method 		'GET' | 'POST' | 'PUT' | 'DELETE'

HTTP Method of the API endpoint.
path 		String

Path to the API endpoint.
body 		mixed
}

Returns

Promise.<any>

connect

(async) connect()

Connect to this item's Socket.io namespace.

delete

(async) delete(opts): Promise.<any>

Make a DELETE request to the App's Web API.

Parameters

Name Type Description
opts 		object
path 		string
}

Returns

Promise.<any>

disconnect

(async) disconnect()

Discconnect from this item's Socket.io namespace.

get

(async) get(opts): Promise.<any>

Make a GET request to the App's Web API.

Parameters

Name Type Description
opts 		object
path 		string
}

Returns

Promise.<any>

post

(async) post(opts): Promise.<any>

Make a POST request to the App's Web API.

Parameters

Name Type Description
opts 		object
path 		string
body 		object
}

Returns

Promise.<any>

put

(async) put(opts): Promise.<any>

Make a PUT request to the App's Web API.

Parameters

Name Type Description
opts 		object
path 		string
body 		object
}

Returns

Promise.<any>

Events

delete

.on('delete')

update

.on('update')

Parameters

Name Type Description
app 		object