Access this instance at HomeyAPIV3Local.presence.
Extends
Methods
connect
(async) connect(): Promise.<void>Connect to the realtime namespace.
Returns
Promise.<void>
disconnect
(async) disconnect(): Promise.<void>Disconnect from the realtime namespace.
Returns
Promise.<void>
getState
(async) getState(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/presence/state
Returns
Promise.<any>
isConnected
isConnected(): BooleanIf this manager's namespace is connected to Socket.io.
Returns
Boolean
setAsleep
(async) setAsleep(opts): Promise.<any>Scopes
homey.presence
HTTP
PUT /api/manager/presence/:id/asleep
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
value
|
boolean
<optional> |
|
|
|
Returns
Promise.<any>
setAsleepMe
(async) setAsleepMe(opts): Promise.<any>Scopes
homey.presence.self
HTTP
PUT /api/manager/presence/me/asleep
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
boolean
<optional> |
|
opts
|
object
<optional> |
|
forceFlowTrigger
|
boolean
<optional> |
|
|
|
||
|
|
Returns
Promise.<any>
setPresent
(async) setPresent(opts): Promise.<any>Scopes
homey.presence
HTTP
PUT /api/manager/presence/:id/present
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
value
|
boolean
<optional> |
|
|
|
Returns
Promise.<any>
setPresentMe
(async) setPresentMe(opts): Promise.<any>Scopes
homey.presence.self
HTTP
PUT /api/manager/presence/me/present
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
boolean
<optional> |
|
opts
|
object
<optional> |
|
forceFlowTrigger
|
boolean
<optional> |
|
|
|
||
|
|
Returns
Promise.<any>