# `ActivateARReport`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Interface · `import type { ActivateARReport } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 16. Capture, export, AR

How an AR launch went. A failure resolves; only misuse rejects.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="launched"></a>[`launched`](ActivateARReport.launched.md) | property | True when an AR viewer opened. |
| <a id="mode"></a>[`mode?`](ActivateARReport.mode.md) | property | The viewer used, when launched. |
| <a id="reason"></a>[`reason?`](ActivateARReport.reason.md) | property | Why it didn't launch: AR off in the document, a device without AR, the shopper declining the browser's AR prompt or closing AR before it started ('cancelled': a new tap may open it), or an error. |
| <a id="message"></a>[`message?`](ActivateARReport.message.md) | property | Detail for logs; not for display. |
| <a id="problems"></a>[`problems`](ActivateARReport.problems.md) | property | For the runtime's own USDZ or WebXR copy of the committed product: 'asset-failed' for each placed ModelNode or `kind: 'model'` collection item it left out because its asset is unloaded, as [`ExportResult.problems`](ExportResult.problems.md). |

## Declaration

```ts
export interface ActivateARReport {
  readonly launched: boolean;
  readonly mode?: 'scene-viewer' | 'quick-look' | 'webxr' | 'other';
  readonly reason?: 'disabled' | 'unsupported' | 'cancelled' | 'error' | 'other';
  readonly message?: string;
  readonly problems: readonly Problem[];
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `ActivateARReport` 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: 24 apps (fleet cross-check: app-04c2774145, app-37356bf09f, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508, app-59c5b5751e, app-822bb9d6aa and 16 more) |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |