You are currently viewing the Homey Apps SDK v2 documentation. New apps should use Homey Apps SDK v3 ››

Homey.ManagerFlow 

const { ManagerFlow } = require('homey');

Table of Contents

Methods

getCard(type, id) → {FlowCard|Error}

Get a FlowCard.

Parameters:
Name Type Description
type string

Can be either trigger, condition or action.
id string

Id of the flow card as defined in your app's app.json.
Returns:
Type:
FlowCard | Error

registerCard(cardInstance) → {FlowCard}

Register a FlowCard.

Parameters:
Name Type Description
cardInstance FlowCard
Returns:
Type:
FlowCard

registerToken(tokenInstance, callbackopt) → {Promise}

Register a FlowToken.

Parameters:
Name Type Attributes Description
tokenInstance FlowToken
callback function <optional>
Name Type Description
err Error
token FlowToken
Returns:
Type:
Promise

unregisterCard(cardInstance)

Unregister a FlowCard.

Parameters:
Name Type Description
cardInstance FlowCard

unregisterToken(tokenInstance, callbackopt) → {Promise}

Unregister a FlowToken.

Parameters:
Name Type Attributes Description
tokenInstance FlowToken
callback genericCallbackFunction <optional>
Returns:
Type:
Promise