Skip to main content
←API Reference ←com.nianticspatial.nsdk.sites

SitesSession

↳ extends SessionBase

Declaration​

class SitesSession

Summary​

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.

See also​

  • requestSelfUserInfo
  • requestOrganizationsForUser
  • requestSitesForOrganization
  • requestAssetsForSite

Functions​

NameTypeSummary
onDestroyvoid
-
onInitvoid
-
requestAssetInfoAssetResult
Requests asset information by asset ID.
requestAssetsForSiteAssetResult
Requests all assets for a site.
requestOrganizationInfoOrganizationResult
Requests organization information by organization ID.
requestOrganizationsForUserOrganizationResult
Requests all organizations for a user.
Consider using [requestSelfOrganizationInfo] instead.
requestScanInfoScanResult
Requests one scan's information.
requestScansForSiteScanResult
Requests every scan of a site, of all types and statuses.
Filter on [ScanInfo.scanType] for [ScanType.VALIDATION] to find scans that playback opens.
requestSelfOrganizationInfoOrganizationResult
Requests organizations for the current authenticated session.
requestSelfUserInfoUserResult
Requests information for the currently authenticated user.
Uses the user ID from the access token to fetch user information.
To fetch organizations, consider using [requestSelfOrganizationInfo] instead.
requestSiteAssetsByLocationSiteAssetsResult
Requests sites and assets near a GPS coordinate.
requestSiteInfoSiteResult
Requests site information by site ID.
requestSitesForOrganizationSiteResult
Requests all sites for an organization.
requestUserInfoUserResult
Requests user information by user ID.