HomeyAPI~ManagerFlow

Since:
  • 1.0.0

Methods

async getFlowCardTriggers(optsopt) → {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:
Array.<HomeyAPI.ManagerFlow.FlowCardTrigger> - Successful response

async getFlowCardTrigger(optsopt) → {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:
HomeyAPI.ManagerFlow.FlowCardTrigger - Successful response

async getFlowCardConditions(optsopt) → {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:
Array.<HomeyAPI.ManagerFlow.FlowCardCondition> - Successful response

async getFlowCardCondition(optsopt) → {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:
HomeyAPI.ManagerFlow.FlowCardCondition - Successful response

async runFlowCardCondition(optsopt) → {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:
object - Successful response

async getFlowCardActions(optsopt) → {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:
Array.<HomeyAPI.ManagerFlow.FlowCardAction> - Successful response

async getFlowCardAction(optsopt) → {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:
HomeyAPI.ManagerFlow.FlowCardAction - Successful response

async runFlowCardAction(optsopt)

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

async getFlowCardAutocomplete(optsopt)

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>

async getFlows(optsopt) → {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:
Object.<string, HomeyAPI.ManagerFlow.Flow> - Successful response

async createFlow(optsopt)

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
flow HomeyAPI.ManagerFlow.Flow

async getFlow(optsopt) → {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:
HomeyAPI.ManagerFlow.Flow - Successful response

async updateFlow(optsopt)

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

async deleteFlow(optsopt)

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string

async shareFlow(optsopt)

Required OAuth scopes:
- homey.flow.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string

async testFlow(optsopt)

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>

async triggerFlow(optsopt)

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>
Since:
  • 1.5.2

async getFlowFolders(optsopt) → {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:
Object.<string, HomeyAPI.ManagerFlow.FlowFolder> - Successful response

async createFlowFolder(optsopt) → {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:
HomeyAPI.ManagerFlow.FlowFolder - Successful response

async getFlowFolder(optsopt) → {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:
HomeyAPI.ManagerFlow.FlowFolder - Successful response

async updateFlowFolder(optsopt) → {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:
HomeyAPI.ManagerFlow.FlowFolder - Successful response

async deleteFlowFolder(optsopt)

Required OAuth scopes:
- homey.flow

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string

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