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

Homey.ManagerCloud 

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

Table of Contents

Methods

generateOAuth2Callback(oauth2Callback, callbackopt) → {Promise}

Generate a OAuth2 Callback

Parameters:
Name Type Attributes Description
oauth2Callback CloudOAuth2Callback
callback genericCallbackFunction <optional>
Returns:
Type:
Promise

getHomeyId(callbackopt) → {Promise}

Get Homey's Cloud ID

Parameters:
Name Type Attributes Description
callback ManagerCloud#getHomeyIdCallback <optional>
Returns:
Type:
Promise

getLocalAddress(callbackopt) → {Promise}

Get Homey's local address & port

Parameters:
Name Type Attributes Description
callback ManagerCloud#getLocalAddressCallback <optional>
Returns:
Type:
Promise

registerWebhook(webhook, callbackopt) → {Promise}

Register a webhook

Parameters:
Name Type Attributes Description
webhook CloudWebhook
callback genericCallbackFunction <optional>
Returns:
Type:
Promise

unregisterWebhook(webhook, callbackopt) → {Promise}

Unregister a webhook

Parameters:
Name Type Attributes Description
webhook CloudWebhook
callback genericCallbackFunction <optional>
Returns:
Type:
Promise

Type Definitions

getHomeyIdCallback(err, cloudId)

Parameters:
Name Type Description
err Error
cloudId string

getLocalAddressCallback(err, localAddress)

Parameters:
Name Type Description
err Error
localAddress string