Class AmazonLocationServiceProvider

constructor

• new AmazonLocationServiceProvider(
      config?: GeoConfig,
      ctx?: AmplifyContext,
  ): AmazonLocationServiceProvider

  Initialize Geo with AWS configurations

  Parameters

  • Optionalconfig: GeoConfig

    Configuration object for Geo

  • Optionalctx: AmplifyContext

    The AmplifyContext to use for auth and config. When provided, the provider is pinned to this context. When omitted, the provider resolves the global context lazily per operation.

  Returns AmazonLocationServiceProvider

StaticCATEGORY

StaticPROVIDER_NAME

deleteGeofences

• deleteGeofences(
      geofenceIds: string[],
      options?: AmazonLocationServiceGeofenceOptions,
  ): Promise<AmazonLocationServiceDeleteGeofencesResults>

  Delete geofences from a geofence collection

  Parameters

  • geofenceIds: string[]

    string|string[]

  • Optionaloptions: 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: string,
      options?: AmazonLocationServiceGeofenceOptions,
  ): Promise<AmazonLocationServiceGeofence>

  Get geofence from a geofence collection

  Parameters

  • geofenceId: string

    string

  • Optionaloptions: 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?: AmazonLocationServiceListGeofenceOptions,
  ): Promise<ListGeofenceResults>

  List geofences from a geofence collection

  Parameters

  • Optionaloptions: 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: GeofenceInput[],
      options?: AmazonLocationServiceGeofenceOptions,
  ): Promise<SaveGeofencesResults>

  Create geofences inside of a geofence collection

  Parameters

  • geofences: GeofenceInput[]

    Array of geofence objects to create

  • Optionaloptions: 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: Coordinates,
      options?: SearchByCoordinatesOptions,
  ): Promise<Place>

  Reverse geocoding search via a coordinate point on the map

  Parameters

  • coordinates: Coordinates

    Coordinates array for the search input

  • Optionaloptions: SearchByCoordinatesOptions

    Options parameters for the search

  Returns Promise<Place>

  • Promise that resolves to a place matching search coordinates

searchByPlaceId

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

  Parameters

  • placeId: string
  • Optionaloptions: searchByPlaceIdOptions

  Returns Promise<Place | undefined>

searchByText

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

  Search by text input with optional parameters

  Parameters

  • text: string

    The text string that is to be searched for

  • Optionaloptions: SearchByTextOptions

    Optional parameters to the search

  Returns Promise<Place[]>

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

searchForSuggestions

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

  Search for suggestions based on the input text

  Parameters

  • text: string

    The text string that is to be searched for

  • Optionaloptions: SearchByTextOptions

    Optional parameters to the search

  Returns Promise<SearchForSuggestionsResults>

  • Resolves to an array of search suggestion strings