GeoClass | amplify-js

Hierarchy

InternalGeoClass
- GeoClass

Index

Constructors

constructor

Properties

MODULE

Methods

Constructors

constructor

new GeoClass(): GeoClass

Inherited from InternalGeoClass.constructor
- Defined in packages/geo/src/internals/InternalGeo.ts:43
Returns GeoClass

Properties

Static MODULE

MODULE: string = "Geo"

Methods

addPluggable

addPluggable(pluggable: GeoProvider): object

Inherited from InternalGeoClass.addPluggable
- Defined in packages/geo/src/internals/InternalGeo.ts:63
add plugin into Geo category

Parameters
- pluggable: GeoProvider
  
  an instance of the plugin
Returns object

configure

configure(config?: any): GeoConfig

Inherited from InternalGeoClass.configure
- Defined in packages/geo/src/internals/InternalGeo.ts:104
Configure Geo

Parameters
- Optional config: any
  
  Configuration object for Geo
Returns GeoConfig
- Current configuration

deleteGeofences

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

Overrides InternalGeoClass.deleteGeofences
- Defined in packages/geo/src/Geo.ts:133
Delete geofences

Parameters
- geofenceIds: string | string[]
- Optional options: 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[]

Inherited from InternalGeoClass.getAvailableMaps
- Defined in packages/geo/src/internals/InternalGeo.ts:127
Get the map resources that are currently available through the provider

Parameters
- Default value provider: string = DEFAULT_PROVIDER
Returns MapStyle[]
- Array of available map resources

getDefaultMap

getDefaultMap(provider?: string): MapStyle

Inherited from InternalGeoClass.getDefaultMap
- Defined in packages/geo/src/internals/InternalGeo.ts:138
Get the map resource set as default in amplify config

Parameters
- Default value provider: string = DEFAULT_PROVIDER
Returns MapStyle
- Map resource set as the default in amplify config

getGeofence

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

Overrides InternalGeoClass.getGeofence
- Defined in packages/geo/src/Geo.ts:105
Get a single geofence by geofenceId

Parameters
- geofenceId: GeofenceId
- Optional options: GeofenceOptions
Returns Promise<Geofence>

Promise - Promise that resolves to a geofence object

getModuleName

getModuleName(): string

Overrides InternalGeoClass.getModuleName
- Defined in packages/geo/src/Geo.ts:28
get the name of the module category

Returns string

name of the module category

getPluggable

getPluggable(providerName: string): GeoProvider

Inherited from InternalGeoClass.getPluggable
- Defined in packages/geo/src/internals/InternalGeo.ts:78
Get the plugin object

Parameters
- providerName: string
  
  the name of the plugin
Returns GeoProvider

listGeofences

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

Overrides InternalGeoClass.listGeofences
- Defined in packages/geo/src/Geo.ts:119
List geofences

Parameters
- Optional options: ListGeofenceOptions
Returns Promise<ListGeofenceResults>
- Promise that resolves to an object with: entries: list of geofences - 100 geofences are listed per page nextToken: token for next page of geofences

removePluggable

removePluggable(providerName: string): void

Inherited from InternalGeoClass.removePluggable
- Defined in packages/geo/src/internals/InternalGeo.ts:92
Remove the plugin object

Parameters
- providerName: string
  
  the name of the plugin
Returns void

saveGeofences

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

Overrides InternalGeoClass.saveGeofences
- Defined in packages/geo/src/Geo.ts:92
Create geofences

Parameters
- geofences: GeofenceInput | GeofenceInput[]
  
  Single or array of geofence objects to create
- Optional options: GeofenceOptions
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>

Overrides InternalGeoClass.searchByCoordinates
- Defined in packages/geo/src/Geo.ts:77
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: string, options?: searchByPlaceIdOptions): Promise<Place>

Overrides InternalGeoClass.searchByPlaceId
- Defined in packages/geo/src/Geo.ts:64
Search for location by unique ID

Parameters
- placeId: string
  
  Unique ID of the location that is to be searched for
- Optional options: searchByPlaceIdOptions
Returns Promise<Place>
- Resolves to a place with the given placeId

searchByText

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

Overrides InternalGeoClass.searchByText
- Defined in packages/geo/src/Geo.ts:38
Search by text input with optional parameters

Parameters
- text: string
  
  The text string that is to be searched for
- Optional options: SearchByTextOptions
Returns Promise<Place[]>
- Promise resolves to a list of Places that match search parameters

searchForSuggestions

searchForSuggestions(text: string, options?: SearchByTextOptions): Promise<object[]>

Overrides InternalGeoClass.searchForSuggestions
- Defined in packages/geo/src/Geo.ts:51
Search for search term suggestions based on input text

Parameters
- text: string
  
  The text string that is to be search for
- Optional options: SearchByTextOptions
Returns Promise<object[]>
- Resolves to an array of search suggestion strings