Class AmazonLocationServiceProvider

constructor

• new AmazonLocationServiceProvider(config?): AmazonLocationServiceProvider

• Initialize Geo with AWS configurations

  Parameters

  • Optional config: GeoConfig

    Configuration object for Geo

  Returns AmazonLocationServiceProvider

Static CATEGORY

Static PROVIDER_NAME

deleteGeofences

• deleteGeofences(geofenceIds, options?): Promise<AmazonLocationServiceDeleteGeofencesResults>

• Delete geofences from a geofence collection

  Parameters

  • geofenceIds: string[]

    string|string[]

  • Optional options: AmazonLocationServiceGeofenceOptions

    GeofenceOptions

  Returns Promise<AmazonLocationServiceDeleteGeofencesResults>

  a promise that resolves to an object that conforms to AmazonLocationServiceDeleteGeofencesResults: successes: list of geofences successfully deleted errors: list of geofences that failed to delete

getAvailableMaps

• getAvailableMaps(): AmazonLocationServiceMapStyle[]

• Get the map resources that are currently available through the provider

  Returns AmazonLocationServiceMapStyle[]

  • Array of available map resources

getCategory

• getCategory(): string

• get the category of the plugin

  Returns string

  name of the category

getDefaultMap

• getDefaultMap(): AmazonLocationServiceMapStyle

• Get the map resource set as default in amplify config

  Returns AmazonLocationServiceMapStyle

  • Map resource set as the default in amplify config

getGeofence

• getGeofence(geofenceId, options?): Promise<AmazonLocationServiceGeofence>

• Get geofence from a geofence collection

  Parameters

  • geofenceId: string

    string

  • Optional options: AmazonLocationServiceGeofenceOptions

    Optional parameters for getGeofence

  Returns Promise<AmazonLocationServiceGeofence>

  • Promise that resolves to a geofence object

getProviderName

• getProviderName(): string

• get provider name of the plugin

  Returns string

  name of the provider

listGeofences

• listGeofences(options?): Promise<ListGeofenceResults>

• List geofences from a geofence collection

  Parameters

  • Optional options: AmazonLocationServiceListGeofenceOptions

    ListGeofenceOptions

  Returns Promise<ListGeofenceResults>

  a promise that resolves to an object that conforms to ListGeofenceResults: entries: list of geofences - 100 geofences are listed per page nextToken: token for next page of geofences

saveGeofences

• saveGeofences(geofences, options?): Promise<SaveGeofencesResults>

• Create geofences inside of a geofence collection

  Parameters

  • geofences: GeofenceInput[]

    Array of geofence objects to create

  • Optional options: AmazonLocationServiceGeofenceOptions

    Optional parameters for creating geofences

  Returns Promise<SaveGeofencesResults>

  a promise that resolves to an object that conforms to SaveGeofencesResults: successes: list of geofences successfully created errors: list of geofences that failed to create

searchByCoordinates

• searchByCoordinates(coordinates, options?): Promise<Place>

• Reverse geocoding search via a coordinate point on the map

  Parameters

  • coordinates: Coordinates

    Coordinates array for the search input

  • Optional options: SearchByCoordinatesOptions

    Options parameters for the search

  Returns Promise<Place>

  • Promise that resolves to a place matching search coordinates

searchByPlaceId

• searchByPlaceId(placeId, options?): Promise<undefined | Place>

• Parameters

  • placeId: string

  • Optional options: searchByPlaceIdOptions

  Returns Promise<undefined | Place>

searchByText

• searchByText(text, options?): Promise<Place[]>

• Search by text input with optional parameters

  Parameters

  • text: string

    The text string that is to be searched for

  • Optional options: SearchByTextOptions

    Optional parameters to the search

  Returns Promise<Place[]>

  • Promise resolves to a list of Places that match search parameters

searchForSuggestions

• searchForSuggestions(text, options?): Promise<SearchForSuggestionsResults>

• Search for suggestions based on the input text

  Parameters

  • text: string

    The text string that is to be searched for

  • Optional options: SearchByTextOptions

    Optional parameters to the search

  Returns Promise<SearchForSuggestionsResults>

  • Resolves to an array of search suggestion strings