ManagerSessions

Access this instance at HomeyAPIV2.sessions.

Extends

Classes

Methods

connect

(async) connect(): Promise.<void>

Connect to the realtime namespace.

Returns

Promise.<void>

deleteSession

(async) deleteSession(opts)

Scopes

homey.user.readonly

HTTP

DELETE /api/manager/sessions/session/:id

Parameters

Name Type Description
opts
object
id
string
}

disconnect

(async) disconnect(): Promise.<void>

Disconnect from the realtime namespace.

Returns

Promise.<void>

getSessionMe

(async) getSessionMe(): Promise.<any>

Scopes

-

HTTP

GET /api/manager/sessions/session/me

Returns

Promise.<any>

getSessions

(async) getSessions(): Promise.<HomeyAPIV2.ManagerSessions.Session>

Scopes

homey.user.readonly

HTTP

GET /api/manager/sessions/session

Returns

isConnected

isConnected(): Boolean

If this manager's namespace is connected to Socket.io.

Returns

Boolean

Events

session.create

.on('session.create')

Parameters

Name Type Description
session
HomeyAPIV2.ManagerSessions.Session

session.delete

.on('session.delete')

Parameters

Name Type Description
session
HomeyAPIV2.ManagerSessions.Session

session.update

.on('session.update')

Parameters

Name Type Description
session
HomeyAPIV2.ManagerSessions.Session