Skip to main content
←API Reference ←NSDK ←NSDKSitesSession

requestScanInfo

Requests one scan's information and waits for the result.

Declaration​

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

Summary​

Requests one scan's information and waits for the result.

Returns​

A ScanResult containing the single scan.

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.

Parameters​

NameTypeSummary
scanIdString
The scan ID to query.
pollingIntervalTimeInterval
The interval between status checks (default: 0.5 seconds).
timeoutTimeInterval
Maximum time to wait for completion (default: 60 seconds).