ManagerFlow

Access this instance at HomeyAPIV3Local.flow.

Extends

Classes

Methods

connect

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

Connect to the realtime namespace.

Returns

Promise.<void>

createAdvancedFlow

(async) createAdvancedFlow(opts): Promise.<HomeyAPIV3Local.ManagerFlow.AdvancedFlow>

Scopes

homey.flow

HTTP

POST /api/manager/flow/advancedflow

Parameters

Name Type Description
opts
object
advancedflow
*
}

Returns

createFlow

(async) createFlow(opts): Promise.<HomeyAPIV3Local.ManagerFlow.Flow>

Scopes

homey.flow

HTTP

POST /api/manager/flow/flow

Parameters

Name Type Description
opts
object
flow
object
name
string
folder
string <optional>
enabled
boolean <optional>
trigger
object
conditions
array
actions
array
}
}

Returns

createFlowFolder

(async) createFlowFolder(opts): Promise.<HomeyAPIV3Local.ManagerFlow.FlowFolder>

Scopes

homey.flow

HTTP

POST /api/manager/flow/flowfolder

Parameters

Name Type Description
opts
object
flowfolder
object
name
string
parent
string <optional>
}
}

Returns

deleteAdvancedFlow

(async) deleteAdvancedFlow(opts)

Scopes

homey.flow

HTTP

DELETE /api/manager/flow/advancedflow/:id

Parameters

Name Type Description
opts
object
id
string
}

deleteFlow

(async) deleteFlow(opts)

Scopes

homey.flow

HTTP

DELETE /api/manager/flow/flow/:id

Parameters

Name Type Description
opts
object
id
string
}

deleteFlowFolder

(async) deleteFlowFolder(opts)

Scopes

homey.flow

HTTP

DELETE /api/manager/flow/flowfolder/:id

Parameters

Name Type Description
opts
object
id
string
}

disconnect

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

Disconnect from the realtime namespace.

Returns

Promise.<void>

getAdvancedFlow

(async) getAdvancedFlow(opts): Promise.<HomeyAPIV3Local.ManagerFlow.AdvancedFlow>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/advancedflow/:id

Parameters

Name Type Description
opts
object
id
string
}

Returns

getAdvancedFlows

(async) getAdvancedFlows(): Promise.<HomeyAPIV3Local.ManagerFlow.AdvancedFlow>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/advancedflow

Returns

getFlow

(async) getFlow(opts): Promise.<HomeyAPIV3Local.ManagerFlow.Flow>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/flow/:id

Parameters

Name Type Description
opts
object
id
string
}

Returns

getFlowCardActions

(async) getFlowCardActions(): Promise.<HomeyAPIV3Local.ManagerFlow.FlowCardAction>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/flowcardaction

Returns

getFlowCardAutocomplete

(async) getFlowCardAutocomplete(opts): Promise.<any>

Scopes

-

HTTP

GET /api/manager/flow/:type/:uri/:id/autocomplete

Parameters

Name Type Description
opts
object
id
string
uri
string
type
string
name
string
query
string
args
object <optional>
}

Returns

Promise.<any>

getFlowCardConditions

(async) getFlowCardConditions(): Promise.<HomeyAPIV3Local.ManagerFlow.FlowCardCondition>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/flowcardcondition

Returns

getFlowCardTriggers

(async) getFlowCardTriggers(): Promise.<HomeyAPIV3Local.ManagerFlow.FlowCardTrigger>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/flowcardtrigger

Returns

getFlowFolder

(async) getFlowFolder(opts): Promise.<HomeyAPIV3Local.ManagerFlow.FlowFolder>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/flowfolder/:id

Parameters

Name Type Description
opts
object
id
string
}

Returns

getFlowFolders

(async) getFlowFolders(): Promise.<HomeyAPIV3Local.ManagerFlow.FlowFolder>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/flowfolder

Returns

getFlows

(async) getFlows(): Promise.<HomeyAPIV3Local.ManagerFlow.Flow>

Scopes

homey.flow.readonly

HTTP

GET /api/manager/flow/flow

Returns

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/flow/state

Returns

Promise.<any>

isConnected

isConnected(): Boolean

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

Returns

Boolean

runFlowCardAction

(async) runFlowCardAction(opts): Promise.<any>

Scopes

homey.flow.start

HTTP

POST /api/manager/flow/flowcardaction/:uri/:id/run

Parameters

Name Type Description
opts
object
id
string
uri
string
args
object <optional>
tokens
object <optional>
droptoken
string <optional>
duration
number <optional>
}

Returns

Promise.<any>

runFlowCardCondition

(async) runFlowCardCondition(opts): Promise.<any>

Scopes

homey.flow.start

HTTP

POST /api/manager/flow/flowcardcondition/:uri/:id/run

Parameters

Name Type Description
opts
object
id
string
uri
string
args
object <optional>
tokens
object <optional>
droptoken
string <optional>
}

Returns

Promise.<any>

shareFlow

(async) shareFlow(opts): Promise.<any>

