InternalGeoClass | amplify-js

Hierarchy

InternalGeoClass
- GeoClass

Index

Constructors

constructor

Properties

MODULE

Methods

Constructors

constructor

new InternalGeoClass(): InternalGeoClass

- Defined in packages/geo/src/internals/InternalGeo.ts:43
Returns InternalGeoClass

Properties

Static MODULE

MODULE: string = "InternalGeo"

Methods

addPluggable

addPluggable(pluggable: GeoProvider): object

- 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

- 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, customUserAgentDetails?: CustomUserAgentDetails): Promise<DeleteGeofencesResults>

- Defined in packages/geo/src/internals/InternalGeo.ts:359
Delete geofences

Parameters
- geofenceIds: string | string[]
- Optional options: GeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  Optional parameter to send user agent details
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[]

- 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

- 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, customUserAgentDetails?: CustomUserAgentDetails): Promise<Geofence>

- Defined in packages/geo/src/internals/InternalGeo.ts:304
Get a single geofence by geofenceId

Parameters
- geofenceId: GeofenceId
- Optional options: GeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  Optional parameter to send user agent details
Returns Promise<Geofence>

Promise - Promise that resolves to a geofence object

getModuleName

getModuleName(): string

- Defined in packages/geo/src/internals/InternalGeo.ts:55
get the name of the module category

Returns string

name of the module category

getPluggable

getPluggable(providerName: string): GeoProvider

- 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, customUserAgentDetails?: CustomUserAgentDetails): Promise<ListGeofenceResults>

- Defined in packages/geo/src/internals/InternalGeo.ts:332
List geofences

Parameters
- Optional options: ListGeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  Optional parameter to send user agent details
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

- 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, customUserAgentDetails?: CustomUserAgentDetails): Promise<SaveGeofencesResults>

- Defined in packages/geo/src/internals/InternalGeo.ts:269
Create geofences

Parameters
- geofences: GeofenceInput | GeofenceInput[]
  
  Single or array of geofence objects to create
- Optional options: GeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  Optional parameter to send user agent details
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, customUserAgentDetails?: CustomUserAgentDetails): Promise<Place>

- Defined in packages/geo/src/internals/InternalGeo.ts:238
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
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  Optional parameter to send user agent details
Returns Promise<Place>
- Promise that resolves to a place matching search coordinates

searchByPlaceId

searchByPlaceId(placeId: string, options?: searchByPlaceIdOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<Place>

- Defined in packages/geo/src/internals/InternalGeo.ts:208
Search for location by unique ID

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

searchByText

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

- Defined in packages/geo/src/internals/InternalGeo.ts:151
Search by text input with optional parameters

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

searchForSuggestions

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

- Defined in packages/geo/src/internals/InternalGeo.ts:178
Search for search term suggestions based on input text

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns InternalGeoClass

Properties

Static MODULE

Methods

addPluggable

Parameters

pluggable: GeoProvider

Returns object

configure

Parameters

Optional config: any

Returns GeoConfig

deleteGeofences

Parameters

geofenceIds: string | string[]

Optional options: GeofenceOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<DeleteGeofencesResults>

getAvailableMaps

Parameters

Default value provider: string = DEFAULT_PROVIDER

Returns MapStyle[]

getDefaultMap

Parameters

Default value provider: string = DEFAULT_PROVIDER

Returns MapStyle

getGeofence

Parameters

geofenceId: GeofenceId

Optional options: GeofenceOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<Geofence>

getModuleName

Returns string

getPluggable

Parameters

providerName: string

Returns GeoProvider

listGeofences

Parameters

Optional options: ListGeofenceOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<ListGeofenceResults>

removePluggable

Parameters

providerName: string

Returns void

saveGeofences

Parameters

geofences: GeofenceInput | GeofenceInput[]

Optional options: GeofenceOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<SaveGeofencesResults>

searchByCoordinates

Parameters

coordinates: Coordinates

Optional options: SearchByCoordinatesOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<Place>

searchByPlaceId

Parameters

placeId: string

Optional options: searchByPlaceIdOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<Place>

searchByText

Parameters

text: string

Optional options: SearchByTextOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<Place[]>

searchForSuggestions

Parameters