Skip to main content
←API Reference ←NSDK ←NSDKSitesSession

requestScansForSite


Declaration​

func requestScansForSite(siteId: String, pollingInterval: TimeInterval = 0.5, timeout: TimeInterval = 60.0) async throws -> ScanResult

Summary​

Requests every scan of a site, of all types and statuses, and waits for the result.
Filter on ScanInfo/scanType for ScanType/validation to find scans that playback
opens.

Returns​

A ScanResult containing the site's scans.

Throws​

  • CancellationError if the Task running this function was cancelled.
  • TimeoutError if the function timed out before it could complete execution.
  • SitesResult.Error if there was an error specific to the network query. A token scoped to site-assets:read cannot list scans and gets .httpForbidden.

Parameters​

NameTypeSummary
siteIdString
The site ID to list scans for.
pollingIntervalTimeInterval
The interval between status checks (default: 0.5 seconds).
timeoutTimeInterval
Maximum time to wait for completion (default: 60 seconds).