ManagerFlow

Extends

Classes

Methods

connect

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

Connect to the realtime namespace.

Returns

Promise.<void>

createFlow

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

Scopes

homey.flow

HTTP

post /api/manager/flow/flow

Parameters

Name Type Description
opts
object
flow
*
}

Returns

createFlowFolder

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

Scopes

homey.flow

HTTP

post /api/manager/flow/flowfolder

Parameters

Name Type Description
opts
object
flowfolder
*
}

Returns

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>

getFlow

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

Scopes

homey.flow.readonly

HTTP

get /api/manager/flow/flow/:id

Parameters

Name Type Description
opts
object
id
string
}

Returns

getFlowCardAction

(async) getFlowCardAction(opts): Promise.<HomeyAPIV3Cloud.ManagerFlow.FlowCardAction>

Scopes

homey.flow.readonly

HTTP

get /api/manager/flow/flowcardaction/:id

Parameters

Name Type Description
opts
object
id
string
}

Returns

getFlowCardActions

(async) getFlowCardActions(): Promise.<HomeyAPIV3Cloud.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>

getFlowCardCondition

(async) getFlowCardCondition(opts): Promise.<HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition>

Scopes

homey.flow.readonly

HTTP

get /api/manager/flow/flowcardcondition/:id

Parameters

Name Type Description
opts
object
id
string
}

Returns

getFlowCardConditions

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

Scopes

homey.flow.readonly

HTTP

get /api/manager/flow/flowcardcondition

Returns

getFlowCardTrigger

(async) getFlowCardTrigger(opts): Promise.<HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger>

Scopes

homey.flow.readonly

HTTP

get /api/manager/flow/flowcardtrigger/:id

Parameters

Name Type Description
opts
object
id
string
}

Returns

getFlowCardTriggers

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

Scopes

homey.flow.readonly

HTTP

get /api/manager/flow/flowcardtrigger

Returns

getFlowFolder

(async) getFlowFolder(opts): Promise.<HomeyAPIV3Cloud.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.<HomeyAPIV3Cloud.ManagerFlow.FlowFolder>

Scopes

homey.flow.readonly

HTTP

get /api/manager/flow/flowfolder

Returns

getFlows

(async) getFlows(): Promise.<HomeyAPIV3Cloud.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

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
*
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>

updateFlow

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

Scopes

homey.flow

HTTP

put /api/manager/flow/flow/:id

Parameters

Name Type Description
opts
object
id
string
flow
*
}

Returns

updateFlowFolder

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

Scopes

homey.flow

HTTP

put /api/manager/flow/flowfolder/:id

Parameters

Name Type Description
opts
object
id
string
flowfolder
*
}

Returns

Events

flow.create

.on('flow.create')

Parameters

Name Type Description
flow
HomeyAPIV3Cloud.ManagerFlow.Flow

flow.delete

.on('flow.delete')

Parameters

Name Type Description
flow
HomeyAPIV3Cloud.ManagerFlow.Flow

flow.update

.on('flow.update')

Parameters

Name Type Description
flow
HomeyAPIV3Cloud.ManagerFlow.Flow

flowcardaction.create

.on('flowcardaction.create')

Parameters

Name Type Description
flowcardaction
HomeyAPIV3Cloud.ManagerFlow.FlowCardAction

flowcardaction.delete

.on('flowcardaction.delete')

Parameters

Name Type Description
flowcardaction
HomeyAPIV3Cloud.ManagerFlow.FlowCardAction

flowcardaction.update

.on('flowcardaction.update')

Parameters

Name Type Description
flowcardaction
HomeyAPIV3Cloud.ManagerFlow.FlowCardAction

flowcardcondition.create

.on('flowcardcondition.create')

Parameters

Name Type Description
flowcardcondition
HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition

flowcardcondition.delete

.on('flowcardcondition.delete')

Parameters

Name Type Description
flowcardcondition
HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition

flowcardcondition.update

.on('flowcardcondition.update')

Parameters

Name Type Description
flowcardcondition
HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition

flowcardtrigger.create

.on('flowcardtrigger.create')

Parameters

Name Type Description
flowcardtrigger
HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger

flowcardtrigger.delete

.on('flowcardtrigger.delete')

Parameters

Name Type Description
flowcardtrigger
HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger

flowcardtrigger.update

.on('flowcardtrigger.update')

Parameters

Name Type Description
flowcardtrigger
HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger

flowfolder.create

.on('flowfolder.create')

Parameters

Name Type Description
flowfolder
HomeyAPIV3Cloud.ManagerFlow.FlowFolder

flowfolder.delete

.on('flowfolder.delete')

Parameters

Name Type Description
flowfolder
HomeyAPIV3Cloud.ManagerFlow.FlowFolder

flowfolder.update

.on('flowfolder.update')

Parameters

Name Type Description
flowfolder
HomeyAPIV3Cloud.ManagerFlow.FlowFolder