Access this instance at HomeyAPIV3Local.presence.
Extends
- HomeyAPIV3.ManagerPresence
Instance Methods
getAsleep
(async) getAsleep(opts): Promise.<any>Scopes
homey.presence.readonly
HTTP
GET /api/manager/presence/:id/asleep
Parameters
| Name | Type | Description | 
|---|---|---|
| opts | object | |
| id | string | In  | 
|  | 
Returns
  
Promise.<any>
    getPresent
(async) getPresent(opts): Promise.<any>Scopes
homey.presence.readonly
HTTP
GET /api/manager/presence/:id/present
Parameters
| Name | Type | Description | 
|---|---|---|
| opts | object | |
| id | string | In  | 
|  | 
Returns
  
Promise.<any>
    getState
(async) getState(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/presence/state
Returns
  
Promise.<any>
    setAsleep
(async) setAsleep(opts): Promise.<any>Scopes
homey.presence
HTTP
PUT /api/manager/presence/:id/asleep
Parameters
| Name | Type | Description | 
|---|---|---|
| opts | object | |
| id | string | In  | 
| value | boolean
        
        
        
        <optional> | In  | 
|  | 
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> | In  | 
| opts | object
        
        
        
        <optional> | In  | 
| 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 | In  | 
| value | boolean
        
        
        
        <optional> | In  | 
|  | 
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> | In  | 
| opts | object
        
        
        
        <optional> | In  | 
| forceFlowTrigger | boolean
        
        
        
        <optional> | |
|  | ||
|  | 
Returns
  
Promise.<any>