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 data including users, organizations, sites, and assets. ### Usage 1. Acquire the Sites session: kotlin val sitesSession = ardkSession.sites.acquire() 2. Query user information: kotlin 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: kotlin val orgsResult = sitesSession.requestOrganizationsForUser(userId) orgsResult.organizations.forEach { org -> println("Organization: ${org.name}") } 4. Query sites for an organization: kotlin val sitesResult = sitesSession.requestSitesForOrganization(orgId) sitesResult.sites.forEach { site -> println("Site: ${site.name}") } 5. Query assets for a site: kotlin val assetsResult = sitesSession.requestAssetsForSite(siteId) assetsResult.assets.forEach { asset -> println("Asset: ${asset.name} (${asset.type})") } 6. Clean up when done: kotlin sitesSession.close() |
| 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 |
|---|---|---|
| AssetInfo | AssetInfo | Represents asset information from the Sites Manager service. Maps to proto messages AssetRecord, AssetData, and AssetComputedValues. |
| 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. |
| SiteInfo | SiteInfo | Represents site information from the Sites Manager service. |
| SiteResult | SiteResult | Result of a site request from the Sites Manager service. |
| 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. Maps to proto enum AssetDeploymentType. |
| AssetPipelineJobStatus | AssetPipelineJobStatus | Asset pipeline job status. Maps to proto enum AssetPipelineJobStatus. |
| AssetStatusType | AssetStatusType | Asset status. Maps to proto enum AssetStatusType. |
| AssetType | AssetType | Asset type - determines which typed asset data is present. Maps to proto enum AssetType. |
| 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. |