interface ICoverageClient (Niantic.ARDK.VPSCoverage.ICoverageClient)

Overview

Client to request CoverageAreas and LocalizationTargets. More…

interface ICoverageClient {
    // methods

    void RequestCoverageAreas(
        LatLng queryLocation,
        int queryRadius,
        Action<CoverageAreasResult> onAreasReceived
    );

    void RequestCoverageAreas(
        LocationInfo queryLocation,
        int queryRadius,
        Action<CoverageAreasResult> onAreasReceived
    );

    Task<CoverageAreasResult> RequestCoverageAreasAsync(
        LatLng queryLocation,
        int queryRadius
    );

    Task<CoverageAreasResult> RequestCoverageAreasAsync(
        LocationInfo queryLocation,
        int queryRadius
    );

    void RequestLocalizationTargets(
        string[] targetIdentifiers,
        Action<LocalizationTargetsResult> onTargetsReceived
    );

    Task<LocalizationTargetsResult> RequestLocalizationTargetsAsync(string[] targetIdentifiers);
};

Detailed Documentation

Client to request CoverageAreas and LocalizationTargets.

Methods

void RequestCoverageAreas(
    LatLng queryLocation,
    int queryRadius,
    Action<CoverageAreasResult> onAreasReceived
)

Request CoverageAreas at device location within a radius using the callback pattern.

Parameters:

queryLocation	Center of query.
queryRadius	Radius for query between 0m and 2000m. Negative radius will default to the maximum radius of 2000m.
onAreasReceived	Callback function to process the received CoverageAreasResult.

void RequestCoverageAreas(
    LocationInfo queryLocation,
    int queryRadius,
    Action<CoverageAreasResult> onAreasReceived
)

Request CoverageAreas at device location within a radius using the callback pattern.

Parameters:

queryLocation	Center of query from device location.
queryRadius	Radius for query between 0m and 2000m. Negative radius will default to the maximum radius of 2000m.
onAreasReceived	Callback function to process the received CoverageAreasResult.

Task<CoverageAreasResult> RequestCoverageAreasAsync(
    LatLng queryLocation,
    int queryRadius
)

Request CoverageAreas at any location within a radius using the async await pattern.

Parameters:

queryLocation	Center of query.
queryRadius	Radius for query between 0m and 2000m. Negative radius will default to the maximum radius of 2000m.

Returns:

Task with the received CoverageAreasResult as result.

Task<CoverageAreasResult> RequestCoverageAreasAsync(
    LocationInfo queryLocation,
    int queryRadius
)

Request CoverageAreas at device location within a radius using the async await pattern.

Parameters:

queryLocation	Center of query from device location.
queryRadius	Radius for query between 0m and 2000m. Negative radius will default to the maximum radius of 2000m.

Returns:

Task with the received CoverageAreasResult as result.

void RequestLocalizationTargets(
    string[] targetIdentifiers,
    Action<LocalizationTargetsResult> onTargetsReceived
)

Request LocalizationTargets for a set of identifiers using the callback pattern.

Parameters:

targetIdentifiers	Set of unique identifiers of the requested targets.
onTargetsReceived	Callback function to process the received LocalizationTargetsResult.

Task<LocalizationTargetsResult> RequestLocalizationTargetsAsync(string[] targetIdentifiers)

Request LocalizationTargets for a set of identifiers using the async await pattern.

Parameters:

targetIdentifiers

Set of unique identifiers of the requested targets.

Returns:

Task with the received LocalizationTargetsResult as result.