BootOptions.configuratorId Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Property of BootOptions · stable · since 2.0.0
configuratorId?: string;The configurator document _id. It selects that configurator's stored viewer-document layer
(info().document.layers 'tenant') and names it in info().session and the runtime's
beacons. boot reads no scene model for it: your server reads the stored configurator with
your API key (GET https://onsite-backend.holostep.io/api/v1/configurator/load/<id> with
Authorization: Bearer <key>, the answer's configuration), and your first setSceneModel
after boot is the first model (boot's
example). Omit it for a view of no stored configurator (a catalogue preview, a room without
products); platform and account defaults still load.
Default: undefined
| Rule | Result |
|---|---|
| 1. Neutral name | pass: configuratorId names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | pass: 28 apps (fleet cross-check: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-378d190f1b, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508 and 20 more) |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |