sites
Classes
| Name | Type | Summary |
|---|---|---|
| SitesException | SitesException | Exception thrown when a Sites Manager operation fails. |
| SitesSession | SitesSession | A session for interacting with the Sites Manager service. SitesSession provides capabilities for querying organizational hierarchy dataincluding users, organizations, sites, and assets. ### Usage 1. Acquire the Sites session: 2. Query user information: 3. Query organizations for a user: 4. Query sites for an organization: 5. Query assets for a site: 6. Clean up when done: Cancellation and timeouts: each request function polls until the request finishes, its timeoutMs passes, or the calling coroutine is cancelled. The native request has no cancel:after a timeout or cancellation it still runs to completion in the background, and its result is discarded. |
| TypedAssetData | TypedAssetData | Discriminated union for typed asset data. One of mesh, splat, or vps will be set based on the asset type. |
Data Classes
| Name | Type | Summary |
|---|---|---|
| AssetArea | AssetArea | One independently-localizable piece of an asset. A scan too large for a single mapping run is split, and each piece gets its own job, anchor, node graph and extent. An asset mapped in one pass has exactly one area. One shape serves every asset type. [AssetInfo.assetType] selects which properties carry anything: - mesh: [rootNodeId], [nodeIds], [meshCoverage] - splat: [rootNodeId] - VPS: [anchorPayload], [bounds] |
| AssetArea.GeoBounds | GeoBounds | A geographic bounding box. |
| AssetInfo | AssetInfo | Represents an asset, and the areas it is split into, from the Sites Manager service. |
| AssetMeshData | AssetMeshData | Mesh-specific asset data. Maps to proto message AssetMeshData. |
| AssetResult | AssetResult | Result of an asset request from the Sites Manager service. |
| AssetSplatData | AssetSplatData | Splat-specific asset data. Maps to proto message AssetSplatData. |
| AssetVpsData | AssetVpsData | VPS-specific asset data. Maps to proto message AssetVpsData. |
| OrganizationInfo | OrganizationInfo | Represents organization information from the Sites Manager service. |
| OrganizationResult | OrganizationResult | Result of an organization request from the Sites Manager service. |
| ScanInfo | ScanInfo | One scan of a site, as the portal lists it. |
| ScanResult | ScanResult | Result of a scan list or scan info request from the Sites Manager service. |
| SiteAssetsInfo | SiteAssetsInfo | A single entry in a site-assets location query result. |
| SiteAssetsResult | SiteAssetsResult | Result of a site-assets location query from the Sites Manager service. |
| SiteInfo | SiteInfo | Represents site information from the Sites Manager service. |
| SiteResult | SiteResult | Result of a site request from the Sites Manager service. |
| TypedAssetData.Mesh | Mesh | - |
| TypedAssetData.Splat | Splat | - |
| TypedAssetData.Vps | Vps | - |
| UserInfo | UserInfo | Represents user information from the Sites Manager service. |
| UserResult | UserResult | Result of a user information request from the Sites Manager service. |
Enums
| Name | Type | Summary |
|---|---|---|
| AssetDeploymentType | AssetDeploymentType | Asset deployment type - whether an asset is live. |
| AssetPipelineJobStatus | AssetPipelineJobStatus | Asset pipeline job status - how far the mapping pipeline got in producing this asset. |
| AssetScope | AssetScope | Whether [SitesSession.requestSiteAssetsByLocation] returns production assets only, or every asset. |
| AssetStatusType | AssetStatusType | Asset status - where the asset is in its lifecycle. DEPRECATED - [AssetInfo.assetStatus] is always [UNSPECIFIED]. |
| AssetType | AssetType | Asset type - determines which typed asset data is present. |
| ScanStatus | ScanStatus | Scan status, as the portal reports it. Later SDK versions may add values, so when expressions over it should include an else. |
| ScanType | ScanType | Scan type, as the portal reports it. Later SDK versions may add values, so when expressions over it should include an else. |
| SitesError | SitesError | Error codes that can occur during Sites Manager operations. These errors indicate various failure conditions when communicating with the Sites Manager service. |
| SitesRequestStatus | SitesRequestStatus | Status of a Sites Manager network request. |