Interface GeoProvider

interface GeoProvider {
    deleteGeofences(geofenceIds, options?): Promise<DeleteGeofencesResults>;
    getAvailableMaps(): MapStyle[];
    getCategory(): string;
    getDefaultMap(): MapStyle;
    getGeofence(geofenceId, options?): Promise<Geofence>;
    getProviderName(): string;
    listGeofences(options?): Promise<ListGeofenceResults>;
    saveGeofences(geofences, options?): Promise<SaveGeofencesResults>;
    searchByCoordinates(coordinates, options?): Promise<Place>;
    searchByPlaceId(placeId, options?): Promise<undefined | Place>;
    searchByText(text, options?): Promise<Place[]>;
    searchForSuggestions(text, options?): Promise<SearchForSuggestionsResults>;
}

Implemented by

AmazonLocationServiceProvider

Index

Methods

deleteGeofences getAvailableMaps getCategory getDefaultMap getGeofence getProviderName listGeofences saveGeofences searchByCoordinates searchByPlaceId searchByText searchForSuggestions

Methods

deleteGeofences

deleteGeofences(geofenceIds, options?): Promise<DeleteGeofencesResults>
Parameters
- geofenceIds: string[]
- Optional options: GeofenceOptions
Returns Promise<DeleteGeofencesResults>

getAvailableMaps

getAvailableMaps(): MapStyle[]
Returns MapStyle[]

getCategory

getCategory(): string
Returns string

getDefaultMap

getDefaultMap(): MapStyle
Returns MapStyle

getGeofence

getGeofence(geofenceId, options?): Promise<Geofence>
Parameters
- geofenceId: string
- Optional options: ListGeofenceOptions
Returns Promise<Geofence>

getProviderName

getProviderName(): string
Returns string

listGeofences

listGeofences(options?): Promise<ListGeofenceResults>
Parameters
- Optional options: ListGeofenceOptions
Returns Promise<ListGeofenceResults>

saveGeofences

saveGeofences(geofences, options?): Promise<SaveGeofencesResults>
Parameters
- geofences: GeofenceInput[]
- Optional options: GeofenceOptions
Returns Promise<SaveGeofencesResults>

searchByCoordinates

searchByCoordinates(coordinates, options?): Promise<Place>
Parameters
- coordinates: Coordinates
- Optional options: SearchByCoordinatesOptions
Returns Promise<Place>

searchByPlaceId

searchByPlaceId(placeId, options?): Promise<undefined | Place>
Parameters
- placeId: string
- Optional options: searchByPlaceIdOptions
Returns Promise<undefined | Place>

searchByText

searchByText(text, options?): Promise<Place[]>
Parameters
- text: string
- Optional options: SearchByTextOptions
Returns Promise<Place[]>

searchForSuggestions

searchForSuggestions(text, options?): Promise<SearchForSuggestionsResults>
Parameters
- text: string
- Optional options: SearchByTextOptions
Returns Promise<SearchForSuggestionsResults>