Class GeoClass

constructor

• new GeoClass(ctx?: AmplifyContext): GeoClass

  Parameters

  • Optionalctx: AmplifyContext

  Returns GeoClass

StaticMODULE

addPluggable

• addPluggable(pluggable: GeoProvider): void

  add plugin into Geo category

  Parameters

  • pluggable: GeoProvider

    an instance of the plugin

  Returns void

deleteGeofences

• deleteGeofences(
      geofenceIds: string | string[],
      options?: GeofenceOptions,
  ): Promise<DeleteGeofencesResults>

  Delete geofences

  Parameters

  • geofenceIds: string | string[]

    string|string[]

  • Optionaloptions: GeofenceOptions

    GeofenceOptions

  Returns Promise<DeleteGeofencesResults>

  • Promise that resolves to an object with: successes: list of geofences successfully deleted errors: list of geofences that failed to delete

getAvailableMaps

• getAvailableMaps(provider?: string): MapStyle[]

  Get the map resources that are currently available through the provider

  Parameters

  • provider: string = DEFAULT_PROVIDER

  Returns MapStyle[]

  • Array of available map resources

getDefaultMap

• getDefaultMap(provider?: string): MapStyle

  Get the map resource set as default in amplify config

  Parameters

  • provider: string = DEFAULT_PROVIDER

  Returns MapStyle

  • Map resource set as the default in amplify config

getGeofence

• getGeofence(geofenceId: string, options?: GeofenceOptions): Promise<Geofence>

  Get a single geofence by geofenceId

  Parameters

  • geofenceId: string

    The string id of the geofence to get

  • Optionaloptions: GeofenceOptions

    Optional parameters for getting a geofence

  Returns Promise<Geofence>

  Promise - Promise that resolves to a geofence object

getModuleName

• getModuleName(): string

  get the name of the module category

  Returns string

  name of the module category

getPluggable

• getPluggable(providerName: string): GeoProvider

  Get the plugin object

  Parameters

  • providerName: string

    the name of the plugin

  Returns GeoProvider

listGeofences

• listGeofences(options?: ListGeofenceOptions): Promise<ListGeofenceResults>

  List geofences

  Parameters

  • Optionaloptions: ListGeofenceOptions

    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

removePluggable

• removePluggable(providerName: string): void

  Remove the plugin object

  Parameters

  • providerName: string

    the name of the plugin

  Returns void

saveGeofences

• saveGeofences(
      geofences: GeofenceInput | GeofenceInput[],
      options?: GeofenceOptions,
  ): Promise<SaveGeofencesResults>

  Create geofences

  Parameters

  • geofences: GeofenceInput | GeofenceInput[]

    Single or array of geofence objects to create

  • Optionaloptions: GeofenceOptions

    Optional parameters for creating geofences

  Returns Promise<SaveGeofencesResults>

  • Promise that resolves to an object with: 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>

  Search for location by unique ID

  Parameters

  • placeId: string

    Unique ID of the location that is to be searched for

  • Optionaloptions: searchByPlaceIdOptions

    Optional parameters to the search

  Returns Promise<Place | undefined>

  • Resolves to a place with the given placeId

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 search term suggestions based on input text

  Parameters

  • text: string

    The text string that is to be search for

  • Optionaloptions: SearchByTextOptions

    Optional parameters to the search

  Returns Promise<SearchForSuggestionsResults>

  a Promise of SearchForSuggestionsResults that resolves to an array of search suggestion strings