MapAPI 1.4

Class: IWMaptripRemote

IWMaptripRemote

A class interacting with MapTrip remotely. It creates a MapTrip Remote interface and allows for interacting with accounts, orders and devices using MapTrip

new IWMaptripRemote()

Methods

getDeviceCurrentRoute(deviceId, payload)

Makes a HTTP request to infoware's NaviServer to retrieve the geometry of the current route the device is driving on
Parameters:
Name Type Description
deviceId string
payload any
Fires:
Returns:
Type
void

getDevices(orderId, token, payload)

Makes a HTTP request to infoware's LicenseServer to retrieve a list of devices belonging to a certain order
Parameters:
Name Type Description
orderId number
token string
payload payload
Deprecated:
  • - Replaced by getUserDevices
Fires:
Returns:
Type
void

getDevicesStatus(devicesIDS, payload)

Makes a HTTP request to infoware's NaviServer to retrieve the status of the selected devices
Parameters:
Name Type Description
devicesIDS Array.<string>
payload any
Fires:
Returns:
Type
void

getOrders(token, includeDevices, includePermissions, payload)

Makes a HTTP request to infoware's LicenseServer to retrieve a list of orders belonging to the user
Parameters:
Name Type Description
token string
includeDevices boolean
includePermissions boolean
payload any
Fires:
Returns:
Type
void

getPermissions(orderId, token, payload)

Makes a HTTP request to infoware's LicenseServer to retrieve a list of permissions belonging to a certain order
Parameters:
Name Type Description
orderId number
token string
payload any
Fires:
Returns:
Type
void

getUserDevices(token, payload)

Makes a HTTP request to infoware's LicenseServer to retrieve a list of devices belonging to the user making the request
Parameters:
Name Type Description
token string
payload payload
Fires:
Returns:
Type
void

login(username, password, payload)

Makes a HTTP login request to infoware's LicenseServer
Parameters:
Name Type Description
username string
password string
payload any
Fires:
Returns:
Type
void

logout(token, payload)

Makes a HTTP logout request to infoware's LicenseServer
Parameters:
Name Type Description
token string
payload any
Fires:
Returns:
Type
void

optimizeSequence(addresses, mode, mobility_profile, payload)

Gets a list of addresses and returns them in an optimized order
Parameters:
Name Type Description
addresses Array.<IWAddress>
mode string
mobility_profile string
payload any
Fires:
Returns:
Type
void

sendAddressToDevice(deviceId, addresses, message, payload)

Sends one or more addresses to a device. The device will follow the addresses in the order they were sent
Parameters:
Name Type Description
deviceId string
addresses IWAddress | array
message string
payload any
Fires:
Returns:
Type
void

sendReferenceRouteToDevice(deviceId, coordinates, message, payload)

Sends a reference route to a device
Parameters:
Name Type Description
deviceId string
coordinates IWCoordinate | array
message string
payload any
Fires:
Returns:
Type
void

Events

deviceCurrentRoute

Creates a new IWMaptripRemote event to retrieve the current route of the specified device.

devices

Creates a new IWMaptripRemote event to return the devices for a specific order event.

devices

Creates a new IWMaptripRemote event to return the devices of a certain user.

devicesStatus

Creates a new IWMaptripRemote to retrieve the status of the specified devices.

login

Creates a new IWMaptripRemote login event.

logout

Creates a new IWMaptripRemote logout response event.

optimizeSequence

Creates a new IWMaptripRemote Optimize Sequence event.

orders

Creates a new IWMaptripRemote (retrieve) orders event.

permissions

Creates a new IWMaptripRemote event to return the permissions for a specific order.

sendAddress

Creates a new IWMaptripRemote to retrieve the status of the specified devices.

sendReferenceRoute

Creates a new IWMaptripRemote request to send a reference route to one device