Skip to main content
←API Reference ←SwiftyNsdk

NsdkVpsCoverageSession

A session object for querying Visual Positioning System (VPS) coverage data related resources.

Declaration​

final class NsdkVpsCoverageSession

Methods​

NameTypeSummary
requestAreaTargetsAreaTargetResult
Requests all available area targets within a specified radius.
Starts a network request to fetch nearby area targets and suspends until
the operation completes, fails, or times out.
- Parameters:
- locationLatLng: The center coordinates of the search area.
- searchRadius: The radius in meters to search for area targets.
- timeout: Maximum duration to wait for a result. Default is 60 seconds.
- pollingInterval: Interval between progress checks. Default is 0.5 seconds.
- Returns: An AreaTargetResult containing area target 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.
requestCoverageAreasCoverageAreaResult
Requests VPS coverage areas within a specified radius around the given location.
Initiates a network request and suspends until the result is available,
the operation fails, or the timeout is reached.
- Parameters:
- locationLatLng: The center coordinates of the search area.
- searchRadius: The radius in meters around the center to search for coverage areas.
- timeout: Maximum time to wait for completion. Default is 60 seconds.
- pollingInterval: Interval between completion checks. Default is 0.5 seconds.
- Returns: A CoverageAreaResult containing coverage area information.
- 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.
requestHintImageHintImageResult
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.
requestLocalizationTargetsLocalizationTargetResult
Requests detailed information about specific localization targets.
Starts a network request for the given target identifiers and suspends
until the request completes successfully, fails, or times out.
- Parameters:
- targetIdentifiers: A list of localization target identifiers to query.
- timeout: Maximum time to wait for completion. Default is 60 seconds.
- pollingInterval: Interval between completion checks. Default is 0.5 seconds.
- Returns: A LocalizationTargetResult containing target details.
- 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