Scopes

homey.flow.readonly

HTTP

POST /api/manager/flow/flow/:id/share

Parameters

Name Type Description
opts
object
id
string
}

Returns

Promise.<any>

testFlow

(async) testFlow(opts): Promise.<any>

Scopes

homey.flow

HTTP

POST /api/manager/flow/flow/test

Parameters

Name Type Description
opts
object
flow
object
trigger
object
conditions
array
actions
array
}
tokens
object
sessionId
string
}

Returns

Promise.<any>

triggerFlow

(async) triggerFlow(opts): Promise.<any>

Scopes

homey.flow.start

HTTP

POST /api/manager/flow/flow/:id/trigger

Parameters

Name Type Description
opts
object
id
string
}

Returns

Promise.<any>

updateAdvancedFlow

(async) updateAdvancedFlow(opts): Promise.<HomeyAPIV3Local.ManagerFlow.AdvancedFlow>

Scopes

homey.flow

HTTP

PUT /api/manager/flow/advancedflow/:id

Parameters

Name Type Description
opts
object
id
string
advancedflow
*
}

Returns

updateFlow

(async) updateFlow(opts): Promise.<HomeyAPIV3Local.ManagerFlow.Flow>

Scopes

homey.flow

HTTP

PUT /api/manager/flow/flow/:id

Parameters

Name Type Description
opts
object
id
string
flow
object
name
string <optional>
folder
string <optional>
enabled
boolean <optional>
trigger
object <optional>
conditions
array <optional>
actions
array <optional>
}
}

Returns

updateFlowFolder

(async) updateFlowFolder(opts): Promise.<HomeyAPIV3Local.ManagerFlow.FlowFolder>

Scopes

homey.flow

HTTP

PUT /api/manager/flow/flowfolder/:id

Parameters

Name Type Description
opts
object
id
string
flowfolder
object
name
string <optional>
parent
string <optional>
}
}

Returns

Events

advancedflow.create

.on('advancedflow.create')

Parameters

Name Type Description
advancedflow
HomeyAPIV3Local.ManagerFlow.AdvancedFlow

advancedflow.delete

.on('advancedflow.delete')

Parameters

Name Type Description
advancedflow
HomeyAPIV3Local.ManagerFlow.AdvancedFlow

advancedflow.update

.on('advancedflow.update')

Parameters

Name Type Description
advancedflow
HomeyAPIV3Local.ManagerFlow.AdvancedFlow

flow.create

.on('flow.create')

Parameters

Name Type Description
flow
HomeyAPIV3Local.ManagerFlow.Flow

flow.delete

.on('flow.delete')

Parameters

Name Type Description
flow
HomeyAPIV3Local.ManagerFlow.Flow

flow.update

.on('flow.update')

Parameters

Name Type Description
flow
HomeyAPIV3Local.ManagerFlow.Flow

flowcardaction.create

.on('flowcardaction.create')

Parameters

Name Type Description
flowcardaction
HomeyAPIV3Local.ManagerFlow.FlowCardAction

flowcardaction.delete

.on('flowcardaction.delete')

Parameters

Name Type Description
flowcardaction
HomeyAPIV3Local.ManagerFlow.FlowCardAction

flowcardaction.update

.on('flowcardaction.update')

Parameters

Name Type Description
flowcardaction
HomeyAPIV3Local.ManagerFlow.FlowCardAction

flowcardcondition.create

.on('flowcardcondition.create')

Parameters

Name Type Description
flowcardcondition
HomeyAPIV3Local.ManagerFlow.FlowCardCondition

flowcardcondition.delete

.on('flowcardcondition.delete')

Parameters

Name Type Description
flowcardcondition
HomeyAPIV3Local.ManagerFlow.FlowCardCondition

flowcardcondition.update

.on('flowcardcondition.update')

Parameters

Name Type Description
flowcardcondition
HomeyAPIV3Local.ManagerFlow.FlowCardCondition

flowcardtrigger.create

.on('flowcardtrigger.create')

Parameters

Name Type Description
flowcardtrigger
HomeyAPIV3Local.ManagerFlow.FlowCardTrigger

flowcardtrigger.delete

.on('flowcardtrigger.delete')

Parameters

Name Type Description
flowcardtrigger
HomeyAPIV3Local.ManagerFlow.FlowCardTrigger

flowcardtrigger.update

.on('flowcardtrigger.update')

Parameters

Name Type Description
flowcardtrigger
HomeyAPIV3Local.ManagerFlow.FlowCardTrigger

flowfolder.create

.on('flowfolder.create')

Parameters

Name Type Description
flowfolder
HomeyAPIV3Local.ManagerFlow.FlowFolder

flowfolder.delete

.on('flowfolder.delete')

Parameters

Name Type Description
flowfolder
HomeyAPIV3Local.ManagerFlow.FlowFolder

flowfolder.update

.on('flowfolder.update')

Parameters

Name Type Description
flowfolder
HomeyAPIV3Local.ManagerFlow.FlowFolder