GeoProvider | amplify-js

Hierarchy

GeoProvider

Implemented by

AmazonLocationServiceProvider

Index

Methods

Methods

configure

configure(config: object): object

- Defined in packages/geo/src/types/Provider.ts:30
Parameters
- config: object
Returns object

deleteGeofences

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

- Defined in packages/geo/src/types/Provider.ts:85
Parameters
- geofenceIds: string[]
- Optional options: GeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<DeleteGeofencesResults>

getAvailableMaps

getAvailableMaps(): MapStyle[]

- Defined in packages/geo/src/types/Provider.ts:33
Returns MapStyle[]

getCategory

getCategory(): string

- Defined in packages/geo/src/types/Provider.ts:24
Returns string

getDefaultMap

getDefaultMap(): MapStyle

- Defined in packages/geo/src/types/Provider.ts:36
Returns MapStyle

getGeofence

getGeofence(geofenceId: GeofenceId, options?: ListGeofenceOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<Geofence>

- Defined in packages/geo/src/types/Provider.ts:72
Parameters
- geofenceId: GeofenceId
- Optional options: ListGeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<Geofence>

getProviderName

getProviderName(): string

- Defined in packages/geo/src/types/Provider.ts:27
Returns string

listGeofences

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

- Defined in packages/geo/src/types/Provider.ts:79
Parameters
- Optional options: ListGeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<ListGeofenceResults>

saveGeofences

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

- Defined in packages/geo/src/types/Provider.ts:65
Parameters
- geofences: GeofenceInput[]
- Optional options: GeofenceOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<SaveGeofencesResults>

searchByCoordinates

searchByCoordinates(coordinates: Coordinates, options?: SearchByCoordinatesOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<Place>

- Defined in packages/geo/src/types/Provider.ts:46
Parameters
- coordinates: Coordinates
- Optional options: SearchByCoordinatesOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<Place>

searchByPlaceId

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

- Defined in packages/geo/src/types/Provider.ts:58
Parameters
- placeId: string
- Optional options: searchByPlaceIdOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<Place | undefined>

searchByText

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

- Defined in packages/geo/src/types/Provider.ts:39
Parameters
- text: string
- Optional options: SearchByTextOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<Place[]>

searchForSuggestions

searchForSuggestions(text: string, options?: SearchByTextOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<SearchForSuggestionsResults>

- Defined in packages/geo/src/types/Provider.ts:52
Parameters
- text: string
- Optional options: SearchByTextOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<SearchForSuggestionsResults>