GoIndoor module object.
- Source:
Members
(readonly) LocationAlgorithm :number
Enumeration defining the possible algorithms to be used.
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
LOCATION_TYPE_AVERAGE |
number | Weighted average |
LOCATION_TYPE_CLOSEST |
number | Closest Beacon |
LOCATION_TYPE_PROJECT |
number | Weighted average with projection to the closest edge |
- Source:
(readonly) UpdatePolicy :number
Enumeration defining the database update policy.
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
UPDATE_NO |
number | Updates are disabled |
UPDATE_WIFI |
number | Update only over Wifi |
UPDATE_MOBILE |
number | Update only over Mobile data connection |
- Source:
Methods
getPlaces(callbacknon-null, optsopt)
Getter for the place list.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
GoIndoor~setPlacesCallback | Callback to handle the process | |
opts |
GetPlacesOptions |
<optional> |
Advanced configuration options |
- Source:
setConfiguration(accountnon-null, passwordnon-null, callbacknon-null, optsopt)
This function will set all the required configuration to start the GoIndoor module.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
account |
string | Account | |
password |
string | Password | |
callback |
GoIndoor~setConfigurationCallback | Callback to handle the process | |
opts |
ConfigurationOptions |
<optional> |
Advanced configuration options |
- Source:
startLocate(onLocationnon-null, onNotificationnon-null, callbacknon-null)
This function will start the indoor location.
Parameters:
| Name | Type | Description |
|---|---|---|
onLocation |
GoIndoor~onLocationCallback | Callback to handle the user location |
onNotification |
GoIndoor~onNotificationCallback | Callback to handle the triggered notifications |
callback |
GoIndoor~startLocateCallback | Callback to handle the process |
- Source:
stopLocate()
This function will start the indoor location.
- Source:
Type Definitions
onLocationCallback(location)
This callback will handle the user location.
Parameters:
| Name | Type | Description |
|---|---|---|
location |
LocationResult | Object containing the user location |
- Source:
onNotificationCallback(notificationResult)
This callback will handle the triggered notifications.
Parameters:
| Name | Type | Description |
|---|---|---|
notificationResult |
NotificationResult | Object containing the notification and its place |
- Source:
setConfigurationCallback(flag)
This callback will handle the configuration process.
Parameters:
| Name | Type | Description |
|---|---|---|
flag |
boolean | Flag to know whether the set configuration succeed |
- Source:
setPlacesCallback(responsenon-null)
This callback will handle the get Places process.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
response |
object | Response object
Properties
|
- Source:
startLocateCallback(responsenon-null)
This callback will handle the start Locate process.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response |
object | Response object
Properties
|
- Source: