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

requestScansForSite


Declaration​

suspend fun requestScansForSite( siteId: String, timeoutMs: Long = DEFAULT_TIMEOUT_MS ): ScanResult

Summary​

Requests every scan of a site, of all types and statuses.


Filter on ScanInfo.scanType for ScanType.VALIDATION to find scans that playback opens.

Returns​

ScanResult containing the site's scans.

Throws​

  • SitesException — if the request fails with an error. A token scoped to site-assets:read cannot list scans and fails with SitesError.HTTP_FORBIDDEN.
  • kotlinx.coroutines.CancellationException — if the coroutine is cancelled.

Parameters​

NameTypeSummary
siteIdString
The site ID to list scans for.
timeoutMsLong
Maximum time to wait for the request to complete.