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

requestScanInfo

Requests one scan's information.

Declaration​

suspend fun requestScanInfo( scanId: String, timeoutMs: Long = DEFAULT_TIMEOUT_MS ): ScanResult

Summary​

Requests one scan's information.

Returns​

ScanResult containing the single scan.

Throws​

  • SitesException — if the request fails with an error.
  • kotlinx.coroutines.CancellationException — if the coroutine is cancelled.

Parameters​

NameTypeSummary
scanIdString
The scan ID to query.
timeoutMsLong
Maximum time to wait for the request to complete.