minca
ApiSessionFunctions

Function: proposeToHome()

function proposeToHome(options): Promise<Proposed>;

Defined in: packages/core/src/session/connect.ts:431

Offers the person automations that notify them, from an app already connected to their home. Call it from a click on something that asked for it — "Notify me" — in a page that stays open: the home opens in a popup, and the person keeps the ones they want. The app shows the notifications itself (watchNotifications).

Parameters

ParameterTypeDescription
options{ automations: readonly AutomationProposal[]; home: string; name?: string; timeoutMs?: number; }-
options.automationsreadonly AutomationProposal[]-
options.homestringThe home it connected to — a grant's home
options.name?string-
options.timeoutMs?number-

Returns

Promise<Proposed>

What the home added or found; an empty list when the person kept none

Throws

When the popup is blocked, closed or denied, or the home knows no connection from here

On this page