AmazonLocationServiceProvider

Hierarchy

AmazonLocationServiceProvider

Implements

GeoProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AmazonLocationServiceProvider(config?: GeoConfig): AmazonLocationServiceProvider

- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:75
Initialize Geo with AWS configurations

Parameters
- Optional config: GeoConfig
  
  Configuration object for Geo
Returns AmazonLocationServiceProvider

Properties

Static CATEGORY

CATEGORY: string = "Geo"

Static PROVIDER_NAME

PROVIDER_NAME: string = "AmazonLocationService"

Methods

configure

configure(config?: any): object

- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:107
Configure Geo part with aws configuration

Parameters
- Optional config: any
  
  Configuration of the Geo
Returns object
- Current configuration

deleteGeofences

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

Implementation of GeoProvider.deleteGeofences
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:658
Delete geofences from a geofence collection

Parameters
- geofenceIds: string[]
- Optional options: AmazonLocationServiceGeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  Optional parameter to send user agent details
Returns Promise<AmazonLocationServiceDeleteGeofencesResults>
- Promise that resolves to an object with: successes: list of geofences successfully deleted errors: list of geofences that failed to delete

getAvailableMaps

getAvailableMaps(): AmazonLocationServiceMapStyle[]

Implementation of GeoProvider.getAvailableMaps
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:118
Get the map resources that are currently available through the provider

Returns AmazonLocationServiceMapStyle[]
- Array of available map resources

getCategory

getCategory(): string

Implementation of GeoProvider.getCategory
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:90
get the category of the plugin

Returns string

name of the category

getDefaultMap

getDefaultMap(): AmazonLocationServiceMapStyle

Implementation of GeoProvider.getDefaultMap
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:137
Get the map resource set as default in amplify config

Returns AmazonLocationServiceMapStyle
- Map resource set as the default in amplify config

getGeofence

getGeofence(geofenceId: GeofenceId, options?: AmazonLocationServiceGeofenceOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<AmazonLocationServiceGeofence>

Implementation of GeoProvider.getGeofence
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:508
Get geofence from a geofence collection

Parameters
- geofenceId: GeofenceId
- Optional options: AmazonLocationServiceGeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  Optional parameter to send user agent details
Returns Promise<AmazonLocationServiceGeofence>
- Promise that resolves to a geofence object

getProviderName

getProviderName(): string

Implementation of GeoProvider.getProviderName
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:98
get provider name of the plugin

Returns string

name of the provider

listGeofences

listGeofences(options?: AmazonLocationServiceListGeofenceOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<ListGeofenceResults>

Implementation of GeoProvider.listGeofences
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:575
List geofences from a geofence collection

Parameters
- Optional options: AmazonLocationServiceListGeofenceOptions
- 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

saveGeofences

saveGeofences(geofences: GeofenceInput[], options?: AmazonLocationServiceGeofenceOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<SaveGeofencesResults>

Implementation of GeoProvider.saveGeofences
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:399
Create geofences inside of a geofence collection

Parameters
- geofences: GeofenceInput[]
  
  Array of geofence objects to create
- Optional options: AmazonLocationServiceGeofenceOptions
- 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>

Implementation of GeoProvider.searchByCoordinates
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:336
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
Returns Promise<Place>
- Promise that resolves to a place matching search coordinates

searchByPlaceId

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

Implementation of GeoProvider.searchByPlaceId
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:288
Parameters
- placeId: string
- Optional options: searchByPlaceIdOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<Place | undefined>

searchByText

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

Implementation of GeoProvider.searchByText
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:154
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<SearchForSuggestionsResults>

Implementation of GeoProvider.searchForSuggestions
- Defined in packages/geo/src/Providers/AmazonLocationServiceProvider.ts:222
Search for suggestions based on the input text

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<SearchForSuggestionsResults>
- Resolves to an array of search suggestion strings

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional config: GeoConfig

Returns AmazonLocationServiceProvider

Properties

Static CATEGORY

Static PROVIDER_NAME

Methods

configure

Parameters

Optional config: any

Returns object

deleteGeofences

Parameters

geofenceIds: string[]

Optional options: AmazonLocationServiceGeofenceOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<AmazonLocationServiceDeleteGeofencesResults>

getAvailableMaps

Returns AmazonLocationServiceMapStyle[]

getCategory

Returns string

getDefaultMap

Returns AmazonLocationServiceMapStyle

getGeofence

Parameters

geofenceId: GeofenceId

Optional options: AmazonLocationServiceGeofenceOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<AmazonLocationServiceGeofence>

getProviderName

Returns string

listGeofences

Parameters

Optional options: AmazonLocationServiceListGeofenceOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<ListGeofenceResults>

saveGeofences

Parameters

geofences: GeofenceInput[]

Optional options: AmazonLocationServiceGeofenceOptions

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 | undefined>

searchByText

Parameters

text: string

Optional options: SearchByTextOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<Place[]>

searchForSuggestions

Parameters

text: string

Optional options: SearchByTextOptions

Optional customUserAgentDetails: CustomUserAgentDetails

Returns Promise<SearchForSuggestionsResults>