Constructors

Properties

MODULE: string = 'Geo'

Methods

  • add plugin into Geo category

    Parameters

    Returns void

  • Delete geofences

    Parameters

    • geofenceIds: string | string[]

      string|string[]

    • Optional options: 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
  • Get the map resources that are currently available through the provider

    Parameters

    • provider: string = DEFAULT_PROVIDER

    Returns MapStyle[]

    • Array of available map resources
  • 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
  • Get a single geofence by geofenceId

    Parameters

    • geofenceId: string

      The string id of the geofence to get

    • Optional options: GeofenceOptions

      Optional parameters for getting a geofence

    Returns Promise<Geofence>

    Promise - Promise that resolves to a geofence object

  • get the name of the module category

    Returns string

    name of the module category

  • Get the plugin object

    Parameters

    • providerName: string

      the name of the plugin

    Returns GeoProvider

  • Remove the plugin object

    Parameters

    • providerName: string

      the name of the plugin

    Returns void

  • Create geofences

    Parameters

    Returns Promise<SaveGeofencesResults>

    • Promise that resolves to an object with: successes: list of geofences successfully created errors: list of geofences that failed to create
  • Reverse geocoding search via a coordinate point on the map

    Parameters

    Returns Promise<Place>

    • Promise that resolves to a place matching search coordinates
  • Search for location by unique ID

    Parameters

    • placeId: string

      Unique ID of the location that is to be searched for

    • Optional options: searchByPlaceIdOptions

      Optional parameters to the search

    Returns Promise<undefined | Place>

    • Resolves to a place with the given placeId
  • 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