HomeyAPI~ManagerFlow

Since:
  • 1.0.0

Methods

async getFlowCardTriggers(optsopt) → {Promise.<Array.<HomeyAPI.ManagerFlow.FlowCardTrigger>>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
filter HomeyAPI.ManagerFlow.FlowCardTrigger <optional>
A response filter (Using a filter will bypass all caches, use sparingely)
Returns:
Promise.<Array.<HomeyAPI.ManagerFlow.FlowCardTrigger>> - Successful response

async getFlowCardTrigger(optsopt) → {Promise.<HomeyAPI.ManagerFlow.FlowCardTrigger>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
uri string
id string
Returns:
Promise.<HomeyAPI.ManagerFlow.FlowCardTrigger> - Successful response

async getFlowCardConditions(optsopt) → {Promise.<Array.<HomeyAPI.ManagerFlow.FlowCardCondition>>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
filter HomeyAPI.ManagerFlow.FlowCardCondition <optional>
A response filter (Using a filter will bypass all caches, use sparingely)
Returns:
Promise.<Array.<HomeyAPI.ManagerFlow.FlowCardCondition>> - Successful response

async getFlowCardCondition(optsopt) → {Promise.<HomeyAPI.ManagerFlow.FlowCardCondition>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
uri string
id string
Returns:
Promise.<HomeyAPI.ManagerFlow.FlowCardCondition> - Successful response

async runFlowCardCondition(optsopt) → {Promise.<object>}

Required OAuth scopes:
- homey.flow.start

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
uri string
id string
args object <optional>
droptoken string <optional>
Returns:
Promise.<object> - Successful response

async getFlowCardActions(optsopt) → {Promise.<Array.<HomeyAPI.ManagerFlow.FlowCardAction>>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
filter HomeyAPI.ManagerFlow.FlowCardAction <optional>
A response filter (Using a filter will bypass all caches, use sparingely)
Returns:
Promise.<Array.<HomeyAPI.ManagerFlow.FlowCardAction>> - Successful response

async getFlowCardAction(optsopt) → {Promise.<HomeyAPI.ManagerFlow.FlowCardAction>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
uri string
id string
Returns:
Promise.<HomeyAPI.ManagerFlow.FlowCardAction> - Successful response

async runFlowCardAction(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow.start

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
uri string
id string
args object <optional>
droptoken string <optional>
duration number <optional>
Duration (optional) in seconds
Returns:
Promise.<void> - Successful response

async getFlowCardAutocomplete(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
type string
uri string
id string
name string
query string
args object <optional>
Returns:
Promise.<void> - Successful response

async getFlows(optsopt) → {Promise.<Object.<string, HomeyAPI.ManagerFlow.Flow>>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
filter HomeyAPI.ManagerFlow.Flow <optional>
A response filter (Using a filter will bypass all caches, use sparingely)
Returns:
Promise.<Object.<string, HomeyAPI.ManagerFlow.Flow>> - Successful response

async createFlow(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
flow HomeyAPI.ManagerFlow.Flow
Returns:
Promise.<void> - Successful response

async getFlow(optsopt) → {Promise.<HomeyAPI.ManagerFlow.Flow>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<HomeyAPI.ManagerFlow.Flow> - Successful response

async updateFlow(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
flow HomeyAPI.ManagerFlow.Flow
Returns:
Promise.<void> - Successful response

async deleteFlow(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<void> - Successful response

async shareFlow(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<void> - Successful response

async testFlow(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
flow HomeyAPI.ManagerFlow.Flow
tokens object
sessionId string <optional>
Returns:
Promise.<void> - Successful response

async triggerFlow(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow.start

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
id string
state object <optional>
Returns:
Promise.<void> - Successful response
Since:
  • 1.5.2

async getFlowFolders(optsopt) → {Promise.<Object.<string, HomeyAPI.ManagerFlow.FlowFolder>>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
filter HomeyAPI.ManagerFlow.FlowFolder <optional>
A response filter (Using a filter will bypass all caches, use sparingely)
Returns:
Promise.<Object.<string, HomeyAPI.ManagerFlow.FlowFolder>> - Successful response

async createFlowFolder(optsopt) → {Promise.<HomeyAPI.ManagerFlow.FlowFolder>}

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
flowfolder object
Returns:
Promise.<HomeyAPI.ManagerFlow.FlowFolder> - Successful response

async getFlowFolder(optsopt) → {Promise.<HomeyAPI.ManagerFlow.FlowFolder>}

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<HomeyAPI.ManagerFlow.FlowFolder> - Successful response

async updateFlowFolder(optsopt) → {Promise.<HomeyAPI.ManagerFlow.FlowFolder>}

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
flowfolder object
Returns:
Promise.<HomeyAPI.ManagerFlow.FlowFolder> - Successful response

async deleteFlowFolder(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<void> - Successful response

destroy()

Unsubscribes to realtime events, clear all caches, and remove all event listeners for this manager and it's managed objects

Events

flow.create

Fired when a managed Flow is created
Parameters:
Name Type Description
flow HomeyAPI.ManagerFlow.Flow The affected Flow

flow.update

Fired when a managed Flow is changed
Parameters:
Name Type Description
flow HomeyAPI.ManagerFlow.Flow The affected Flow

flow.delete

Fired when a managed Flow has been deleted
Parameters:
Name Type Description
flow HomeyAPI.ManagerFlow.Flow The affected Flow

flowfolder.create

Fired when a managed FlowFolder is created
Parameters:
Name Type Description
flowfolder HomeyAPI.ManagerFlow.FlowFolder The affected FlowFolder

flowfolder.update

Fired when a managed FlowFolder is changed
Parameters:
Name Type Description
flowfolder HomeyAPI.ManagerFlow.FlowFolder The affected FlowFolder

flowfolder.delete

Fired when a managed FlowFolder has been deleted
Parameters:
Name Type Description
flowfolder HomeyAPI.ManagerFlow.FlowFolder The affected FlowFolder

flowcardtrigger.create

Fired when a managed FlowCardTrigger is created
Parameters:
Name Type Description
flowcardtrigger HomeyAPI.ManagerFlow.FlowCardTrigger The affected FlowCardTrigger

flowcardtrigger.update

Fired when a managed FlowCardTrigger is changed
Parameters:
Name Type Description
flowcardtrigger HomeyAPI.ManagerFlow.FlowCardTrigger The affected FlowCardTrigger

flowcardtrigger.delete

Fired when a managed FlowCardTrigger has been deleted
Parameters:
Name Type Description
flowcardtrigger HomeyAPI.ManagerFlow.FlowCardTrigger The affected FlowCardTrigger

flowcardcondition.create

Fired when a managed FlowCardCondition is created
Parameters:
Name Type Description
flowcardcondition HomeyAPI.ManagerFlow.FlowCardCondition The affected FlowCardCondition

flowcardcondition.update

Fired when a managed FlowCardCondition is changed
Parameters:
Name Type Description
flowcardcondition HomeyAPI.ManagerFlow.FlowCardCondition The affected FlowCardCondition

flowcardcondition.delete

Fired when a managed FlowCardCondition has been deleted
Parameters:
Name Type Description
flowcardcondition HomeyAPI.ManagerFlow.FlowCardCondition The affected FlowCardCondition

flowcardaction.create

Fired when a managed FlowCardAction is created
Parameters:
Name Type Description
flowcardaction HomeyAPI.ManagerFlow.FlowCardAction The affected FlowCardAction

flowcardaction.update

Fired when a managed FlowCardAction is changed
Parameters:
Name Type Description
flowcardaction HomeyAPI.ManagerFlow.FlowCardAction The affected FlowCardAction

flowcardaction.delete

Fired when a managed FlowCardAction has been deleted
Parameters:
Name Type Description
flowcardaction HomeyAPI.ManagerFlow.FlowCardAction The affected FlowCardAction

Classes

Error

Flow

FlowCardTrigger

FlowCardCondition

FlowCardAction

FlowCardGroup

FlowFolder