Session.canTryOn 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.
Method of Session · inherited by testing.FakeSession · labs, @experimental · since 2.0.0 · called as session.canTryOn · optional: reach it through has()
canTryOn?(): TryOnAvailability;Whether the product on screen can be tried on in this page now: Holostep's camera try-on
(glasses, shoes, watches). Read class: derived. Sync. Show a Try-on control only when
available, and read it again on 'committed': the try-on rig belongs to the product's
ModelNode. reason: 'not-enabled' is the account's enablement; no permits() id gates it.
Experimental, so optional in this declaration: reach it through has(session, 'canTryOn').
Imports: values (has, validate, the Holo*Error classes, the pure helpers) from @holostep-configurators/runtime-client, types from @holostep-configurators/runtime-client/contract, /math and /testing names from those entries; boot from the runtime module the root's loadRuntimeAtFloor resolves to. A type your page defines is your app's: declare it there, never import it from the package.
Compiled under the contract's strict settings (examples/declaration/05-Session.canTryOn.ts):
import { has } from '@holostep-configurators/runtime-client';
import type { Session } from '@holostep-configurators/runtime-client/contract';
declare const session: Session;
declare const signal: AbortSignal;
declare function showTryOnButton(visible: boolean): void;
const refresh = () => showTryOnButton(has(session, 'canTryOn') && session.canTryOn().available);
refresh();
session.on('committed', refresh, { signal });| Rule | Result |
|---|---|
| 1. Neutral name | pass: canTryOn names no product |
| 2. A precedent | pass: model-viewer canActivateAR and activateAR() (row G66); XRSession.end() (row G66); Navigator.share() (resolves when the share UI closes) (row G66) |
| 3. Two apps, or labs | labs (@experimental at a stable path, reached through has() or supports()): it graduates when a second app uses it; apps today: configurator-template, tryon-template |
| 4. The cheaper fix first | decided per need in Appendix B: rows G66 at tier labs (a member only where no rule, data, asset or app code serves the need) |