Skip to main content
←API Reference

sites


Classes​

NameTypeSummary
SitesExceptionSitesException
Exception thrown when a Sites Manager operation fails.
SitesSessionSitesSession
A session for interacting with the Sites Manager service.
SitesSession provides capabilities for querying organizational hierarchy data
including users, organizations, sites, and assets.
### Usage
1. Acquire the Sites session:
val sitesSession = ardkSession.sites.acquire()
2. Query user information:
val userResult = sitesSession.requestSelfUserInfo()
if (userResult.status == SitesRequestStatus.SUCCESS) {
val user = userResult.user
println("User: ${user?.firstName} ${user?.lastName}")
}
3. Query organizations for a user:
val orgsResult = sitesSession.requestOrganizationsForUser(userId)
orgsResult.organizations.forEach { org ->
println("Organization: ${org.name}")
}
4. Query sites for an organization:
val sitesResult = sitesSession.requestSitesForOrganization(orgId)
sitesResult.sites.forEach { site ->
println("Site: ${site.name}")
}
5. Query assets for a site:
val assetsResult = sitesSession.requestAssetsForSite(siteId)
assetsResult.assets.forEach { asset ->
println("Asset: ${asset.name} (${asset.type})")
}
6. Clean up when done:
sitesSession.close()
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.
TypedAssetDataTypedAssetData
Discriminated union for typed asset data.
One of mesh, splat, or vps will be set based on the asset type.

Data Classes​

NameTypeSummary
AssetAreaAssetArea
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.GeoBoundsGeoBounds
A geographic bounding box.
AssetInfoAssetInfo
Represents an asset, and the areas it is split into, from the Sites Manager service.
AssetMeshDataAssetMeshData
Mesh-specific asset data.
Maps to proto message AssetMeshData.
AssetResultAssetResult
Result of an asset request from the Sites Manager service.
AssetSplatDataAssetSplatData
Splat-specific asset data.
Maps to proto message AssetSplatData.
AssetVpsDataAssetVpsData
VPS-specific asset data.
Maps to proto message AssetVpsData.
OrganizationInfoOrganizationInfo
Represents organization information from the Sites Manager service.
OrganizationResultOrganizationResult
Result of an organization request from the Sites Manager service.
ScanInfoScanInfo
One scan of a site, as the portal lists it.
ScanResultScanResult
Result of a scan list or scan info request from the Sites Manager service.
SiteAssetsInfoSiteAssetsInfo
A single entry in a site-assets location query result.
SiteAssetsResultSiteAssetsResult
Result of a site-assets location query from the Sites Manager service.
SiteInfoSiteInfo
Represents site information from the Sites Manager service.
SiteResultSiteResult
Result of a site request from the Sites Manager service.
TypedAssetData.MeshMesh
-
TypedAssetData.SplatSplat
-
TypedAssetData.VpsVps
-
UserInfoUserInfo
Represents user information from the Sites Manager service.
UserResultUserResult
Result of a user information request from the Sites Manager service.

Enums​

NameTypeSummary
AssetDeploymentTypeAssetDeploymentType
Asset deployment type - whether an asset is live.
AssetPipelineJobStatusAssetPipelineJobStatus
Asset pipeline job status - how far the mapping pipeline got in producing this asset.
AssetScopeAssetScope
Whether [SitesSession.requestSiteAssetsByLocation] returns production assets only, or every asset.
AssetStatusTypeAssetStatusType
Asset status - where the asset is in its lifecycle.
DEPRECATED - [AssetInfo.assetStatus] is always [UNSPECIFIED].
AssetTypeAssetType
Asset type - determines which typed asset data is present.
ScanStatusScanStatus
Scan status, as the portal reports it.
Later SDK versions may add values, so when expressions over it should include an else.
ScanTypeScanType
Scan type, as the portal reports it.
Later SDK versions may add values, so when expressions over it should include an else.
SitesErrorSitesError
Error codes that can occur during Sites Manager operations.
These errors indicate various failure conditions when communicating
with the Sites Manager service.
SitesRequestStatusSitesRequestStatus
Status of a Sites Manager network request.