Class DeviceLinkNew

Drives device linking from the new (joining) device, which has no AppCore yet (docs/04 §4). Role is independent of who shows the code:

Show a code: DeviceLinkNew.createPairing → render the returned string as a QR and/or copyable text → DeviceLinkNew.awaitLink.
Scan/paste a code: DeviceLinkNew.acceptPairing → DeviceLinkNew.awaitLink.

The existing device approves via AppCore.linkSendBundle.

Index

Constructors

Methods

createPairing acceptPairing awaitLink

Constructors

constructor

new DeviceLinkNew(): DeviceLinkNew
Returns DeviceLinkNew
- Defined in index.ts:1970

Methods

createPairing

createPairing(mailboxServer?: string): Promise<string>
This (new) device shows the pairing code. Returns the pairing string. mailboxServer defaults to the built-in mailbox host when omitted.
Parameters
- OptionalmailboxServer: string
Returns Promise<string>
- Defined in index.ts:1978

acceptPairing

acceptPairing(code: string): Promise<void>
This (new) device scanned/pasted the existing device's pairing code.
Parameters
- code: string
Returns Promise<void>
- Defined in index.ts:1983

awaitLink

awaitLink(dbPath: string, dbKey: string): Promise<AppCore>
Complete the link: receive the sealed bundle and register this device. Blocks until the existing device approves or the attempt times out.
Parameters
- dbPath: string
- dbKey: string
Returns Promise<AppCore>
- Defined in index.ts:1991