Skip to main content
API Reference SwiftyNsdk NsdkVpsCoverageSession

requestHintImage

Downloads the hint image associated with a localization target....

Declaration

func requestHintImage(url: String, timeout: TimeInterval = 60.0, pollingInterval: TimeInterval = 0.5) async throws -> HintImageResult

Summary

Downloads the hint image associated with a localization target.
Starts a network request for the specified hint image URL and suspends
until the operation completes, fails, or times out.
- Parameters:
- url: The remote URL of the hint image to download.
- timeout: Maximum duration to wait for completion. Default is 60 seconds.
- pollingInterval: Interval between progress checks. Default is 0.5 seconds.
- Returns: A HintImageResult containing the downloaded image data.
- Throws:
- CancellationError if the Task running this function was cancelled.
- TimeoutError if the function timed out before it could complete execution.
- VpsCoverageResult.Error if there was an error specific to the VPS Coverage
query.


ON THIS PAGE