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()
TypedAssetDataTypedAssetData
Discriminated union for typed asset data.
One of mesh, splat, or vps will be set based on the asset type.

Data Classes​

NameTypeSummary
AssetInfoAssetInfo
Represents asset information from the Sites Manager service.
Maps to proto messages AssetRecord, AssetData, and AssetComputedValues.
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.
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.
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.
Maps to proto enum AssetDeploymentType.
AssetPipelineJobStatusAssetPipelineJobStatus
Asset pipeline job status.
Maps to proto enum AssetPipelineJobStatus.
AssetStatusTypeAssetStatusType
Asset status.
Maps to proto enum AssetStatusType.
AssetTypeAssetType
Asset type - determines which typed asset data is present.
Maps to proto enum AssetType.
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.