JavaScript API Reference

<script type="text/javascript" src="https://apis.fleetfreedom.com/js/trakit.fleetfreedom.js"></script>

API Utilities
Assets, People, Vehicles, and Trailers
Behaviours
Companies / Organizations
Devices
Dispatch and Tasks
Drawing
Field Forms
File Hosting
Geography
Hours of Service
JSON WebSocket
Maintenance
Messaging
Model-View-Control
- MVCEvent
- MVCObject
Places (POIs / geofences)
- Place
- PlaceShapeType
Reports
Users and Permissions
White-labelling

API Utilities

convert object

A utility library for converting values of one measurement system to another.

Usage

var value = trakit.fleetfreedom.convert.member;
/* or */
var result = trakit.fleetfreedom.convert.member(...params);

Functions
Method	Returns	Description
cToF(/** number */ temperature)	number	Value in Celsius converted to Fahrenheit
fToC(/** number */ temperature)	number	Value in Fahrenheit converted to Celsius
gToL(/** number */ volume)	number	Value in US gallons converted to litres
gUKToL(/** number */ volume)	number	Value in British gallons converted to litres
kgToLbs(/** number */ weight)	number	Value in kilograms converted to pounds.
kmToMi(/** number */ distance)	number	Value in kilometres converted to miles
kpaToPsi(/** number */ pressure)	number	Value in kilo-pascals converted to pounds per square inch.
l100kmToMpg(/** number */ fuelEconomy)	number	Value in miles per gallon converted to litres per 100 kilometres.
l100kmToMpgUK(/** number */ fuelEconomy)	number	Value in miles per British gallon converted to litres per 100 kilometres.
lbsToKg(/** number */ weight)	number	Value in pounds converted to kilograms.
lToG(/** number */ volume)	number	Value in litres converted to US gallons
lToGUK(/** number */ volume)	number	Value in litres converted to British gallons
miToKm(/** number */ distance)	number	Value in miles converted to kilometres
mpgToL100km(/** number */ fuelEconomy)	number	Value in miles per gallon converted to litres per 100 kilometres.
mpgUKToL100km(/** number */ fuelEconomy)	number	Value in miles per British gallon converted to litres per 100 kilometres.
mToYd(/** number */ distance)	number	Value in metres converted to yards
psiToKpa(/** number */ pressure)	number	Value in pounds per square inch converted to kilo-pascals.
ydToM(/** number */ distance)	number	Value in yards converted to metres

encoding object

Convenience methods for encoding to various formats.

Usage

var value = trakit.fleetfreedom.encoding.member;
/* or */
var result = trakit.fleetfreedom.encoding.member(...params);

Functions
Method	Returns	Description
fromBase64(/** string */ base64)	string	Converts a base64 encoded string back to a readable string
fromPassword(/** string */ value)	string	Decodes the given Provider password as a human readable value.
fromUrl(/** string */ url)	string	Decodes a URL encoded string
fromUtf8(/** string */ utf8)	string	Decodes a UTF8 string
toBase64(/** string */ string)	string	Converts a string to base64 encoded string
toPassword(/** string */ value)	string	Encodes the given string as a Provider password.
toUrl(/** string */ string)	string	Converts a string to a valid URL encoded value
toUtf8(/** string */ string)	string	Encodes a string into a valid UTF8 string

utility object

A utility library for exposing handy methods and algorithms.

Usage

var value = trakit.fleetfreedom.utility.member;
/* or */
var result = trakit.fleetfreedom.utility.member(...params);

Values
Property	Type	Default	Description
timezones	Array	undefined	A list of all supported system timezones.

Functions
Method	Returns	Description
arrayOfType(/** Array.<?> / array, /* Object */ klass)	boolean	Checks every object in an array for the instance type. Empty arrays are returned as true.
codify(/** string / input) Throws TypeError* "input value is not a string".	string	Creates a searchable/coded string based on a user inputted string. Quotation marks, apostrophes, and accents are removed.
douglasPeucker(/** Array.<T> / source, /* function / triangleHeight, /* number */ tolerance)	Array.<T>	An implementation of the Ramer-Douglas-Peucker path reduction algorithm. The source array should be more than two items in length, otherwise reduction is pointless. The callback function returns a number (greater than zero) as the triangle height as defiend by three points; first point, middle point, and last point. The "kink" threshold is set using the tolerance argument which must be a number greater than or equal to zero.
escape(/** string */ input)	string	Creates an HTTP safe string for transmission similar to the escape function.
fileSize(/** number / bytes, /* number / places, /* number / maxScale, /* number / groupSize, /* string / groupDelimiter, /* string / decimalDelimiter, /* string */ point)	string	Creates a more human readable string representation of the filesize.
fromPassword(/** string */ value)	string	Decodes the given Provider password as a human readable value.
guid()	string	Delivers a GUID-like string with a mixed in location/refresh unique seed
inherits(/** function / parent, /* function */ child)	function	Creates a JavaScript binding for super-classes
isN(/** ? */ value)	boolean	Opposite of utility#isNaN. Checks to see if the given parameter is a number object, or number literal, and that it is not NaN. This method will return false for values: "", "1234", null, undefined, true, and false.
isNaN(/** ? */ value)	boolean	Similar to isNaN, it checks to see if the given parameter is not a number object, not a number literal, and that it is NaN. This method will return true for values: "", "1234", null, undefined, true, and false.
isNothing(/** ? */ value)	boolean	Checks for both null and undefined
merge(/** Object / target, /* Object / source, /* boolean */ goDeep)	Object	Does a deep copy of values from one object to another
numberGroups(/** number / number, /* number / size, /* string / delimiter, /* string / decimalDelimiter, /* string / point) Throws TypeError* "size must be greater than zero".	string	Groups digits of a number together to make a more human readable version.
parseSearch(/** string */ expression)	Array.<SearchPattern>	Creates an array of SearchPatterns for easier matching. Used for doing OR matching.
parseTime(/** string */ duration)	number	Parses a serialized TimeSpan into a number representing the total seconds. For example the string "1.07:42:03.467" equals 114123.467, which is 1 day, 7 hours, 42 minutes, 3 seconds, and 467 milliseconds.
roundTo(/** number / number, /* number */ places)	number	Rounds a number to the desired number of decimal places. Using a negative places value will round to the nearest ten.
stringifyTime(/** number */ value)	string	Parses a number representing the total seconds into a serialized TimeSpan string. For example the number 114123.467 would be serialized as "1.07:42:03.467".
unescape(/** string */ input)	string	Similar to the unescape function, it will decode a string encoded using utility#escape.

version object

The version number of this JavaScript library.

Usage

var value = trakit.fleetfreedom.version.member;
/* or */
var result = trakit.fleetfreedom.version.member(...params);

Collection class

Similar to the ECMA6 Set class. A Collection is like an array, but without duplicate values.

Usage

var object = new trakit.fleetfreedom.Collection(/** Object */ iterable);

Properties
Property	Type	Description
size	number	The number of objects in the Collection.

Functions
Method	Returns	Description
add(/** V */ value)	boolean	Adds the value to the Collection. Returns boolean indicating whether the value was newly added.
clear()		Removes all values from the Collection.
concat(/** Collection \| Set */ var_args)	Collection	Creates a new Collection, and adds or overwrites the keys with the other given Collections.
filter(/** function / predicate, /* Object */ context)	Collection	Builds a new Collection with only the positive results from the predicate.
forEach(/** function / predicate, /* Object */ context)		Iterates through all the values in the Collection.
has(/** V */ value)	boolean	Returns a boolean asserting whether a value has been added to the Collection or not.
remove(/** V */ value)	boolean	Removes the value in the Collection. After such a call, Collection#has(key) will return false.
toArray()	Array	Returns an Array with all the values from this Collection.
toJSON()	Array	Creates an Array literal of this Collection. Values use their toJSON method (if present), NaNs are converted to nulls, and "undefined"s are not added.

Dictionary class

Similar to the ECMA6 Map class. A Dictionary is like a hash-map; each unique key is an object (not just string) corresponds to a stored value.

Usage

var object = new trakit.fleetfreedom.Dictionary(/** Object */ iterable);

Properties
Property	Type	Description
size	number	The number of key/value pairs in the Dictionary.

Functions
Method	Returns	Description
addOrReplace(/** K / key, /* V / value, /* function / updateValue, /* Object */ context)		Either adds the given key/value, or replaces the value for the given key. The updateValue is invoked only for replace operations. The updateValue function is invoked with the existing value, the replacement value, the key, and itself, and returns the value to be set. The method itself returns undefined.
clear()		Removes all key/value pairs from the Dictionary.
concat(/** Dictionary \| Map */ var_args)	Dictionary	Creates a new Dictionary, and adds or overwrites the keys with the other given Dictionaries.
copy()	Dictionary	Creates an exact copy of this Dictionary.
every(/** function / predicate, /* Object */ context)	boolean	Checks each pair in the Dictionary and returns true only if all pairs match the predicate.
filter(/** function / predicate, /* Object */ context)	Dictionary	Builds a new Dictionary with only the positive results from the predicate.
forEach(/** function / predicate, /* Object */ context)		Iterates through all the pairs in the Dictionary.
get(/** K */ key)	V \| undefined	Returns the value associated to the key, or undefined if there is none.
has(/** K */ key)	boolean	Returns a boolean asserting whether a value has been associated to the key in the Dictionary or not.
hasValue(/** V */ value)	boolean	Returns a boolean asserting whether a value has been added to the Dictionary or not.
keys()	Array.<K>	Gets an Array of keys within this Dictionary.
order(/** function / compareFunction, /* Object */ context)	Dictionary	Returns a new Dictionary whose keys are sorted based on the given predicate. Sorting a Dictionary is similar to sorting an array using Array#sort. Your compareFunction returns a number (typically 1, 0, or -1), and takes two arguments. Each argument is a "pair", an object containing a key and value; { key: K, value: V }.
remove(/** K */ key)	boolean	Removes any value associated to the key. After such a call, Dictionary#has(key) will return false.
set(/** K / key, /* V */ value)		Sets the value for the key in the Dictionary. Returns undefined.
setOrReplace(/** K / key, /* function / setValue, /* function / updateValue, /* Object */ context)		Either adds the given key/value, or replaces the value for the given key. The setValue is invoked only for add operations, and the updateValue is invoked only for replace operations. The setValue function is invoked with the key, and itself, and returns the value to be set. The updateValue function is invoked with the existing value, a reference to the setValue function, the key, and itself, and returns the value to be set. The method itself returns undefined.
some(/** function / predicate, /* Object */ context)	boolean	Checks each pair in the Dictionary and returns true if one pair matches the predicate.
toArray(/** function / predicate, /* Object */ context)	Array.<?>	Builds an array out of the results of the predicate.
toDictionary(/** function / valuePredicate, /* function / keyPredicate, /* Object */ context)	Dictionary	Builds a new Dictionary out of the results of the predicates.
toJSON()	Object	Creates an Object literal of this Dictionary. Keys are set as strings. Values use their toJSON method (if present), NaNs are converted to nulls, and "undefined"s are not added.
values()	Array.<V>	Gets the Array of values from this Dictionary.

SearchPattern class

A common structure used to implement searching throughout the system. The input format is described in the WebSocket reference.

Usage

var object = new trakit.fleetfreedom.SearchPattern(/** string */ pattern);

Properties
Property	Type	Description
operators	Dictionary.<string, Array.<string>>	To help qualify matches, all operators must match for the search to be considered matched. Operators are formatted as "operator:terms".
terms	Array.<string>	If any term matches, then the search should be considered matched. Terms are any string contained by single/double-quotes or not parsed as an operator.
wildcard	boolean	True when this pattern will match all.

Functions
Method	Returns	Description
copy()	SearchPattern	Returns a new, identical instance of the pattern.
toString()	string	Returns a re-parseable string representation of the pattern.

Static Methods
Method	Returns	Description
SearchPattern.parse(/** string */ expression)	Array.<SearchPattern>	Creates an array of SearchPatterns for easier matching. Used for doing OR matching.
SearchPattern.stringify(/** Array.<SearchPattern> */ patterns)	string	Creates a single string from the given array of SearchPatterns for easier serialization.

TimeSpan class

An object which represents an interval of time.

Usage

var object = new trakit.fleetfreedom.TimeSpan(/** string | number */ duration);

Properties
Property	Type	Description
days	number	Days component of the time-span.
hours	number	Hours component of the time-span.
milliseconds	number	Millisecond component of the time-span.
minutes	number	Minutes component of the time-span.
seconds	number	Seconds component of the time-span.
totalDays	number	Total time-span value in decimal days.
totalHours	number	Total time-span value in decimal hours.
totalMilliseconds	number	Total time-span value in milliseconds.
totalMinutes	number	Total time-span value in decimal minutes.
totalSeconds	number	Total time-span value in decimal seconds.

Functions
Method	Returns	Description
add(/** TimeSpan \| string \| number / duration, /* boolean */ subtract)	number	Adds the given value to the current time-span.
subtract(/** TimeSpan \| string \| number / duration, /* boolean */ add)	number	Subtracts the given value from the time-span.
toString(/** string */ format)	string	Parses the time-span into a serialized TimeSpan string. The format follows the trakit.json.duration definition.

Static Methods
Method	Returns	Description
TimeSpan.fromDays(/** number */ value)	TimeSpan	Constructs a new TimeSpan with the value specified in days.
TimeSpan.fromHours(/** number */ value)	TimeSpan	Constructs a new TimeSpan with the value specified in hours.
TimeSpan.fromMilliseconds(/** number */ value)	TimeSpan	Constructs a new TimeSpan with the value specified in milliseconds.
TimeSpan.fromMinutes(/** number */ value)	TimeSpan	Constructs a new TimeSpan with the value specified in minutes.
TimeSpan.fromSeconds(/** number */ value)	TimeSpan	Constructs a new TimeSpan with the value specified in seconds.

Timezone class

Information about a specific timezone

Usage

var object = new trakit.fleetfreedom.Timezone(/** string */ code, /** string */ name, /** number */ offset, /** boolean */ dst);

Properties
Property	Type	Description
code	string	A short identification code for date/time conversion
dst	boolean	Whether this timezone abides by daylight savings
name	string	Full name of the timezone
offset	number	The number of minutes offset from UTC

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

Assets, People, Vehicles, and Trailers

Asset class

Inheritance: MVCObject > Asset

An Asset is a generic representation of the real-world object being tracked.

Usage

var object = new trakit.fleetfreedom.Asset(/** Company */ company, /** trakit.json.Asset | trakit.json.AssetGeneral | trakit.json.AssetAdvanced */ object);

Properties
Property	Type	Description
attributes	Dictionary.<string, AssetAttribute>	A list of properties given to this asset by a Behaviour. The dictionary key is a codified version of the AssetAttribute#name. See utility#codify.
cargo	Array.<Inventory>	Inventory carried by the asset.
company	Company	The Company to which this asset belongs.
dispatch	Dispatch	The list of current tasks and routes assigned to this asset.
icon	Icon	The icon that represents this asset on the map and in lists.
iconId	number	The unique identifier of the Icon for this asset.
id	number	Unique identifier
kind	AssetType	The type of asset.
labels	Array.<string>	Codified labels. See utility#codify.
messages	Array.<Message>	Two way conversation Messages between the asset and Fleet Freedom.
messagingAddress	string	The fall-back address which is used to send Messages.
name	string	This thing's name.
notes	string	Notes about it.
odometer	number	The virtual odometer for this vehicle or trailer.
pictureIds	Array.<number>	A list of Picture#ids of this thing.
pictures	Array.<Picture>	A list of Pictures of this thing.
places	Dictionary.<number, AssetPlaceStatus>	Known Places this asset has interacted with.
position	Position	The last recorded GPS coordinates for this asset.
providerIds	Array.<number>	The IDs of providers for this asset.
providers	Array.<Provider>	The modems or phones providing GPS positions and other telemetry for this asset.
reference	string	Getter/setter for the references field named "reference".
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
relationshipIds	Array.<number>	The IDs of related assets.
relationships	Array.<Asset>	The related assets like a vehicle for a driver, or a trailer for a vehicle.
since	Date	A timestamp that indicates when the Asset was suspended or deleted.
suspended	boolean	A flag to show that an asset is suspended from event procesing.
tags	Array.<string>	Codified status tags. See utility#codify.
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
createDispatchTask(/** trakit.json.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.json.AssetMessage */ message)	Message	Creates a new Message and adds it to the Asset#messages array
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Asset \| trakit.json.AssetGeneral \| trakit.json.AssetAdvanced / json, /* boolean */ silent)	Asset	Updates parameters for this Asset from the given JSON literal
getDispatchJobById(/** number */ id)	DispatchJob	Retrieves the DispatchJob with the given id or null if none found.
getDispatchJobs()	Array.<DispatchJob>	Gets an array of DispatchJobs for this Asset.
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
getDispatchTasks()	Array.<DispatchTask>	Gets an array of DispatchTasks for this Asset.
getHosEvents()	Array.<HosEvent>	Gets an array of HosEvents for this Asset.
getHosInspections()	Array.<HosInspection>	Gets an array of HosInspections for this Asset.
getMaintenanceJobs()	Array.<MaintenanceJob>	Gets an Array of Maintenance Jobs for this Asset.
getMessageById(/** number */ id)	Message	Retrieves the Message with the given id or null if none found.
getMessages()	Array.<Message>	Gets an array of Messages for this Asset.
getPictureIds()	Array.<number>	Gets an Array of Picture Ids for this Asset.
getPictures()	Array.<Picture>	Gets an Array of Pictures for this Asset.
getPlaces(/** Array.<AssetPlaceStatusType> */ statuses)	Array.<Place>	Gets a list of Places which are being interacted with by this asset.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this asset. Used internally by Company#findAssets.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

AssetAttribute class

A detail about an asset updated by its providers.

Usage

var object = new trakit.fleetfreedom.AssetAttribute(/** string */ name, /** string */ simple, /** string */ complex, /** Object */ raw, /** string */ unit, /** Date */ dts, /** string */ provider, /** boolean */ global);

Properties
Property	Type	Description
complex	string	Parse-able/formatted string for complex display.
dts	Date	The date/time when this value was set.
global	boolean	When false, indicates that this attribute is used by an internal system and should be left untouched.
name	string	Display name for the attribute.
provider	string	A note from the Behaviour as to why this was set.
raw	Object	Raw value.
simple	string	Computed/contextual value from the Behaviour.
unit	string	The value's unit. IE: kilometres, degrees Fahrenheit, etc...

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

AssetPlaceStatus class

A simple status for each place an Asset visits

Usage

var object = new trakit.fleetfreedom.AssetPlaceStatus(/** string */ kind, /** string | Date */ enter, /** string | Date */ latest);

Properties
Property	Type	Description
enter	Date	The date/time stamp for when the Asset first began interacting with the Place
kind	AssetPlaceStatusType	The kind of interaction
latest	Date	The most recent date/time stamp for the interaction

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

Person class

Inheritance: MVCObject > Asset > Person

A Person is a specialized kind of Asset that represents an actual person in the real-world. It has specific attributes for contact information like mobile number, email, shipping address, pictures, etc...

Usage

var object = new trakit.fleetfreedom.Person(/** Company */ company, /** trakit.json.Person | trakit.json.PersonGeneral | trakit.json.AssetAdvanced */ object);

Properties
Property	Type	Description
attributes	Dictionary.<string, AssetAttribute>	A list of properties given to this asset by a Behaviour. The dictionary key is a codified version of the AssetAttribute#name. See utility#codify.
cargo	Array.<Inventory>	Inventory carried by the asset.
company	Company	The Company to which this asset belongs.
contact	Contact	The contact information of this Person
dispatch	Dispatch	The list of current tasks and routes assigned to this asset.
icon	Icon	The icon that represents this asset on the map and in lists.
iconId	number	The unique identifier of the Icon for this asset.
id	number	Unique identifier
kind	AssetType	The type of asset.
labels	Array.<string>	Codified labels. See utility#codify.
messages	Array.<Message>	Two way conversation Messages between the asset and Fleet Freedom.
messagingAddress	string	The fall-back address which is used to send Messages.
name	string	This thing's name.
notes	string	Notes about it.
odometer	number	The virtual odometer for this vehicle or trailer.
pictureIds	Array.<number>	A list of Picture#ids of this thing.
pictures	Array.<Picture>	A list of Pictures of this thing.
places	Dictionary.<number, AssetPlaceStatus>	Known Places this asset has interacted with.
position	Position	The last recorded GPS coordinates for this asset.
providerIds	Array.<number>	The IDs of providers for this asset.
providers	Array.<Provider>	The modems or phones providing GPS positions and other telemetry for this asset.
reference	string	Getter/setter for the references field named "reference".
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
relationshipIds	Array.<number>	The IDs of related assets.
relationships	Array.<Asset>	The related assets like a vehicle for a driver, or a trailer for a vehicle.
since	Date	A timestamp that indicates when the Asset was suspended or deleted.
suspended	boolean	A flag to show that an asset is suspended from event procesing.
tags	Array.<string>	Codified status tags. See utility#codify.
trailer	Trailer	The Trailer being towed by this Person
vehicle	Vehicle	The vehicle currently being driven by this Person
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
createDispatchTask(/** trakit.json.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.json.AssetMessage */ message)	Message	Creates a new Message and adds it to the Asset#messages array
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Asset \| trakit.json.AssetGeneral \| trakit.json.AssetAdvanced / json, /* boolean */ silent)	Person	Updates parameters for this Person from the given JSON literal
getDispatchJobById(/** number */ id)	DispatchJob	Retrieves the DispatchJob with the given id or null if none found.
getDispatchJobs()	Array.<DispatchJob>	Gets an array of DispatchJobs for this Asset.
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
getDispatchTasks()	Array.<DispatchTask>	Gets an array of DispatchTasks for this Asset.
getHosEvents()	Array.<HosEvent>	Gets an array of HosEvents for this Asset.
getHosInspections()	Array.<HosInspection>	Gets an array of HosInspections for this Asset.
getMaintenanceJobs()	Array.<MaintenanceJob>	Gets an Array of Maintenance Jobs for this Asset.
getMessageById(/** number */ id)	Message	Retrieves the Message with the given id or null if none found.
getMessages()	Array.<Message>	Gets an array of Messages for this Asset.
getPictureIds()	Array.<number>	Gets an Array of Picture Ids for this Person.
getPictures()	Array.<Picture>	Gets an Array of Pictures for this Person.
getPlaces(/** Array.<AssetPlaceStatusType> */ statuses)	Array.<Place>	Gets a list of Places which are being interacted with by this asset.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this asset. Used internally by Company#findAssets.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

Trailer class

Inheritance: MVCObject > Asset > Trailer

A Trailer is a specialized kind of Asset that represents an actual trailer or chassis in the real-world. It has specific attributes like license plate, make, model, year, hitched vehicle, mounted container bin, etc...

Usage

var object = new trakit.fleetfreedom.Trailer(/** Company */ company, /** trakit.json.Trailer | trakit.json.TrailerGeneral | trakit.json.AssetAdvanced */ object);

Properties
Property	Type	Description
attributes	Dictionary.<string, AssetAttribute>	A list of properties given to this asset by a Behaviour. The dictionary key is a codified version of the AssetAttribute#name. See utility#codify.
bin	InventoryContainer	The bin this trailer/chassis is hauling
cargo	Array.<Inventory>	Inventory carried by the asset.
colour	string	The main colour of this vehicle
company	Company	The Company to which this asset belongs.
dispatch	Dispatch	The list of current tasks and routes assigned to this asset.
icon	Icon	The icon that represents this asset on the map and in lists.
iconId	number	The unique identifier of the Icon for this asset.
id	number	Unique identifier
kind	AssetType	The type of asset.
labels	Array.<string>	Codified labels. See utility#codify.
make	string	Name of manufacturer
messages	Array.<Message>	Two way conversation Messages between the asset and Fleet Freedom.
messagingAddress	string	The fall-back address which is used to send Messages.
model	string	Manufacturer model name
name	string	This thing's name.
notes	string	Notes about it.
odometer	number	The virtual odometer for this vehicle or trailer.
person	Person	The person driving this trailer
pictureIds	Array.<number>	A list of Picture#ids of this thing.
pictures	Array.<Picture>	A list of Pictures of this thing.
places	Dictionary.<number, AssetPlaceStatus>	Known Places this asset has interacted with.
plate	string	The license plate
position	Position	The last recorded GPS coordinates for this asset.
providerIds	Array.<number>	The IDs of providers for this asset.
providers	Array.<Provider>	The modems or phones providing GPS positions and other telemetry for this asset.
reference	string	Getter/setter for the references field named "reference".
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
relationshipIds	Array.<number>	The IDs of related assets.
relationships	Array.<Asset>	The related assets like a vehicle for a driver, or a trailer for a vehicle.
serial	string	The unique serial number on the trailer (for your reference)
since	Date	A timestamp that indicates when the Asset was suspended or deleted.
suspended	boolean	A flag to show that an asset is suspended from event procesing.
tags	Array.<string>	Codified status tags. See utility#codify.
vehicle	Vehicle	The vehicle currently towing this trailer
version	Array.<number>	The version flags used to ensure sync operations are done in order.
year	number	The year this vehicle was manufactured

Functions
Method	Returns	Description
createDispatchTask(/** trakit.json.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.json.AssetMessage */ message)	Message	Creates a new Message and adds it to the Asset#messages array
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Asset \| trakit.json.TrailerGeneral \| trakit.json.AssetAdvanced / json, /* boolean */ silent)	Trailer	Updates parameters for this Trailer from the given JSON literal.
getDispatchJobById(/** number */ id)	DispatchJob	Retrieves the DispatchJob with the given id or null if none found.
getDispatchJobs()	Array.<DispatchJob>	Gets an array of DispatchJobs for this Asset.
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
getDispatchTasks()	Array.<DispatchTask>	Gets an array of DispatchTasks for this Asset.
getHosEvents()	Array.<HosEvent>	Gets an array of HosEvents for this Asset.
getHosInspections()	Array.<HosInspection>	Gets an array of HosInspections for this Asset.
getMaintenanceJobs()	Array.<MaintenanceJob>	Gets an Array of Maintenance Jobs for this Asset.
getMessageById(/** number */ id)	Message	Retrieves the Message with the given id or null if none found.
getMessages()	Array.<Message>	Gets an array of Messages for this Asset.
getPictureIds()	Array.<number>	Gets an Array of Picture Ids for this Asset.
getPictures()	Array.<Picture>	Gets an Array of Pictures for this Asset.
getPlaces(/** Array.<AssetPlaceStatusType> */ statuses)	Array.<Place>	Gets a list of Places which are being interacted with by this asset.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this asset. Used internally by Company#findAssets.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

Vehicle class

Inheritance: MVCObject > Asset > Vehicle

A Vehicle is a specialized kind of Asset that represents an actual vehicle in the real-world. It has specific attributes like license plate, make, model, year, colour, odometer, driver, trailer, etc...

Usage

var object = new trakit.fleetfreedom.Vehicle(/** Company */ company, /** trakit.json.Vehicle | trakit.json.VehicleGeneral | trakit.json.VehicleAdvanced */ object);

Properties
Property	Type	Description
attributes	Dictionary.<string, AssetAttribute>	A list of properties given to this asset by a Behaviour. The dictionary key is a codified version of the AssetAttribute#name. See utility#codify.
cargo	Array.<Inventory>	Inventory carried by the asset.
colour	string	The main colour of this vehicle
company	Company	The Company to which this asset belongs.
dispatch	Dispatch	The list of current tasks and routes assigned to this asset.
engineHours	number	The number of hours the engine has been running
icon	Icon	The icon that represents this asset on the map and in lists.
iconId	number	The unique identifier of the Icon for this asset.
id	number	Unique identifier
kind	AssetType	The type of asset.
labels	Array.<string>	Codified labels. See utility#codify.
make	string	Name of manufacturer
messages	Array.<Message>	Two way conversation Messages between the asset and Fleet Freedom.
messagingAddress	string	The fall-back address which is used to send Messages.
model	string	Manufacturer model name
name	string	This thing's name.
notes	string	Notes about it.
odometer	number	The virtual odometer for this vehicle or trailer.
person	Person	The Person driving
pictureIds	Array.<number>	A list of Picture#ids of this thing.
pictures	Array.<Picture>	A list of Pictures of this thing.
places	Dictionary.<number, AssetPlaceStatus>	Known Places this asset has interacted with.
plate	string	The license plate
position	Position	The last recorded GPS coordinates for this asset.
providerIds	Array.<number>	The IDs of providers for this asset.
providers	Array.<Provider>	The modems or phones providing GPS positions and other telemetry for this asset.
reference	string	Getter/setter for the references field named "reference".
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
relationshipIds	Array.<number>	The IDs of related assets.
relationships	Array.<Asset>	The related assets like a vehicle for a driver, or a trailer for a vehicle.
since	Date	A timestamp that indicates when the Asset was suspended or deleted.
suspended	boolean	A flag to show that an asset is suspended from event procesing.
tags	Array.<string>	Codified status tags. See utility#codify.
trailer	Trailer	The Trailer being towed
version	Array.<number>	The version flags used to ensure sync operations are done in order.
vin	string	The unique Vehicle Identification Number
year	number	The year this vehicle was manufactured

Functions
Method	Returns	Description
createDispatchTask(/** trakit.json.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.json.AssetMessage */ message)	Message	Creates a new Message and adds it to the Asset#messages array
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Asset \| trakit.json.VehicleGeneral \| trakit.json.VehicleAdvanced / json, /* boolean */ silent)	Vehicle	Updates parameters for this Vehicle from the given JSON literal
getDispatchJobById(/** number */ id)	DispatchJob	Retrieves the DispatchJob with the given id or null if none found.
getDispatchJobs()	Array.<DispatchJob>	Gets an array of DispatchJobs for this Asset.
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
getDispatchTasks()	Array.<DispatchTask>	Gets an array of DispatchTasks for this Asset.
getHosEvents()	Array.<HosEvent>	Gets an array of HosEvents for this Asset.
getHosInspections()	Array.<HosInspection>	Gets an array of HosInspections for this Asset.
getMaintenanceJobs()	Array.<MaintenanceJob>	Gets an Array of Maintenance Jobs for this Asset.
getMessageById(/** number */ id)	Message	Retrieves the Message with the given id or null if none found.
getMessages()	Array.<Message>	Gets an array of Messages for this Asset.
getPictureIds()	Array.<number>	Gets an Array of Picture Ids for this Asset.
getPictures()	Array.<Picture>	Gets an Array of Pictures for this Asset.
getPlaces(/** Array.<AssetPlaceStatusType> */ statuses)	Array.<Place>	Gets a list of Places which are being interacted with by this asset.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this asset. Used internally by Company#findAssets.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

AssetPlaceStatusType enum (string)

The kinds of interactions had with a Place.

Values
Value	Description
enter	Occurs when an asset is outside a Place, then goes inside the boundary.
exit	Occurs when an asset was inside the boundary of a Place, but then moves outside the boundary.
inside	Occurs when the asset has was inside the boundary before, and is still inside the boundary now.

AssetType enum (string)

The kinds of Assets supported by the system. Every Asset is one of these types.

Values
Value	Description
asset	Anything being tracked which isn't one of the other types.
person	Represents an actual person with contact information.
trailer	Something pulled around by a vehicle.
vehicle	A truck, car, bulldozer, motorcycle, star-ship, etc...

Behaviours

Behaviour class

Inheritance: MVCObject > Behaviour

A configured and targeted BehaviourScript.

Usage

var object = new trakit.fleetfreedom.Behaviour(/** Company */ company, /** trakit.json.Behaviour */ object);

Properties
Property	Type	Description
filters	string	A search pattern used to filter the providers which can implement this behaviour.
id	number	Unique identifier
messages	Array.<BehaviourLog>	A log of recent messages generated by the BehaviourScript's calling console functions.
name	string	Name of this configuration
notes	string	Notes about this configuration
parameters	Object.<string, string>	Defined variable name/value pairs for the BehaviourScript used
priority	number	The Behaviour's execution order
script	BehaviourScript	The BehaviourScript to which these variables apply.
scriptId	number	The unique identifier of the BehaviourScript to which these variables apply.
targets	string	The search pattern used to target the assets which will embed this behaviour in their execution context.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
createLog(/** trakit.json.BehaviourLog */ log)	BehaviourLog	Creates a new BehaviourLog and adds it to the Behaviour#messages array.
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** Behaviour / json, /* boolean */ silent)	Behaviour	Updates parameters for this Behaviour from the given JSON literal
getLogById(/** number */ id)	BehaviourLog	Retrieves the BehaviourLog with the given id or null if none found.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this behaviour. Used internally by Company#findBehaviours.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

BehaviourLog class

A debug message generated from a Behaviour and/or a BehaviourScript.

Usage

var object = new trakit.fleetfreedom.BehaviourLog(/** Company */ company, /** trakit.json.BehaviourLog */ object);

Properties
Property	Type	Description
asset	Asset	The Asset whose behaviours created this debug entry.
assetId	number	The unique identifier of the Asset whose behaviours created this debug entry.
behaviour	Behaviour	The configured Behaviour from which this debug message was invoked.
behaviourId	number	The unique identifier of the Behaviour to which this debug belongs.
character	number	Relevant character index if available
company	Company	The Company to which the debug message's Behaviour and/or a BehaviourScript belongs.
dts	Date	When the debug message was generated.
id	number	Unique identifier of this debug message.
kind	BehaviourLogType	Type of debug message that was generated.
line	number	Relevant line number if available
message	string	Message data saved to the debug message.
script	BehaviourScript	The BehaviourScript in question which logged this message.
scriptId	number	The unique identifier of the BehaviourScript to which this debug belongs.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
fromJSON(/** trakit.json.BehaviourLog */ json)
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

BehaviourParameter class

Definition of an argument passed to a Behaviour Script.

Usage

var object = new trakit.fleetfreedom.BehaviourParameter(/** BehaviourParameterType */ type, /** string */ value, /** string */ notes, /** string */ context);

Properties
Property	Type	Description
context	string	Gives a hint to the client on the best UI to use for editing. For example, "checkbox" is a good UI hint for boolean parameter types.
notes	string	Usage notes.
type	BehaviourParameterType	Simple type information for the compiler.
value	string	The value is given as a string, but parsed into native type when compiled.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

BehaviourScript class

Inheritance: MVCObject > BehaviourScript

The 800lbs gorilla! These scripts determine how the system reacts for each customer.

Usage

var object = new trakit.fleetfreedom.BehaviourScript(/** Company */ company, /** trakit.json.BehaviourScript */ object);

Properties
Property	Type	Description
compiles	boolean	A flag set by the compiler if this code compiles
fill	string	The colour filling the background of the display icon.
filters	string	Default expression(s) used as a hint for configured Behaviours.
global	boolean	When true, this script is available to all child Companys.
graphic	string	The name of the icon used for display purposes.
id	number	Unique identifier of this script
messages	Array.<BehaviourLog>	List of warnings and errors while trying to compile this script.
name	string	Name for this script
notes	string	Usage notes
parameters	Dictionary.<string, BehaviourParameter>	Arguments given to this script.
source	string	The raw source code
stroke	string	The colour of the outline for the display icon.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
createLog(/** trakit.json.BehaviourLog */ log)	BehaviourLog	Creates a new BehaviourLog and adds it to the BehaviourScript#messages array.
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** BehaviourScript / json, /* boolean */ silent)	BehaviourScript	Updates parameters for this BehaviourScript from the given JSON literal
getBehaviours()	Array.<Behaviour>	Retrieves the Behaviours using this script.
getLogById(/** number */ id)	BehaviourLog	Retrieves the BehaviourLog with the given id or null if none found.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this script. Used internally by Company#findBehaviourScripts.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

BehaviourLogType enum (string)

Defines the kinds of log messages for a BehaviourLog.

Values
Value	Description
err	Exception message
info	Higher importance message
log	Regular log message
warn	Warning message

BehaviourParameterType enum (string)

The possible types given to BehaviourParameters

Values
Value	Description
boolean	True or false.
json	Object or array literal.
number	Numeric value (signed double-precision floating point number).
string	Text.

Companies / Organizations

Company class

Inheritance: MVCObject > Company

A Company is an organization which contains everything belonging to the customer. This includes Assets, Places, Users, Behaviours, Reports, Maintenance, etc... Think of a Company as the beginning point for everything in the system. Everything can be linked back to a Company somehow.

Usage

var object = new trakit.fleetfreedom.Company(/** trakit.json.Company | trakit.json.CompanyGeneral | trakit.json.CompanyStyles | trakit.json.CompanyPolicies | trakit.json.CompanyReseller */ object);

Properties
Property	Type	Description
assets	Array.<Asset>	List or virtual assets, persons, vehicles, and trailers
behaviourLogs	Array.<BehaviourLog>	Logs for the Behaviours of this company.
behaviours	Array.<Behaviour>	Configured Behaviour Scripts.
behaviourScripts	Array.<BehaviourScript>	Behaviours authored by a company user.
billing	CompanyBilling	Billing contacts, rules, limits, and notes
contacts	Array.<Contact>	Business contacts
directory	Dictionary.<string, Array.<Contact>>	Directory of Contacts for various business reasons
dispatchJobs	Array.<Message>	All of the jobs both assigned to Assetss, and not yet assigned.
dispatchTasks	Array.<Message>	All of the tasks assigned to Assetss.
dispatchTemplates	Array.<Message>	The templates to use when creating new dispatches.
documents	Array.<Document>	Temporarily hosted documents for this Company
hos	CompanyHoS	Hours of Service carriers, daily log, and trip inspections
icons	Array.<Icon>	Icons belonging to objects for this Company as well as global Icons
id	number	Unique identifier of a company (value is NaN for unsaved Company)
labels	Dictionary.<string, LabelStyle>	Labels for categorizing things within this Company
machines	Array.<Machine>	List of Service Acounts
maintenanceJobs	Array.<MaintenanceJob>	Historical maintenance for Assets
maintenanceSchedules	Array.<MaintenanceSchedule>	Recurring maintenance rules for Assets
messages	Array.<Message>	A list of all messages between an Asset and Fleet Freedom.
name	string	Operating name of the organization
notes	string	A text field used to add miscellaneous notes to a Company object
parent	number	Parent organization's Company#id
passwordPolicy	CompanyPasswords	Policy for passwords requirements and expiration
pictures	Array.<Picture>	Photos belonging to objects for this Company
places	Array.<Place>	List of saved locations
providerConfigs	Array.<ProviderConfig>	Configured ProviderScripts for this company's providers.
providerConfigurations	Array.<ProviderConfiguration>	Configured ProviderConfigurations for this company's providers.
providerRegistrations	Array.<ProviderRegistration>	Providers that are being provisioned, but have not yet been added to the syste.
providers	Array.<Provider>	Company owned modems, apps, and other event providers
providerScripts	Array.<ProviderScript>	The list of provider logics for this company.
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
reportResults	Array.<ReportResult>	Results from run templates which are saved or expiring
reportSchedules	Array.<ReportSchedule>	Schedules to automatically run reports overnight
reportTemplates	Array.<ReportTemplate>	Report templates
reseller	CompanyReseller	White-labelling details for this company.
sessionPolicy	CompanySessions	Policy regarding session expiration
sessions	Array.<Session>	Active and idling sessions for this Company
tags	Dictionary.<string, LabelStyle>	Status tag styles for Assets
userGroups	Array.<UserGroup>	List of user permission groups
users	Array.<User>	List of system users
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
createAsset(/** trakit.json.Asset \| trakit.json.AssetGeneral \| trakit.json.AssetAdvanced */ json)	Asset	Creates a new Asset and adds it to the Company#assets array
createBehaviour(/** trakit.json.Behaviour */ json)	Behaviour	Creates a new Behaviour and adds it to the Company#behaviours array.
createBehaviourLog(/** trakit.json.BehaviourLog */ json)	BehaviourLog	Creates a new BehaviourLog and adds it to the Company#behaviourLogs array.
createBehaviourScript(/** trakit.json.BehaviourScript */ json)	BehaviourScript	Creates a new BehaviourScript and adds it to the Company#behaviourScripts array.
createContact(/** trakit.json.Contact */ json)	Contact	Creates a new Contact and adds it to the Company#contacts array
createDispatchJob(/** trakit.json.DispatchJob */ json)	DispatchJob	Creates a new DispatchJob and adds it to the Company#dispatchJobs array.
createDispatchTask(/** trakit.json.DispatchTask */ json)	DispatchTask	Creates a new DispatchTask and adds it to the Company#dispatchTasks array.
createDispatchTemplate(/** trakit.json.DispatchTemplate */ json)	DispatchTemplate	Creates a new DispatchTemplate and adds it to the Company#dispatchTemplates array.
createDocument(/** trakit.json.Document */ json)	Document	Creates a new Document and adds it to the Company#documents array
createHosCarrier(/** trakit.json.HosCarrier */ json)	HosCarrier	Creates a new HosCarrier and adds it to the CompanyHoS#carriers array.
createHosEvent(/** trakit.json.HosEvent */ json)	HosEvent	Creates a new HosEvent and adds it to the CompanyHoS#events array.
createHosInspection(/** trakit.json.HosInspection */ json)	HosInspection	Creates a new HosInspection and adds it to the CompanyHoS#inspections array.
createIcon(/** trakit.json.Icon */ json)	Icon	Creates a new Icon and adds it to the Company#icons array.
createLabel(/** trakit.json.LabelStyle */ json)	LabelStyle	Creates a new LabelStyle and adds it to the Company#labels array
createMachine(/** trakit.json.Machine */ json)	Machine	Creates a new Machine and adds it to the Company#machines array
createMaintenanceJob(/** trakit.json.MaintenanceJob */ json)	MaintenanceJob	Creates a new MaintenanceJob and adds it to the Company#maintenanceJobs array.
createMaintenanceSchedule(/** trakit.json.MaintenanceSchedule */ json)	MaintenanceSchedule	Creates a new MaintenanceSchedule and adds it to the Company#maintenanceSchedules array.
createMessage(/** trakit.json.AssetMessage */ json)	Message	Creates a new Message and adds it to the Company#messages array.
createPerson(/** trakit.json.Person \| trakit.json.PersonGeneral \| trakit.json.AssetAdvanced */ json)	Person	Creates a new Person and adds it to the Company#assets array.
createPicture(/** trakit.json.Picture */ json)	Picture	Creates a new Picture and adds it to the Company#pictures array
createPlace(/** trakit.json.PlaceGeneral */ json)	Place	Creates a new Place and adds it to the Company#places array.
createProvider(/** trakit.json.Provider */ json)	Provider	Creates a new Provider and adds it to the Company#providers array.
createProviderConfig(/** trakit.json.ProviderConfig */ json)	ProviderConfig	Creates a new ProviderConfig and adds it to the Company#providerConfigs array.
createProviderConfiguration(/** trakit.json.ProviderConfiguration */ json)	ProviderConfiguration	Creates a new ProviderConfiguration and adds it to the Company#providerConfigurations array.
createProviderRegistration(/** trakit.json.ProviderRegistration */ json)	ProviderRegistration	Creates a new ProviderRegistration and adds it to the Company#providerRegistrations array.
createProviderScript(/** trakit.json.ProviderScript */ json)	ProviderScript	Creates a new ProviderScript and adds it to the Company#providerScripts array.
createReportResult(/** trakit.json.ReportResult */ json)	ReportResult	Creates a new ReportResult and adds it to the Company#reportResults array.
createReportSchedule(/** trakit.json.ReportSchedule */ json)	ReportSchedule	Creates a new ReportSchedule and adds it to the Company#reportSchedules array.
createReportTemplate(/** trakit.json.ReportTemplate */ json)	ReportTemplate	Creates a new ReportTemplate and adds it to the Company#reportTemplates array.
createSession(/** trakit.json.Session */ json)	Session	Creates a new Session and adds it to the Company#sessions array.
createTrailer(/** trakit.json.Trailer \| trakit.json.TrailerGeneral \| trakit.json.AssetAdvanced */ json)	Trailer	Creates a new Trailer and adds it to the Company#assets array.
createUser(/** trakit.json.UserGeneral \| trakit.json.UserAdvanced */ json)	User	Creates a new User and adds it to the Company#users array
createUserGroup(/** trakit.json.UserGroup */ json)	UserGroup	Creates a new UserGroup and adds it to the Company#userGroups array
createVehicle(/** trakit.json.Vehicle \| trakit.json.VehicleGeneral \| trakit.json.VehicleAdvanced */ json)	Vehicle	Creates a new Vehicle and adds it to the Company#assets array
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
findAssets(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Asset>	Finds all the Assets that match the given search expression. Internally, this method invokes Asset#isMatch.
findBehaviourLogs(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<BehaviourLog>	Finds all the BehaviourLogs that match the given search expression. Internally, this method invokes BehaviourLog#isMatch.
findBehaviours(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Behaviour>	Finds all the Behaviours that match the given search expression. Internally, this method invokes Behaviour#isMatch.
findBehaviourScripts(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<BehaviourScript>	Finds all the BehaviourScripts that match the given search expression. Internally, this method invokes BehaviourScript#isMatch.
findContacts(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Contact>	Finds all the Contacts that match the given search expression. Internally, this method invokes Contact#isMatch.
findDispatchJobs(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<DispatchJob>	Finds all the DispatchJobs that match the given search expression. Internally, this method invokes DispatchJob#isMatch.
findDispatchTasks(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<DispatchTask>	Finds all the DispatchTasks that match the given search expression. Internally, this method invokes DispatchTask#isMatch.
findDispatchTemplates(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<DispatchTemplate>	Finds all the DispatchTemplates that match the given search expression. Internally, this method invokes DispatchTemplate#isMatch.
findDocuments(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Document>	Finds all the Documents that match the given search expression. Internally, this method invokes Document#isMatch.
findIcons(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Icon>	Finds all the Icons that match the given search expression. Internally, this method invokes Icon#isMatch.
findMachines(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Machine>	Finds all the Machines that match the given search expression. Internally, this method invokes Machine#isMatch.
findMaintenanceJobs(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<MaintenanceJob>	Finds all the MaintenanceJobs that match the given search expression. Internally, this method invokes MaintenanceJob#isMatch.
findMaintenanceSchedules(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<MaintenanceSchedule>	Finds all the MaintenanceSchedules that match the given search expression. Internally, this method invokes MaintenanceSchedule#isMatch.
findMessages(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Message>	Finds all the Messages that match the given search expression. Internally, this method invokes Message#isMatch.
findPlaces(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Place>	Finds all the Places that match the given search expression. Internally, this method invokes Place#isMatch.
findProviderConfigs(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<ProviderConfig>	Finds all the ProviderConfigs that match the given search expression. Internally, this method invokes ProviderConfig#isMatch.
findProviderConfigurations(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<ProviderConfiguration>	Finds all the ProviderConfigurations that match the given search expression. Internally, this method invokes ProviderConfiguration#isMatch.
findProviderRegistrations(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<ProviderRegistration>	Finds all the ProviderRegistrations that match the given search expression. Internally, this method invokes ProviderRegistration#isMatch.
findProviders(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Provider>	Finds all the Providers that match the given search expression. Internally, this method invokes Provider#isMatch.
findProviderScripts(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<ProviderScript>	Finds all the ProviderScripts that match the given search expression. Internally, this method invokes ProviderScript#isMatch.
findReportResults(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<ReportResult>	Finds all the ReportResults that match the given search expression. Internally, this method invokes ReportResult#isMatch.
findReportSchedules(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<ReportSchedule>	Finds all the ReportSchedules that match the given search expression. Internally, this method invokes ReportSchedule#isMatch.
findReportTemplates(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<ReportTemplate>	Finds all the ReportTemplates that match the given search expression. Internally, this method invokes ReportTemplate#isMatch.
findUserGroups(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<UserGroup>	Finds all the UserGroups that match the given search expression. Internally, this method invokes UserGroup#isMatch.
findUsers(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<User>	Finds all the Users that match the given search expression. Internally, this method invokes User#isMatch.
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Company \| trakit.json.CompanyGeneral \| trakit.json.CompanyStyles \| trakit.json.CompanyPolicies \| trakit.json.CompanyReseller / json, /* boolean */ silent)	Company	Updates parameters for this Company from the given JSON literal
getAssetById(/** number */ id)	Asset	Retrieves the Asset with the given id or null if none found
getBehaviourById(/** number */ id)	Behaviour	Retrieves the Behaviour with the given id or null if none found.
getBehaviourLogById(/** number */ id)	BehaviourLog	Retrieves the BehaviourLog with the given id or null if none found.
getBehaviourScriptById(/** number */ id)	BehaviourScript	Retrieves the BehaviourScript with the given id or null if none found.
getContactById(/** number */ id)	Contact	Retrieves the Contact with the given id or null if none found
getDispatchJobById(/** number */ id)	DispatchJob	Searches the assets for the DispatchJob with the given id or null if none found.
getDispatchTaskById(/** number */ id)	DispatchTask	Searches the assets for the DispatchTask with the given id or null if none found.
getDispatchTemplateById(/** number */ id)	DispatchTemplate	Searches the assets for the DispatchTemplate with the given id or null if none found.
getDocumentById(/** number */ id)	Document	Retrieves the Document with the given id or null if none found
getGenerics()	Array.<Asset>	Filters the assets collection by kind
getHosCarrierById(/** number */ id)	HosCarrier	Retrieves the HosCarrier with the given id or null if none found
getHosEventById(/** number */ id)	HosEvent	Retrieves the HosEvent with the given id or null if none found
getHosInspectionById(/** number */ id)	HosInspection	Retrieves the HosInspection with the given id or null if none found
getIconById(/** number */ id)	Icon	Retrieves the Icon with the given id or null if none found
getMachineById(/** string */ key)	Machine	Retrieves the Machine with the given id or null if none found
getMaintenanceJobById(/** number */ id)	MaintenanceJob	Retrieves the MaintenanceJob with the given id or null if none found
getMaintenanceScheduleById(/** number */ id)	MaintenanceSchedule	Retrieves the MaintenanceSchedule with the given id or null if none found
getMessageById(/** number */ id)	Message	Searches the assets for the Message with the given id or null if none found.
getPersons()	Array.<Person>	Filters the assets collection by kind
getPictureById(/** number */ id)	Picture	Retrieves the Picture with the given id or null if none found
getPlaceById(/** number */ id)	Place	Retrieves the Place with the given id or null if none found
getProviderById(/** string */ id)	Provider	Retrieves the Provider with the given id or null if none found
getProviderConfigById(/** number */ id)	ProviderConfig	Retrieves the ProviderConfig with the given id or null if none found
getProviderConfigurationById(/** number */ id)	ProviderConfiguration	Retrieves the ProviderConfiguration with the given id or null if none found
getProviderRegistrationById(/** number \| string */ code)	ProviderRegistration	Retrieves the ProviderRegistration with the given id or null if none found
getProviderScriptById(/** number */ id)	ProviderScript	Retrieves the ProviderScript with the given id or null if none found
getReportResultById(/** number */ id)	ReportResult	Retrieves the ReportResult with the given id or null if none found
getReportScheduleById(/** number */ id)	ReportSchedule	Retrieves the ReportSchedule with the given id or null if none found
getReportTemplateById(/** number */ id)	ReportTemplate	Retrieves the ReportTemplate with the given id or null if none found
getSessionById(/** string */ handle)	Session	Retrieves the Session with the given handle or null if none found.
getTrailers()	Array.<Trailer>	Filters the assets collection by kind
getUserById(/** string */ login)	User	Retrieves the User with the given login or null if none found
getUserGroupById(/** number */ id)	UserGroup	Retrieves the UserGroup with the given id or null if none found
getVehicles()	Array.<Vehicle>	Filters the assets collection by kind
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
removeAsset(/** number */ id)	Asset	Finds and removes the Asset from the Company#assets array
removeBehaviour(/** number */ id)	Behaviour	Finds and removes the Behaviour from the Company#behaviours array.
removeBehaviourLog(/** number */ id)	BehaviourLog	Finds and removes the BehaviourLog from the Company#behaviourLogs array.
removeBehaviourScript(/** number */ id)	BehaviourScript	Finds and removes the BehaviourScript from the Company#behaviourScripts array.
removeContact(/** number */ id)	Contact	Finds and removes the Contact from the Company#contacts array
removeDispatchJob(/** number */ id)	DispatchJob	Finds and removes the DispatchJob from the Company#dispatchJobs array.
removeDispatchTask(/** number */ id)	DispatchTask	Finds and removes the DispatchTask from the Company#dispatchTasks array.
removeDispatchTemplate(/** number */ id)	DispatchTemplate	Finds and removes the DispatchTemplate from the Company#dispatchTemplates array.
removeDocument(/** number */ id)	Document	Finds and removes the Document from the Company#documents array.
removeHosCarrier(/** number */ id)	HosCarrier	Finds and removes the HosCarrier from the CompanyHoS#carriers array.
removeHosEvent(/** number */ id)	HosEvent	Finds and removes the HosEvent from the CompanyHoS#events array.
removeHosInspection(/** number */ id)	HosInspection	Finds and removes the HosInspection from the CompanyHoS#inspections array.
removeIcon(/** number */ id)	Icon	Finds and removes the Icon from the Company#icons array.
removeLabel(/** string */ name)	LabelStyle	Finds and removes the LabelStyle from the Company#labels array
removeMachine(/** string */ key)	Machine	Finds and removes the Machine from the Company#machines array
removeMaintenanceJob(/** number */ id)	MaintenanceJob	Finds and removes the MaintenanceJob from the Company#maintenanceJobs array.
removeMaintenanceSchedule(/** number */ id)	MaintenanceSchedule	Finds and removes the MaintenanceSchedule from the Company#maintenanceSchedules array.
removeMessage(/** number */ id)	Message	Finds and removes the Message from the Company#messages array.
removePicture(/** number */ id)	Picture	Finds and removes the Picture from the Company#pictures array
removePlace(/** number */ id)	Place	Finds and removes the Place from the Company#places array.
removeProvider(/** string */ id)	Provider	Finds and removes the Provider from the Company#providers array.
removeProviderConfig(/** number */ id)	ProviderConfig	Finds and removes the ProviderConfig from the Company#providerConfigs array.
removeProviderConfiguration(/** number */ id)	ProviderConfiguration	Finds and removes the ProviderConfiguration from the Company#providerConfigurations array.
removeProviderRegistration(/** number \| string */ code)	ProviderRegistration	Finds and removes the ProviderRegistration from the Company#providerRegistrations array.
removeProviderScript(/** number */ id)	ProviderScript	Finds and removes the ProviderScript from the Company#providerScripts array.
removeReportResult(/** number */ id)	ReportResult	Finds and removes the ReportResult from the Company#reportResults array.
removeReportSchedule(/** number */ id)	ReportSchedule	Finds and removes the ReportSchedule from the Company#reportSchedules array.
removeReportTemplate(/** number */ id)	ReportTemplate	Finds and removes the ReportTemplate from the Company#reportTemplates array.
removeSession(/** string */ handle)	Session	Finds and removes the Session from the Company#sessions array.
removeUser(/** string */ login)	User	Finds and removes the User from the Company#users array
removeUserGroup(/** number */ id)	UserGroup	Finds and removes the UserGroup from the Company#userGroups array
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

CompanyBilling class

Billing rules and policies this company uses to target its child companies.

Usage

var object = /** Company */ companyInstance.fromJSON(/** trakit.json.Company | trakit.json.CompanyGeneral | trakit.json.CompanyStyles | trakit.json.CompanyPolicies | trakit.json.CompanyReseller */ json, /** boolean */ silent);

Properties
Property	Type	Description
bundles	Array.<BillingBundle>	List of application identifiers for which Users are allowed.
company	Company	The Company to which this object belongs
policy	Array.<BillingRule>	Ranges of IPv4 addresses (using Cisco notation) to limit session creation to certain IPs.

Functions
Method	Returns	Description
fromJSON(/** trakit.json.SessionPolicy */ json)	CompanyBilling	Updates parameters for this CompanyBilling from the given JSON literal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

CompanyHoS class

Container for Hours of Service information related to the company

Usage

var object = /** Company */ companyInstance.fromJSON(/** trakit.json.Company | trakit.json.CompanyGeneral | trakit.json.CompanyStyles | trakit.json.CompanyPolicies | trakit.json.CompanyReseller */ json, /** boolean */ silent);

Properties
Property	Type	Description
carriers	Array.<HosCarrier>	A list of carriers under which this company operates
company	Company	The Company to which this object belongs
events	Array.<HosEvent>	The daily log for assets in this company
inspections	Array.<HosInspection>	Trip inspections logged for drivers and tractors of one of this company's carriers.

Functions
Method	Returns	Description
fromJSON(/** trakit.socket.getHosCarriersListResponse \| trakit.socket.getHosEventsListResponse \| trakit.socket.getHosInspectionsListResponse */ json)	CompanyHoS	Updates parameters for this CompanyHoS from the given JSON literal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

CompanyPasswords class

Password Policy for the Company

Usage

var object = /** Company */ companyInstance.fromJSON(/** trakit.json.Company | trakit.json.CompanyGeneral | trakit.json.CompanyStyles | trakit.json.CompanyPolicies | trakit.json.CompanyReseller */ json, /** boolean */ silent);

Properties
Property	Type	Description
company	Company	The Company to which this policy relates
expireMode	CompanyPasswordExpiryMode	Determines how the system will expire User passwords.
expireThreshold	number	Specified in days; minimum values is 14.
includeLetters	boolean	Alphabet characters required in passwords.
includeNumbers	boolean	Numeric characters are required.
includeSpecial	boolean	Require non-alphanumeric characters.
includeUpperLower	boolean	Big and small letters required.
minimumLength	number	Minimum length for a password (System restricted to minimum of 8)

Functions
Method	Returns	Description
fromJSON(/** trakit.json.PasswordPolicy */ json)	CompanyPasswords	Updates parameters for this CompanyPasswords from the given JSON literal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

CompanySessions class

Session creation, expiration, and restriction policy.

Usage

var object = /** Company */ companyInstance.fromJSON(/** trakit.json.Company | trakit.json.CompanyGeneral | trakit.json.CompanyStyles | trakit.json.CompanyPolicies | trakit.json.CompanyReseller */ json, /** boolean */ silent);

Properties
Property	Type	Description
applications	Array.<string>	List of application identifiers for which Users are allowed.
company	Company	The Company to which this object belongs
expireTimeout	number	The absolute duration a session can last (in minutes). This value has no effect if idleAllowed is false. Maximum value is two weeks.
idleAllowed	boolean	If false, sessions are invalidated as soon as the user disconnects.
ipv4Ranges	Array.<string>	Ranges of IPv4 addresses (using Cisco notation) to limit session creation to certain IPs.
maxSessions	number	The maximum number of simultaneous sessions allowed per User.
multiUser	CompanyMultiUser	Defines how to handle multiple concurrent session from a single user.

Functions
Method	Returns	Description
fromJSON(/** trakit.json.SessionPolicy */ json)	CompanySessions	Updates parameters for this CompanySessions from the given JSON literal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

LabelStyle class

Inheritance: MVCObject > LabelStyle

Labels are styled based on the available style definition

Usage

var object = /** Company */ companyInstance.createLabel(/** trakit.json.LabelStyle */ json);

Properties
Property	Type	Description
code	string	The codified name. See utility#codify.
company	Company	The Company to which this contact relates.
fill	string	Hex colour value for fills and backgrounds.
graphic	string	Short string with an icon-code for display purposes.
name	string	The un-codifed name with special characters and upper-case/lower-case preserved.
notes	string	Notes for label uses.
stroke	string	Hex colour value for text and outlines.

Functions
Method	Returns	Description
copy()	LabelStyle	Creates a duplicate of this LabelStyle
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
equals(/** LabelStyle */ label)	boolean	Compares this LatLng to another to see if they are equal
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.LabelStyle */ json)	LabelStyle	Updates parameters for this LabelStyle from the given JSON literal
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

CompanyMultiUser enum (string)

Defines session behaviour to limit Fleet Freedom sessions to one at a time.

Values
Value	Description
allow	Allow multiple concurrent sessions per user
deny	Disallow new sessions if a user already has an active session
replace	If a user has an active session, it is cancelled and the new session takes over as the only active session

CompanyPasswordExpiryMode enum (string)

Defines password expiration behaviour for the Company.

Values
Value	Description
days	Disable passwords every X number of days
never	Passwords never expire
sessions	Disable passwords every X number of sign-ins

Devices

Provider class

Inheritance: MVCObject > Provider

A Provider is a device or modem which provides events for an Asset

Usage

var object = new trakit.fleetfreedom.Provider(/** Company */ company, /** trakit.json.Provider */ object);

Properties
Property	Type	Description
asset	Asset	The Asset for which this hardware generates data.
assetId	number	The Asset#id for which this hardware generates data.
attributes	Dictionary.<!string, Dictionary.<string, ProviderAttribute>>	A list of constantly changing values given by the hardware as GPS, wiring, power, and other factors change.
company	Company	The Company to which this Provider belongs
config	ProviderConfiguration	Current programmed configuration.
firmware	string	Firmware version information.
geofenceLast	Date	A timestamp from when the geofence list was successfully updated on the provider.
geofenceStatus	ProvisioningStatus	Geofence programming status set by the Provisioner.
id	string	Unique identifier. The unique value the modem uses to identify itself.
information	Dictionary.<string, string>	A list of read-only values given by the hardware.
kind	ProviderType	The manufacturer and class of device.
name	string	Nickname given to the hardware.
notes	string	Notes about the hardware.
password	string	For security, most hardware platforms can be programmed with a unique password so that only authorized applications can make changes.
phoneNumber	number	Programmed phone number
pnd	string	The kind of Personal Navigation Device attached to the modem. Supported devices are Magellan and Garmin.
scriptLast	Date	A timestamp from when the script successfully updated on the provider.
scriptStatus	ProvisioningStatus	Configuration script programming status set by the Provisioner.
sim	string	ICCID of the SIM card currently installed.
since	Date	A timestamp that indicates when the Provider was suspended or deleted.
suspended	boolean	Indicates whether this Provider is suspended from event processing.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
decodePassword()	string	Decodes this Provider's password to a human readable version.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
encodePassword(/** string */ value)	string	Encodes a new password for this Provider.
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Provider / json, /* boolean */ silent)	Provider	Updates parameters for this Provider from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this provider. Used internally by Company#findProviders.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ProviderAttribute class

A detail about a provider updated by the gateway.

Usage

var object = new trakit.fleetfreedom.ProviderAttribute(/** Object */ value, /** string */ unit, /** Date */ dts);

Properties
Property	Type	Description
dts	Date	The date/time when this value was set.
unit	string	The units used for this value. IE: knots, hectometres per hour, miles per gallon, etc...
value	Object	The raw value; usually numeric.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ProviderConfig class

Inheritance: MVCObject > ProviderConfig

The configured script loaded onto the provider over-the-air to control it's reporting schedule and behaviour.

Usage

var object = new trakit.fleetfreedom.ProviderConfig(/** Company */ company, /** trakit.json.ProviderConfig */ object);

Properties
Property	Type	Description
company	Company	The company to which this configuration belongs.
geofences	Array.<SearchPattern>	A search pattern used to filter which Places' geometry are used as geofences. Use null to disable. Use "*" to match all the Places the Provider's Asset can match. Or use "#123456" or "label:term" like other Place search patterns.
id	number	Unique identifier of this configuration.
name	string	The nickname given to this configuration
notes	string	Simple details about how the providers are expected to behave.
parameters	Dictionary.<string, string>	The list of defined variable name/value pairs that the script requires.
script	ProviderScript	The ProviderScript which this configuration implements.
scriptId	number	Unique identifier of the ProviderScript this config inmplements.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.ProviderConfig / json, /* boolean */ silent)	ProviderConfig	Updates parameters for this ProviderConfig from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this provider. Used internally by Company#findProviders.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ProviderConfiguration class

Inheritance: MVCObject > ProviderConfiguration

A Script is something loaded onto a Provider device to configure its programming

Usage

var object = new trakit.fleetfreedom.ProviderConfiguration(/** Company */ company, /** trakit.json.ProviderConfiguration */ object);

Properties
Property	Type	Description
company	Company	The Company to which this ProviderConfiguration belongs
geofenceIds	Array.<number>	List of configured geofence IDs (taken from known Place#ids).
geofences	Array.<Place>	List of configured geofences (taken from known Places).
id	number	Unique identifier
name	string	Nickname given to the config.
notes	string	Details about which Providers should be using this config.
scriptParameters	Dictionary.<string, Object>	List of configured options.
templateId	number	The identifier of the logic used by the modem or phone.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.ProviderConfiguration / json, /* boolean */ silent)	ProviderConfiguration	Updates parameters for this ProviderConfiguration from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this configuration. Used internally by Company#findProviderConfigurations.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ProviderConfigurationNode class

Details about a provider configuration options node.

Usage

var object = new trakit.fleetfreedom.ProviderConfigurationNode(/** string */ id, /** string */ notes, /** boolean */ isAdvanced, /** string */ type);

Properties
Property	Type	Description
max	Object	Maximum value which can be configured.
min	Object	Minimum value which can be configured.
nodes	Dictionary.<string, ProviderConfigurationNode>	List of child-config nodes.
unit	string	The unit used for configuration.
value	Object	The configured value.

ProviderConfigurationType class

Inheritance: MVCObject > ProviderConfigurationType

A template to create Provider Configurations

Usage

var object = new trakit.fleetfreedom.ProviderConfigurationType(/** trakit.json.ProviderConfigurationType */ object);

Properties
Property	Type	Description
geofencesTypes	Array.<PlaceShapeTypes>	Supported geofence types.
id	number	Unique identifier
maxGeofences	number	Maximum number of geofences allowed.
minGeofences	number	Minimum number of geofences required by the script.
name	string	Nickname given to the modem.
notes	string	Details about the value setting.
providerType	ProviderType	Type of providers this config can be applied to.
scriptOptions	Dictionary.<string, ProviderConfigurationNode>	List of options to be configured.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.ProviderConfigurationType / json, /* boolean */ silent)	ProviderConfigurationType	Updates parameters for this ProviderConfigurationType from the given JSON literal
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ProviderRegistration class

Inheritance: MVCObject > ProviderRegistration

The temporary reference to a device whose ownership is pending.

Usage

var object = new trakit.fleetfreedom.ProviderRegistration(/** Company */ company, /** trakit.json.ProviderRegistration */ object);

Properties
Property	Type	Description
asset	Asset	The Asset for which this device will provide data.
assetId	number	The unique identifier of the Asset for which this device will provide data.
code	string	Unique identifier of this registration.
company	Company	The company to which this registration belongs.
completed	Date	Date/time stamp of when this registration ended successfully.
config	ProviderConfig \| ProviderConfiguration	The predefined configuration this device will use.
configId	number	Unique identifier of the configuration this device will use.
expires	Date	The expiry date for this registration.
identifier	string	The unique identifier of the device that completed this registration.
kind	ProviderType	The kind of protocol this device supports.
login	string	The unique identifier the user who generated this registration.
name	string	A nickname given to the device once it has been provisioned.
notes	string	Notes!
password	string	The password programmed on the device used to ensure the system is the only client authorized to make changes.
phone	number	The phone number of the device being provisioned.
since	Date	Date/time stamp of when this registration began.
user	User	The user who generated this registration.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.ProviderRegistration / json, /* boolean */ silent)	ProviderRegistration	Updates parameters for this ProviderRegistration from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this provider. Used internally by Company#findProviderRegistration.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ProviderScript class

Inheritance: MVCObject > ProviderScript

This class describes a type of logic applied to a provider. A script will generate a file which is loaded onto a provider in the field.

Usage

var object = new trakit.fleetfreedom.ProviderScript(/** Company */ company, /** trakit.json.ProviderScript */ object);

Properties
Property	Type	Description
blocks	Array.<ProviderScriptBlock>	Blocks of file data which are (optionally) included in the script data file.
company	Company	The Company to which this ProviderScript belongs
fill	string	Hex colour value for fills and backgrounds.
global	boolean	When true, this script is available to all child Companys.
graphic	string	Short string with an icon-code for display purposes.
id	number	Unique identifier. The unique value the modem uses to identify itself.
kind	ProviderType	The manufacturer and class of device.
name	string	Nickname given to the hardware.
notes	string	Notes about the hardware.
parameters	Dictionary.<string, ProviderScriptParameter>	Parameter definitions for this script, including type-hints and default values. Since the gateways use case insensitive parameter matching, the keys are all converted to lower-case.
stroke	string	Hex colour value for text and outlines.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.ProviderScript / json, /* boolean */ silent)	ProviderScript	Updates parameters for this ProviderScript from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this provider. Used internally by Company#findProviders.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ProviderScriptBlock class

A chunk of script and variables used to assemble a working ProviderScript.

Usage

var object = new trakit.fleetfreedom.ProviderScriptBlock(/** string */ content, /** string */ replace, /** string */ condition, /** string */ validate);

Properties
Property	Type	Description
condition	string	When defined, this condition matches a ProviderScriptParameter defined in the ProviderConfig to include or exclude this chunk from the script.
content	string	A chunk of the file loaded onto a provider with it's variables replaced with configurable variables. Trailing or leading whitespace should be included here, so when blocks are merged, so too is the newline characters.
replace	RegExp	A regular expression used to match variables in the content. RegExp is case insensitive and multiline.
validate	string	Used in conjunction with condition, this value must match the given ProviderScriptParameter value to have the chunk included.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ProviderScriptParameter class

Definition of an argument passed to a ProviderScript.

Usage

var object = new trakit.fleetfreedom.ProviderScriptParameter(/** ProviderScriptParameterType */ type, /** string */ value, /** string */ notes, /** string */ context, /** boolean */ advanced);

Properties
Property	Type	Description
advanced	boolean	Used as a hint that this parameter controls an advanced script option and should only be set if you really know what you're doing.
context	string	Gives a hint to the client on the best UI to use for editing. For example, "checkbox" is a good UI hint for boolean parameter types.
notes	string	Usage notes.
type	ProviderScriptParameterType	Simple type information for the gateway to process.
value	string	The value is given as a string, but parsed into native type when used by the gateway.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ProviderScriptParameterType enum (string)

Possible data-types given to ProviderScriptParameter.

Values
Value	Description
boolean	True or false.
number	Numeric value (double-precision floating point number).
text	Text.

ProviderType enum (string)

The types of providers supported by Fleet Freedom.

Values
Value	Description
atrack	ATrack Technology AX9 and AK11 modems
bewhere	BeWhere asset trackers
calamp	CalAmp series modems
datatrans	TachWest DT series modems
enfora	Novatel series modems (Enfora)
genx	GenX Mobile GNX series modems
json	Fleet Freedom JSON protocol
lbs	Bell Mobility user-plane LBS compatible phones
mobile	Android, iOS, and Blackberry apps
smartwitness	SmartWitness dashcam formats
titan	Certified Tracking Solutions Titan series modems
unknown	Undefined type
xirgo	Xirgo modems

ProvisioningStatus enum (string)

Progress lifetime of changing the on-board information on a provider.

Values
Value	Description
cancelled	Sending of the new configuration was halted by a user.
completed	New configuration successfully sent to provider.
created	The new configuration has been created, but not yet sent to the provider.
error	Something went wrong while trying to send configuration.
inProgress	Currently sending configuration over-the-air to the provider.
maxRetries	The maximum number of retries were attempted before giving up.
otaSent	A message was sent to the provider asking it to check in.
partial	Only a partial configuration was sent to the provider.
pending	Provider is notified of new configuration, but has not yet checked in.
unknown	Your guess is as good as mine. It should never be this.

Dispatch and Tasks

AssetDispatch class

Inheritance: MVCObject > AssetDispatch

A Dispatch is a list of tasks and directions assigned to an Asset

Usage

var object = new trakit.fleetfreedom.AssetDispatch(/** Asset */ asset, /** trakit.json.AssetDispatch */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which th jobs are assigned.
directions	Array.<DispatchDirection>	Instructions on how to travel between jobs.
jobIds	Array.<number>	Identifier of the jobs.
jobs	Array.<DispatchJob>	List of jobs to perform during this dispatch.
lastDispatched	Date	Timestamp from the last update to this AssetDispatch by a User, Machine, trakit.json.Asset, or an assigned DispatchJob.
tasks	Array.<DispatchTask>	List of tasks to perform during this dispatch.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.AssetDispatch / json, /* boolean */ silent)	AssetDispatch	Updates parameters for this Dispatch from the given JSON literal
getBounds()	LatLngBounds	Gets a latlng bounding box for the tasks (and optional directions)
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

DispatchDirection class

Driving directions and details like duration and distance.

Usage

var object = new trakit.fleetfreedom.DispatchDirection(/** trakit.json.DispatchDirection */ json);

Properties
Property	Type	Description
directions	Array.<DispatchDirection>	For complex routes, the sub-directions provide a breakdown or additional details.
distance	number	The total distance of these directions (including sub-directions if applicable).
duration	TimeSpan	The total duration of these directions (including sub-directions if applicable).
instructions	string	Text hint for the driver for the action to perform.
path	Array.<LatLng>	A route path to display on a map.

Functions
Method	Returns	Description
getBounds()	LatLngBounds	Gets a latlng bounding box for the path and sub-directions.
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

DispatchJob class

Inheritance: MVCObject > DispatchJob

Some work that needs to be done by performing one or more DispatchSteps.

Usage

var object = new trakit.fleetfreedom.DispatchJob(/** Company */ company, /** trakit.json.DispatchJob */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which this object relates.
assetId	number	Identifier of the asset assigned to this job.
attachmentIds	Array.<number>	A list of Document#ids attached to this job.
attachments	Array.<Document>	A list of Documents attached to this job.
created	Date	When this job was first assigned.
formIds	Array.<number>	A list of FormResult#ids attached to this job.
forms	Array.<FormResult>	A list of FormResults attached to this job.
id	number	Unique identifier
instructions	string	Details about how to go about performing this job.
labels	Array.<string>	Codified label names used to relate (unassigned) jobs to Assets.
name	string	Short description of this job.
priority	DispatchJobPriority	The importance of this job when scheduling for an Asset.
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
steps	Array.<DispatchStep>	A list of coordinates to visit in order to carry out the work for this job.
tags	Array.<string>	The codified status tag names reflecting the conditions of this job.
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
areAllStatuses(/** DispatchStepStatus */ status)	boolean	Will return true if all the DispatchStep#statuses match the given status.
areAllStepsScheduled(/** Date */ today)	boolean	Will return true if all the DispatchSteps have a valid DispatchStep#eta, and it's from "today".
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.DispatchJob / json, /* boolean */ silent)	DispatchJob	Updates parameters for this DispatchJob from the given JSON literal
getActiveStep()	DispatchStep	Returns the DispatchStep in the sequence that is currently being worked on, or returns null. This method ofter returns the same result as {@DispatchJob#getNextStep} because it will find.
getBounds()	LatLngBounds	Returns a LatLngBounds which encloses all the steps.
getLastStep()	DispatchStep	Returns the most recent DispatchStep in the sequence that has been updated, or null.
getNextStep()	DispatchStep	Returns the first DispatchStep in the sequence that is not completed, or returns null.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this asset. Used internally by Company#findDispatchJobs.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

DispatchStep class

A portion of work for a DispatchJob.

Usage

var object = new trakit.fleetfreedom.DispatchStep(/** DispatchJob | DispatchTemplateJob */ job, /** trakit.json.DispatchJob */ json);

Properties
Property	Type	Description
address	string	The street address of where the step must be completed.
duration	TimeSpan	The expected time-on-site (in seconds; affects ETAs for other jobs in a Dispatch).
eta	Date	The optional estimated time of arrival for the asset.
latlng	LatLng	GPS coordinates of this step.
name	string	Short description of this step.
notes	string	Notes filled out by field-employee.
place	Place	The Place related to this step if applicable.
placeId	number	The Place#id related to this step if applicable.
signatory	string	The name of the person who signed the step's completion.
signature	boolean	Indicates whether the step has a signature.
states	Dictionary.<DispatchStepStatus, DispatchStepState>	The progress of this step.
status	DispatchStepStatus	The status of the step based on the progression of states.
timeOnSite	number	The total number of seconds in the DispatchJob#duration.
updated	Date	Timestamp from the lastest DispatchStep status update.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

DispatchStepState class

Details about the lifetime of a DispatchStep.

Usage

var object = new trakit.fleetfreedom.DispatchStepState(/** trakit.json.DispatchStepState */ json);

Properties
Property	Type	Description
latlng	LatLng	The coordinates from the Asset when the update happened.
updated	Date	A timestamp from when the lifetime was updated.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

DispatchTask class

Inheritance: MVCObject > DispatchTask

A task is a piece of a Dispatch which must be completed

Usage

var object = new trakit.fleetfreedom.DispatchTask(/** Company */ company, /** trakit.json.DispatchTask */ object);

Properties
Property	Type	Description
address	string	The address of the task's location.
arrived	Date	A flag set by the system if the Asset has arrived at this task's location.
asset	Asset	The Asset to which this object relates
assetId	number	Unique identifier of this task's Asset.
attachmentIds	Array.<number>	A list of Document#ids attached to this task.
attachments	Array.<Document>	A list of Documents attached to this task.
completed	Date	Flag set by the system when the task is completed (usually behaviour and mobile provider working together).
created	Date	When this task was first assigned.
duration	TimeSpan	The expected time-on-site (in seconds; affects ETAs for other tasks in a Dispatch).
eta	Date	Expected Time of Arrival.
formIds	Array.<number>	A list of FormResult#ids attached to this task.
forms	Array.<FormResult>	A list of FormResults attached to this task.
id	number	Unique identifier
instructions	string	Details about how to go about performing this task.
latlng	LatLng	GPS coordinates of this task.
name	string	Short description of this task.
notes	string	Notes filled out by field-employee.
place	Place	The Place related to this task if applicable.
placeId	number	The Place#id related to this task if applicable.
reference	string	Getter/setter for the references field named "reference".
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
signatory	string	The name filled out by the person who signed.
signature	boolean	When true, a signature was captured and can be retrieved using the Pictures API.
status	TaskStatus	The status of this task. See TaskStatus for details.
timeOnSite	number	The total number of seconds in the DispatchTask#duration.
updated	string	Timestamp from the last change made to this task.
updater	string	Either the login of the user or the identifier of the provider that changed this task.
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.DispatchTask / json, /* boolean */ silent)	DispatchTask	Updates parameters for this DispatchTask from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this asset. Used internally by Company#findDispatchTasks.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

DispatchTemplate class

Inheritance: MVCObject > DispatchTemplate

A pre-made Dispatch which can be applied many times to multiple Assets.

Usage

var object = new trakit.fleetfreedom.DispatchTemplate(/** Company */ company, /** trakit.json.DispatchTemplate */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which the created DispatchJobs would be assigned.
assetId	number	The identifier of the asset for which this template is the default.
company	Company	The Company which owns this DispatchTemplate.
directions	Array.<DispatchDirection>	Driving directions and route path details.
id	number	Unique identifier
jobs	Array.<DispatchTemplateJob>	The list of jobs to create when deploying this template.
labels	Array.<string>	Codified label names used to target applicable Assets for this dispatch.
name	string	The name of this template.
notes	string	Notes about this template.
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** DispatchTemplate / json, /* boolean */ silent)	DispatchTemplate	Updates parameters for this DispatchJob from the given JSON literal
getBounds()	LatLngBounds	Gets a latlng bounding box for the path and sub-directions.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

DispatchTemplateJob class

A reusable template of work that needs to be done by performing one or more trakit.json.DispatchSteps.

Usage

var object = new trakit.fleetfreedom.DispatchTemplateJob(/** Company */ company, /** trakit.json.DispatchTemplateJob */ json);

Properties
Property	Type	Description
attachmentIds	Array.<number>	A list of Document#ids attached to this job.
attachments	Array.<Document>	A list of Documents attached to this job.
formIds	Array.<number>	A list of FormResult#ids attached to this job.
forms	Array.<FormResult>	A list of FormResults attached to this job.
instructions	string	Instructions (filled out by dispatcher) for the field-employee to help them completed the job.
name	string	The name of this template or the work needed to be performed.
priority	DispatchJobPriority	The importance of this job when scheduling for an asset.
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
steps	Array.<DispatchStep>	A list of coordinates to visit in order to carry out the work for this job.

DispatchJobPriority enum (string)

A value assigned to trakit.json.DispatchJobs in order to weigh them when optimizing a route. More details

Values
Value	Description
high	More important job that will be routed to first unless the next high importance job is much farther away.
low	Low priority jobs are assigned towards the end of a dispatch, unless they are in very close proximity to another job.
medium	A normal job that will be done at the first opportunity.
standby	Will be done last, after all others, if at all.
urgent	Must be done first, before all others.

DispatchStepStatus enum (string)

The lifetime of all trakit.json.DispatchSteps (in order). More details

Values
Value	Description
arrived	The asset has arrived at the DispatchStep's location.
completed	The DispatchStep is done (or the asset has departed the location).
onRoute	The asset is on the way to the DispatchStep's location next.
pending	The DispatchStep has not yet been started.

TaskStatus enum (string)

Values
Value	Description
arrived	The Asset has arrived at the destination.
cancelled	The DispatchTask has been cancelled either by the driver or the dispatcher.
completed	The DispatchTask has been completed (and signature captured).
created	The DispatchTask has been created, but not yet delivered to the remote device.
damaged	An item associated with this DispatchTask is damaged.
droppedOff	An item was dropped-off for this DispatchTask.
onRoute	The Asset is now on its way to the destination.
pickedUp	An item was picked-up for this DispatchTask.
queued	The DispatchTask has been delivered to the remote device, or was created on the remote device.
unsuccessful	The DispatchTask couldn't be completed by the Asset.
waiting	The Asset is waiting and can't complete the DispatchTask.

Drawing

drawing object

A utility library exposing algorithms for a flat plane.

Usage

var value = trakit.fleetfreedom.drawing.member;
/* or */
var result = trakit.fleetfreedom.drawing.member(...params);

Functions
Method	Returns	Description
pathLength(/** Array.<Point> */ path)	number	Calculates the total length of the given path
pathReduce(/** Array.<Point> / path, /* number */ tolerance)	Array.<Point>	Performs a Douglas-Peucker path reduction based on the given tolerance.
pointAngle(/** number / startingX, /* number / startingY, /* number / endingX, /* number */ endingY)	number	Calculates the starting angle (in degrees) between two Points using the top as zero. Does not return negative values.
pointDistance(/** number / startingX, /* number / startingY, /* number / endingX, /* number */ endingY)	number	Calculates the distance between two points using Pythagorean theorem.
pointOrthogonal(/** number / firstX, /* number / firstY, /* number / midX, /* number / midY, /* number / lastX, /* number */ lastY)		Calculates the orthogonal height of a triangle. The orthogonal height is calculated by drawing a line between the firstPoint and lastPoint, then getting the length of a line drawn up from the line to the midPoint at a 90 degree angle.
pointPythagora(/** number / width, /* number */ height)	number	Calculates the Pythagorean length of a triangle given the length of the other two sides.
pointVector(/** number / distance, /* number */ degrees)	Point	Calculates the vector which can be used to find the point based on the given direction and distance
polyArea(/** Array.<Point> */ path)	number	Calculates the total area occupied by the given path. Treats non-closed paths as closed paths.
polyContains(/** Array.<Point> / poly, /* number / pointX, /* number */ pointY)	boolean	A utility function to determine if a given point is inside the given polygon path.
polyReduce(/** Array.<Point> / path, /* number */ tolerance)	Array.<Point>	Performs a Douglas-Peucker path reduction on a polygon for the given tolerance. The start/end points are variable and the end point is trimmed from the result.
polyWrapper(/** Array.<Point> */ points)	Array.<Point>	Wraps the given points into a polygonal path. The given points do not need to be a path. The returned path is not closed.
radialArea(/** number */ radius)	number	Calculates the area of a circle based on the given radius.
radialCircumference(/** number */ radius)	number	Calculates the circumference of a circle based on the given radius.
radialSmallest(/** Array.<Point> / points, /* number */ iterations)	Radial	Solves the Minimum Enclosing Circle problem using Badoiu Clarkson's algorithm.

Point class

An x/y coordinate

Usage

var object = new trakit.fleetfreedom.Point(/** number */ x, /** number */ y);

Properties
Property	Type	Description
x	number	Left coordinate
y	number	Top coordinate

Functions
Method	Returns	Description
angleTo(/** Point */ point)	number	Calculates the angle (in degrees) to the given point
distanceTo(/** Point */ point)	number	Calculates the distance between two points
equals(/** Point / point, /* number */ precision)	boolean	Compares this Point to another to see if they are equal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
toOffset(/** Point */ offset)	Point	Creates a new Point based on the given offset
toString(/** string */ delimiter)	string	Returns a string representation
toTranslated(/** number / distance, /* number */ degrees)	Point	Creates a new Point at the given angle and distance

Radial class

A boundary based on a centre point and a radius

Usage

var object = new trakit.fleetfreedom.Radial(/** number */ x, /** number */ y, /** number */ radius);

Properties
Property	Type	Description
r	number	The radial distance
x	number	Left coordinate
y	number	Top coordinate

Functions
Method	Returns	Description
contains(/** Point */ point)	boolean	Determines if the given Point is contained by this Radial
copy()	Radial	Creates a duplicate of this Radial
equals(/** Radial / radial, /* number */ precision)	boolean	Compares this Point to another to see if they are equal
extend(/** Point \| Array.<Point> */ object)	Radial	Extends the boundary to envelop the given point(s)
getCentre()	Point	Returns the centre point representation
getSize()	Size	Returns the centre point representation
grow(/** number */ length)	Radial	Increases the boundary radius
overlaps(/** Radial */ bound)	boolean	Determines if the given Radial is overlaps this Radial in any way
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
toOffset(/** Point */ point)	Radial	Moves the Radial by the given offset
toRectangle(/** boolean */ clip)	Rectangle	Converts this radial boundary into a square boundary
toString(/** string */ delimiter)	string	Returns a string representation
toTranslated(/** number / distance, /* number */ degrees)	Radial	Moves the Radial by the given angle and distance

Rectangle class

A four-sided box

Usage

var object = new trakit.fleetfreedom.Rectangle(/** Point | Rectangle | Object */ topleft, /** Point | Rectangle | Object */ bottomright);

Properties
Property	Type	Description
bottom	number	The bottom-most coordinate
height	number	The absolute height of this Rectangle
left	number	The left-most coordinate
right	number	The right-most coordinate
top	number	The top-most coordinate
width	number	The absolute width of this Rectangle

Functions
Method	Returns	Description
contains(/** Point */ point)	boolean	Determines if the given Point is contained by this Rectangle
copy()	Rectangle	Validates the boundary and creates a duplicate of this Rectangle
equals(/** Rectangle / rectangle, /* number */ precision)	boolean	Compares this Rectangle to another to see if they are equal
expand(/** Point \| Rectangle \| Array.<(Point \| Rectangle)> */ object)	Rectangle	Extends the boundary to envelop the given point(s) but does not automatically validate. This comes in efficient when doing many operations on a single Rectangle
extend(/** Point \| Rectangle \| Array.<(Point \| Rectangle)> */ object)	Rectangle	Extends the boundary to envelop the given point(s) and automatically validates
getBottomLeft()	Point	Returns the Point at the bottom-most/left-most corner.
getBottomRight()	Point	Returns the Point at the bottom-most/right-most corner.
getCentre()	Point	Returns the Point at the centre.
getSize()	Size	Validates the boundary and creates a Size representation
getTopLeft()	Point	Returns the Point at the top-most/left-most corner.
getTopRight()	Point	Returns the Point at the top-most/right-most corner.
grow(/** number / width, /* number / height, /* string */ direction)	Rectangle	Increases the size of the boundary by the given width and height
isEmpty()	boolean	Checks to see if the bounds are valid, and that the corners are different coordinates.
isValid()	boolean	Checks to see if the bounds are valid (not inside-out).
overlaps(/** Rectangle */ rectangle)	boolean	Determines if the given Rectangle is overlaps this Rectangle in any way
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
toOffset(/** Point */ point)	Rectangle	Creates a new Rectangle at the given angle and distance
toRadial(/** boolean */ clip)	Radial	Validates the boundary and returns a Radial
toString(/** string */ delimiter)	string	Validates the boundary and returns a string representation
toTranslated(/** number / distance, /* number */ degrees)	Shape	Creates a new Rectangle at the given angle and distance
validate()	Rectangle	Validates the boundary by ensuring the top value is less than the bottom value, and the left value is less than the right value. Also adjusts the width and height values

Size class

Size object for width/height/depth

Usage

var object = new trakit.fleetfreedom.Size(/** number */ width, /** number */ height);

Properties
Property	Type	Description
height	number
width	number

Functions
Method	Returns	Description
equals(/** Size / size, /* number */ precision)	boolean	Compares this Size to another to see if they are equal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
toString(/** string */ delimiter)	string	Returns a string representation

Field Forms

FormFieldAttachments class

Inheritance: FormFieldBase > FormFieldAttachments

A control to allow the user to attach Pictures or Documents.

Usage

var object = new trakit.fleetfreedom.FormFieldAttachments(/** FormFieldType */ kind, /** number */ minimum, /** number */ maximum, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	One of the values from FormFieldAttachments#supported.
maximum	number	The (optional) maximum number of files.
minimum	number	The (optional) minimum number of files.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true when the given value is a list of number concatenated with a comma, and a minimum number of files is not set or the given value has that many or more, and a maximum number of files is not set or the given value has that many or fewer.

FormFieldBase class

An abstract/base class for the common form field UI members.

Usage

var object = new trakit.fleetfreedom.FormFieldBase(/** FormFieldType */ kind, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	The type of interface control that should be presented to the user.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Validates the given value for the type of control and its options.

Static Methods
Method	Returns	Description
FormFieldBase.fromJSON()	FormFieldBase

FormFieldBoolean class

Inheritance: FormFieldBase > FormFieldBoolean

A true/false (or either-or) input control.

Usage

var object = new trakit.fleetfreedom.FormFieldBoolean(/** FormFieldType */ kind, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	One of the values from FormFieldBoolean#supported.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true if the value can be parsed as a boolean.

FormFieldChoice class

Inheritance: FormFieldBase > FormFieldChoice

A single- or multiple-choice input control.

Usage

var object = new trakit.fleetfreedom.FormFieldChoice(/** Object | Array */ choices, /** number */ minimum, /** number */ maximum, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
choices	Map	The list of choices available and their values.
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	Always FormFieldType.choice.
maximum	number	Maximum number of choices that must be selected.
minimum	number	Minimum number of choices that must be selected.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true if there is no minimum number of selections, or that number is met, and if there is no maximum number of selections, or the selctions to not exceedd that number.

FormFieldDate class

Inheritance: FormFieldBase > FormFieldDate

A control to choose a date and (optionally) a time.

Usage

var object = new trakit.fleetfreedom.FormFieldDate(/** FormFieldType */ kind, /** Date */ minimum, /** Date */ maximum, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	One of the values from FormFieldDate#supported.
maximum	Date	The (optional) maximum date/time.
minimum	Date	The (optional) minimum date/time.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true when the given value can be parsed into a date/time, and a minimum date/time is not set, or the given value is that early or is later, and a maximum date/time is not set, or the given value is that late or is earlier.

FormFieldNumeric class

Inheritance: FormFieldBase > FormFieldNumeric

A numeric value input control with multiple contexts available.

Usage

var object = new trakit.fleetfreedom.FormFieldNumeric(/** FormFieldType */ kind, /** number */ precision, /** number */ minimum, /** number */ maximum, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	One of the values from FormFieldNumeric#supported.
maximum	number	The (optional) maximum value.
minimum	number	The (optional) minimum value.
notes	string	Notes or special instructions for this control.
precision	number	Number of decimal places of accuracy are required.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true if the given value is a number, and it's not infinity, and a minimum value is not set, or the given value is that small or is larger, and a maximum value is not set, or the given value is that large or is smaller.

FormFieldSignature class

Inheritance: FormFieldBase > FormFieldSignature

A control to capture a signature from the user.

Usage

var object = new trakit.fleetfreedom.FormFieldSignature(/** string */ notes, /** boolean */ required, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	Always FormFieldType.signature.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	Always null.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true if the given input s a known timezone.

FormFieldText class

Inheritance: FormFieldBase > FormFieldText

A text input control.

Usage

var object = new trakit.fleetfreedom.FormFieldText(/** number */ rows, /** number */ minimum, /** number */ maximum, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	Always FormFieldType.text.
maximum	number	Maximum length of entered text to make it a valid entry.
minimum	number	Minimum length of entered text to make it a valid entry.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
rows	number	The number of rows of text to display.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true if a non-white-space value is entered, and there is no minimum length or the value is that long or longer, and there is no maximum length or the value is that long or shorter.

FormFieldTime class

Inheritance: FormFieldBase > FormFieldTime

A control to choose a time or duration longer than 24 hours.

Usage

var object = new trakit.fleetfreedom.FormFieldTime(/** FormFieldType */ kind, /** number */ minimum, /** number */ maximum, /** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	One of the values from FormFieldTime#supported.
maximum	number	The (optional) maximum time span.
minimum	number	The (optional) minimum time span.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true when the given input can be parsed as a time, and a minimum time is not set, or the given value is that early or is later, and a maximum time is not set, or the given value is that late or is earlier.

FormFieldTimezone class

Inheritance: FormFieldBase > FormFieldTimezone

A timezone selection control.

Usage

var object = new trakit.fleetfreedom.FormFieldTimezone(/** string */ notes, /** boolean */ required, /** string */ value, /** boolean */ editable);

Properties
Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
kind	FormFieldType	Always FormFieldType.timezone.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
supported	Array.<FormFieldType>	A list of supported FormFieldTypes that this class supports.
value	string	The default value for the field in the template.

Functions
Method	Returns	Description
isValid(/** string */ given)	boolean	Returns true if the given input s a known timezone.

FormResult class

Inheritance: MVCObject > FormResult

A completed form submitted by a User or Asset.

Usage

var object = new trakit.fleetfreedom.FormResult(/** Asset */ asset, /** trakit.json.FormTemplate */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which this object relates.
fields	Date	A timestamp from when this form was completed by a User or Asset.
id	number	Unique identifier
latlng	LatLng	A timestamp from when this form was completed by a User or Asset.
name	string	Name of this form.
notes	string	Notes!
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.FormResult / json, /* boolean */ silent)	FormResult	Updates parameters for this FormResult from the given JSON literal
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

FormTemplate class

Inheritance: MVCObject > FormTemplate

The full definition of a form that needs to be filled out.

Usage

var object = new trakit.fleetfreedom.FormTemplate(/** Company */ company, /** trakit.json.FormTemplate */ object);

Properties
Property	Type	Description
company	Company	The Company to which this form belongs.
fields	Map.<string, FormFieldBase>	All the user fillable fields by name.
id	number	Unique identifier of this form.
name	string	Name for this form.
notes	string	Notes!
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.FormTemplate */ json)		Updates parameters for this form from the given JSON literal.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

File Hosting

DashcamData class

Inheritance: MVCObject > DashcamData

A DashcamData is an employee of a Company, but who may also perform other roles in other companies.

Usage

var object = new trakit.fleetfreedom.DashcamData(/** Company */ company, /** trakit.json.DashcamData */ json);

Properties
Property	Type	Description
altitude	number	Altitude of the coordinates at the start of the dachcam data.
asset	Asset	The asset tied to the provider at the time.
assetId	number	Unique identifier of the asset tied to the provider at the time.
camera	number	Number assigned to the camera that took the image/video.
company	Company	The Company to which this data belongs.
end	Date	Timestamp of when this dachcam data ended. For images, the start and end and the same.
guid	string	Unique identifier
heading	number	Bearing of the coordinates at the start of the dachcam data.
kind	DashcamDataType	The type of data being hosted.
latlng	LatLng	Coordinates of the start of the dachcam data.
provider	Provider	The provider that sent the data.
providerId	string	Unique identifier of the provider that sent the data.
speed	number	Speed of the coordinates at the start of the dachcam data.
start	Date	Timestamp of when this dachcam data started. For images, the start and end and the same.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this dashcam data. Used internally by Company#findDashcamDatas.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

Document class

Inheritance: MVCObject > Document

A document is a file stored temporarily by the system.

Usage

var object = new trakit.fleetfreedom.Document(/** Company */ company, /** trakit.json.Document */ object);

Properties
Property	Type	Description
bytes	number	The file's size on the disk.
company	Company	The Company to which this Document belongs.
expiry	Date	The date and time this file will be automatically purged from our system.
id	number	Unique identifier
mime	string	MIME type of this file.
name	string	The filename or a nickname given to this file.
notes	string	Miscellaneous notes for file.
references	Dictionary.<string, string>	Name/value collections of custom fields used to refer to external systems.
src	string	The relative path used to retrieve this file.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

Icon class

Inheritance: MVCObject > Icon

A mapped iconic representation of an Asset

Usage

var object = new trakit.fleetfreedom.Icon(/** Company */ company, /** trakit.json.Icon */ object);

Properties
Property	Type	Description
category	string	The category of icon like "Truck" or "Building".
company	Company	The Company to which this icon relates.
global	boolean	Indicates that the icon can be used, and is available to child companies.
glyphs	Array.<IconGlyph>	The glyphs used to show detail on this icon.
id	number	Unique identifier of an Icon (value is NaN for unsaved).
label	IconLabel	Definition for the on-map label.
name	string	Descriptive name of the icon.
notes	string	Notes about this icon or uses.
usage	Array.<string>	Tag-style list of objects this icon should be used for.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
copy()	Icon	Creates a duplicate of this Icon
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
equals(/** Icon */ icon)	boolean	Compares this Icon to another to see if they are equal
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Icon / json, /* boolean */ silent)	Icon	Updates parameters for this Icon from the given JSON literal
getBaseGlyph()	IconGlyph	Gets the first glyph to use as the standard icon.
getGlyphs(/** string */ tag)	Array.<IconGlyph>	Compares this Icon to another to see if they are equal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this icon. Used internally by Company#findIcons.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

IconGlyph class

Icon details which are status-tag specific

Usage

var object = new trakit.fleetfreedom.IconGlyph(/** Icon */ icon, /** Array.<string> */ tags, /** string */ src, /** Size */ size, /** Point */ anchor, /** IconLayer */ layer, /** number */ zIndex, /** boolean */ rotates);

Properties
Property	Type	Description
anchor	Point	The offset from the LatLng in pixels
icon	Icon	The Icon to which this glyph relates.
layer	IconLayer	Mapped icons are layered, on which layer does this glyph display.
rotates	boolean	When true, the icon should be rotated to match the direction of travel for the position it represents.
size	Size	Size of the glyph in pixels
src	string	URL for the image using the Pictures API for icons.
tags	Array.<string>	Tags which must be present to use this glyph.
zIndex	number	The z-order of this glyph compared to other glyphs for the same layer.

Functions
Method	Returns	Description
copy()	IconGlyph	Creates a duplicate of this IconGlyph
equals(/** IconGlyph */ glyph)	boolean	Compares this IconGlyph to another to see if they are equal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

IconLabel class

An Icon's label definition

Usage

var object = new trakit.fleetfreedom.IconLabel(/** Icon */ icon, /** string */ align, /** Point */ anchor, /** string */ colour);

Properties
Property	Type	Description
align	string	Determines which corner the label is attached with
anchor	Point	The offset from the LatLng in pixels
colour	string	Background colour of the label (foreground calculated automatically)
icon	Icon	The Icon to which this label relates

Functions
Method	Returns	Description
copy()	IconLabel	Creates a duplicate of this IconLabel
equals(/** IconLabel */ label)	boolean	Compares this IconLabel to another to see if they are equal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

Picture class

Inheritance: MVCObject > Picture

Pictures are just what they sound like; a photo or image.

Usage

var object = new trakit.fleetfreedom.Picture(/** Company */ company, /** trakit.json.Picture */ object);

Properties
Property	Type	Description
bytes	number	The image's filesize on the disk.
company	Company	The Company to which this contact relates
focals	Array.<Rectangle>	A list of focal points like faces.
id	number	Unique identifier
name	string	The name of the picture or its contents.
notes	string	Notes about the picture or contents.
size	Size	The size in pixels of this image.
src	string	URL for the image using the Pictures API.
uses	number	The number of items (assets, contact, tasks, etc) using this image. (updated hourly)
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
copy()	Picture	Creates a duplicate of this Picture
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
equals(/** Picture */ photo)	boolean	Compares this Picture to another to see if they are equal
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Picture / json, /* boolean */ silent)	Picture	Updates parameters for this Picture from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this picture. Used internally by Company#findPictures.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
prettySize(/** number / places, /* number / maxScale, /* number / groupSize, /* string / groupDelimiter, /* string / decimalDelimiter, /* string */ point)	string	Creates a more human readable string representation of the filesize.
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

DashcamDataType enum (string)

The kinds of DashcamDatas supported by the system. Every DashcamData is one of these types.

Values
Value	Description
image	Image
unknown	Unknown or other.
video	Video

IconLayer enum (string)

The kinds of shapes used for places on the map.

Values
Value	Description
fills	SVG layer used for the fill of a Place or the accuracy radius of an Asset. Fleet Freedom automatically sets any element applied here to 25% opacity.
labels	HTML layer for all marker labels.
markers	HTML layer for all marker images.
outlines	SVG layer used for the outline of a Place or the accuracy radius of an Asset.
shadows	HTML layer for shadows from all markers. Fleet Freedom automatically sets any element applied here to 40% opacity.

Geography

geography object

A utility library exposing algorithms for calculations on a sphere.

Usage

var value = trakit.fleetfreedom.geography.member;
/* or */
var result = trakit.fleetfreedom.geography.member(...params);

Values
Property	Type	Default	Description
earthRadius	number	6378137	The radius of the Earth in meters taken from the GRS-80, NAD83, and WGS-84 standards.

Functions
Method	Returns	Description
clampLat(/** number / latitude, /* number */ edge)	number	Normalizes a latitude value between +/- 90. Values of greater than 90 are returned as 90, and values less than -90 are returned as -90.
clampLng(/** number */ longitude)	number	Normalizes a longitude value between +/- 180. Values of greater than 180 are returned as a negative difference of 360, and values less than -180 are returned as a positive difference of 360.
pathDecode(/** string / route, /* number */ precision)	Array.<LatLng>	An implementation of Google's Decoded Polyline Algorithm format. https://developers.google.com/maps/documentation/utilities/polylinealgorithm
pathEncode(/** Array.<LatLng> / route, /* number */ precision)	string	An implementation of Google's Encoded Polyline Algorithm format. https://developers.google.com/maps/documentation/utilities/polylinealgorithm
pathLength(/** Array.<LatLng> / route, /* number */ radius)	number	Calculates the length of the given route.
pathReduce(/** Array.<LatLng> / route, /* number */ tolerance)	Array.<LatLng>	Performs a Douglas-Peucker path reduction based on the given tolerance.
pointAngle(/** number / aLat, /* number / aLng, /* number / bLat, /* number */ bLng)	number	Bearing from coordinate A to coordinate B in degrees from North
pointDistance(/** number / aLat, /* number / aLng, /* number / bLat, /* number / bLng, /* number */ radius)	number	Calculates the distance between two coordinates on a sphere.
pointMiddle(/** number / aLat, /* number / aLng, /* number / bLat, /* number / bLng) Throws Error* "Either latitude or longitude is NaN".	LatLng	Calculates the mid-point between to given coordinate
pointOrthogonal(/** number / aLat, /* number / aLng, /* number / midLat, /* number / midLng, /* number / bLat, /* number / bLng, /* number */ radius)	number	Calculates the orthogonal height of a triangle. The orthogonal height is calculated by drawing a line between the coordinate A and coordinate B, then getting the length of a line drawn up from the line to the mid coordinate at a 90 degree angle.
pointTranslate(/** number / lat, /* number / lng, /* number / meters, /* number / bearing, /* number / radius) Throws Error* "Either latitude or longitude is NaN".	LatLng	Calculates the final coordinate based on the given starting coordinate and vector
pointVincenty(/** number / aLat, /* number / aLng, /* number / bLat, /* number */ bLng)	number	Calculates the distance between two coordinates on a Bessel 1841 ellipsoid.
polyArea(/** Array.<LatLng> / route, /* number / radius) Throws Error* "Not enough coordinates".	number	Calculates the total area occupied by the given geofence.
polyContains(/** Array.<LatLng> / route, /* number / lat, /* number */ lng)	boolean	A utility function to determine if a given coordinate is inside the given geofence.
polyReduce(/** Array.<LatLng> / route, /* number */ tolerance)	Array.<LatLng>	Performs a Douglas-Peucker path reduction on a polygon for the given tolerance. The start/end coordinates are variable and the end coordinate is trimmed from the result.
polyWidest(/** Array.<LatLng> */ route)	Array.<number>	Finds the widest section of the given route. This is useful for path reduction and reorientation.
radialArea(/** number */ radius)	number	Calculates the spherical-cap area occupied by the given radial distance.

mercator object

A utility library for Mercator Projection; converting coordiantes on a an elliptical surface to a flat surface.

Usage

var value = trakit.fleetfreedom.mercator.member;
/* or */
var result = trakit.fleetfreedom.mercator.member(...params);

Values
Property	Type	Default	Description
majorRadius	number	6378137	The radius of the Earth in meters taken from the GRS-80, NAD83, and WGS-84 standards.
minorRadius	number	~6356752.3142	The minor axis radius of an ellipsoid Earth as per WGS-84.

Functions
Method	Returns	Description
latlngToPixel(/** number / lat, /* number / lng, /* number / zoom, /* number */ tileSize)	Point	Converts a LatLng into a pixel coordinate at a specified level of detail.
metresPerPixel(/** number / lat, /* number / zoom, /* number */ tileSize)	number	Returns the number of meters per pixel at the given latitude and zoom level.
pixelToBounds(/** number / pixelX, /* number / pixelY, /* number / zoom, /* number / tileSize, /* number */ grow)	LatLngBounds	Converts pixel coordinates of a tile into a lat/lng boundary.
pixelToLatlng(/** number / pixelX, /* number / pixelY, /* number / zoom, /* number */ tileSize)	LatLng	Converts a pixel coordinate into a LatLng at a specified level of detail.
pixelToTile(/** number / pixelX, /* number / pixelY, /* number */ tileSize)	Point	Converts pixel coordinates into tile coordinates of the tile containing the specified pixel.
tileMapSize(/** number / zoom, /* number */ tileSize)	number	Determines the map width and height (in pixels) at a specified level of detail.
tileToBounds(/** number / tileX, /* number / tileY, /* number / zoom, /* number / tileSize, /* number */ grow)	LatLngBounds	Converts tile coordinates into a lat/lng boundary representing a complete tile.
tileToLatlng(/** number / tileX, /* number / tileY, /* number */ tileSize)	LatLng
tileToPixel(/** number / tileX, /* number / tileY, /* number */ tileSize)	Point	Converts tile coordinates into pixel coordinates of the upper-left pixel of the specified tile.

LatLng class

A simple latitude/longitude pair. All LatLng objects use geography.earthRadius for internal calculations.

Usage

var object = new trakit.fleetfreedom.LatLng(/** number */ lat, /** number */ lng);

Properties
Property	Type	Description
lat	number	Latitude (normalized between -180 and +180)
lng	number	Longitude (normalized between -90 and +90)

Functions
Method	Returns	Description
bearingTo(/** LatLng */ latlng)	number	Bearing from this LatLng to the given position in degrees from North
distanceTo(/** LatLng */ latlng)	number	Returns the distance to the given LatLng in meters
equals(/** LatLng / latlng, /* number */ tolerance)	boolean	Compares this LatLng to another to see if they are equivalent.
toBetween(/** LatLng */ latlng)	LatLng	Returns a new LatLng at the half-way point between this and the given LatLng.
toBounds(/** number */ radius)	LatLngBounds	Creates a square LatLngBounds centred around this LatLng.
toJSON()	Object \| null	Creates a literal of this object. Used internally by JSON.stringify.
toRadians(/** number */ magnifier)	Point	Creates a Point based on the given magnifier
toString(/** string */ delimiter)	string	Creates string representation of this coordinate
toTranslated(/** number / meters, /* number */ bearing)	LatLng	Returns a new LatLng based on the given distance and bearing from the this position

Static Methods
Method	Returns	Description
LatLng.parse(/** string / latlng, /* string */ comma)	LatLng	Creates a LatLng from the given string.

LatLngBounds class

A bounding box of latitudes and longitudes

Usage

var object = new trakit.fleetfreedom.LatLngBounds(/** LatLng | LatLngBounds | Array.<LatLng> | Array.<LatLngBounds>= */ ne, /** LatLng | LatLngBounds | Array.<LatLng> | Array.<LatLngBounds>= */ sw);

Properties
Property	Type	Description
east	number	Eastern edge
north	number	Latitude at the Northern corners; not necessarily the Northern-most value.
south	number	Latitude at the Southern corners; not necessarily the Southern-most value.
west	number	Western edge

Functions
Method	Returns	Description
contains(/** LatLng */ latlng)	boolean	Checks if a LatLng is contained within this boundary.
copy()	LatLngBounds	Creates a duplicate of this LatLngBounds
encloses(/** LatLngBounds */ bounds)	boolean	Checks if a LatLngBounds is contained within this boundary.
equals(/** LatLngBounds */ bounds)	boolean	Compares this LatLngBounds to another to see if they are equal
expand(/** LatLng \| LatLngBounds \| Array.<(LatLng \| LatLngBounds)> */ latlngs)	LatLngBounds	Extends the boundary to envelop the given point(s) but does not automatically validate. This comes in efficient when doing many operations on a single PointBounds
extend(/** LatLng \| LatLngBounds \| Array.<(LatLng \| LatLngBounds)> */ latlngs)	LatLngBounds	Extends the boundary to envelop the given point(s) and automatically validates
getCentre()	LatLng	Returns the centre point of the boundary.
getDiagonalDistance()	number	The distance in meters between the north-east corner and the south-west corner.
getEastMiddle()	LatLng	The mid-point coordinate between the north east and north west corners.
getLatitudinalDistance()	number	The distance in meters between the north-most border and the south-most border.
getLongitudinalDistance()	number	The distance in meters between the east-most and the west-most points along the border closest to the equator.
getNorthEast()	LatLng	The coordinate of the north east corner.
getNorthMiddle()	LatLng	The mid-point coordinate between the north east and north west corners.
getNorthWest()	LatLng	The coordinate of the north west corner.
getSouthEast()	LatLng	The coordinate of the south east corner.
getSouthMiddle()	LatLng	The mid-point coordinate between the south east and south west corners.
getSouthWest()	LatLng	The coordinate of the south west corner.
getWestMiddle()	LatLng	The mid-point coordinate between the south east and south west corners.
isEmpty()	boolean	Checks to see if the bounds are valid, and that the corners are different coordinates.
isValid()	boolean	Checks to see if the bounds are valid (not inside-out and lat/lngs are normalized).
overlaps(/** LatLngBounds */ other)	boolean	Checks if a LatLngBounds overlaps this boundary. Also returns true if either boundary's LatLngBounds#encloses returns true.
toJSON()	Object \| null	Creates a literal of this object. Used internally by JSON.stringify.
toString(/** string */ delimiter)	string	Creates string representation of this coordinate
validate()	LatLngBounds	Validates the boundary by ensuring the top value is less than the bottom value, and the left value is less than the right value. Also adjusts the width and height values

Position class

Inheritance: LatLng > Position

GPS Position details

Usage

var object = new trakit.fleetfreedom.Position(/** number */ lat, /** number */ lng, /** number */ speed, /** number */ bearing, /** number */ accuracy, /** string | Date */ dts, /** string */ address, /** number */ limit, /** number */ altitude, /** StreetAddress */ street);

Properties
Property	Type	Description
accuracy	number	Estimated accuracy for this GPS fix
address	string	Approximate street address
altitude	number	Altitude (in meters above sea level)
bearing	number	Bearing (in degrees from north)
date	Date	Data/time of this GPS fix
lat	number	Latitude (normalized between -180 and +180)
lng	number	Longitude (normalized between -90 and +90)
radius	number	Equatorial radius of the planet; value is geography.earthRadius
speed	number	Speed (in Km/h)
speedLimit	number	Speed limit in Km/h
street	StreetAddress	A reverse-geocoded breakdown of all geographic information available at the lat/long coordinates.

Functions
Method	Returns	Description
bearingTo(/** LatLng */ latlng)	number	Bearing from this LatLng to the given position in degrees from North
distanceTo(/** LatLng */ latlng)	number	Returns the distance to the given LatLng in meters
equals(/** Position */ position)	boolean	Compares this Position to another to see if they are equal
predictNext(/** number */ seconds)	LatLng	Predicts a new Position based on current location and speed added by the given seconds
toBetween(/** LatLng */ latlng)	LatLng	Returns a new LatLng at the half-way point between this and the given LatLng.
toBounds()	LatLngBounds	Creates a square LatLngBounds centred around this LatLng.
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
toLatLng()	LatLng	Returns a new LatLng using this position's coordinates.
toRadians(/** number */ magnifier)	Point	Creates a Point based on the given magnifier
toString()	string	Creates JSON-string representation of this coordinate
toTranslated(/** number / meters, /* number */ bearing)	LatLng	Returns a new LatLng based on the given distance and bearing from the this position

StreetAddress class

Represents all the pieces of a reverse-geocoded address.

Usage

var object = new trakit.fleetfreedom.StreetAddress(/** string */ number, /** string */ street, /** string */ city, /** string */ region, /** string */ province, /** string */ country, /** string */ postal, /** boolean */ toll);

Properties
Property	Type	Description
city	string	City name
country	string	Country code
number	string	House number
postal	string	Postal or zip code
province	string	Province or state code
region	string	Region name
street	string	Full street name
toll	boolean	Indicates that there is a toll for the current road segment

Functions
Method	Returns	Description
toString()	string	Creates string representation of this address.

Static Methods
Method	Returns	Description
StreetAddress.parse(/** trakit.json.StreetAddress */ json)	StreetAddress	Creates a StreetAddress out of a trakit.json.StreetAddress.

Hours of Service

HosCarrier class

Inheritance: MVCObject > HosCarrier

An operator registered to transport goods or people.

Usage

var object = new trakit.fleetfreedom.HosCarrier(/** Company */ company, /** trakit.json.HosCarrier */ object);

Properties
Property	Type	Description
address	StreetAddress	The carrier's physical or incorporated address.
codes	Dictionary.<string, string>	Identity codes supplied by a regulatory/government body such as DOT ID.
company	Company	The Company to which this asset belongs.
contact	Contact	Main contact information
contactId	number	The Contact#id of the carrier's main contact information.
id	number	Unique identifier
logo	Picture	Carrier logo (appears on trip inspection logs)
logoId	number	The Picture#id of the carrier's logo.
name	string	Carrier's distinct name (may be different from Company#name)
notes	string	Notes.
shiftCycle	HosCycle	Default shift cycle used by the drivers.
timezone	string	The local timezone of the carrier's address.
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.HosCarrier / json, /* boolean */ silent)	HosCarrier	Updates parameters for this HosCarrier from the given JSON literal
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

HosEvent class

Inheritance: MVCObject > HosEvent

This event represents the daily log for the driver.

Usage

var object = new trakit.fleetfreedom.HosEvent(/** Company */ company, /** trakit.json.HosEvent */ object);

Properties
Property	Type	Description
address	StreetAddress	Geolocation/Written address by driver of where the event took place
carrier	HosCarrier	The carrier information to which this event belongs.
carrierId	number	Unique identifier of the carrier information
certificationDate	Date	Date of the records being certified or re-certified by the driver
code	HosEventCode	This code is used in conjunction with the type to determine the specific event
company	Company	The Company to which this asset belongs.
diagnosticCode	HosDiagnosticCode	Data Diagnostic Event Code
diagnosticStatus	boolean	Data Diagnostic Event Indicator Status
distanceSinceGPSFix	string	Distance since last valid coordinates. An integer value between 0 and 6
dts	Date	When the event took place
engineHours	number	Engine hours of the tractor at the time of the event
id	number	Unique Identifier
isCoDriver	boolean	Driver status - Primary/Co-driver
latitude	string	Single character 'X', single character 'M', single character 'E', or 2-decimal point precision value between -90.00 and 90.00
longitude	string	Single character 'X', single character 'M', single character 'E', or 2-decimal point precision value between -179.99 and 180.00
malfunctionCode	HosMalfunctionCode	Malfunction Indicator Code
malfunctionStatus	boolean	Malfunction Indicator Status
notes	string	Comments/Annotations entered by the driver/user
odometer	number	Odometer reading of the tractor at the time of the event
origin	HosEventOrigin	Event Record origin
person	Person	Driver associated with this event
personId	number	Unique identifier of the driver
seqNo	string	Event Sequence Id Number
shiftCycle	HosCycle	Driver's shift cycle
status	HosEventStatus	Event Record status
type	HosEventType	Event type used to determine the record type
vehicle	number	Vehicle associated with this event
vehicleId	Vehicle	Unique identifier of the vehicle
version	Array.<number>	The version flags used to ensure sync operations are done in order.
violationStatus	boolean	Violation Status
violationType	HosViolationType	Type of violation

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.HosEvent / json, /* boolean */ silent)	HosEvent	Updates parameters for this HosEvent from the given JSON literal
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

HosInspection class

Inheritance: MVCObject > HosInspection

A pre- or post-Trip inspection report.

Usage

var object = new trakit.fleetfreedom.HosInspection(/** Company */ company, /** trakit.json.HosInspection */ object);

Properties
Property	Type	Description
address	StreetAddress	Street address where the inspection took place
carrier	HosCarrier	The carrier information to which this inspection report belongs.
carrierId	number	Unique identifier of the carrier information
company	Company	The Company which logged this inspection report.
defects	Array.<HosInspectionDefect>	List of all defects
id	number	Unique identifier
inspectedOn	Date	Timestamp from when the inspection took place.
latlng	LatLng	Coordinates where the inspection took place
odometer	number	Recorded odometer at time of inspection
person	Person	Driver who conducted the inspection
personId	number	Unique identifier of the driver
status	HosDefectStatus	Status of all defects
technician	string	Name of the (optional) mechanic/technician who performed repairs or inspection.
techSigned	Date	Timestamp from when a mechanic/technician (optionally) signed off on the inspection.
trailers	Array.<Trailer>	Between 0 and 2 trailers being inspected
vehicle	Vehicle	Tractor being inspected
vehicleId	Vehicle	Unique identifier of the vehicle
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.HosInspection / json, /* boolean */ silent)	HosInspection	Updates parameters for this HosInspection from the given JSON literal
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

HosInspectionDefect class

Details of a defect found during a trip inspection

Usage

var object = new trakit.fleetfreedom.HosInspectionDefect(/** HosDefectArea */ area, /** string */ category, /** string */ description, /** Array.<string> */ major, /** Array.<string> */ minor);

Properties
Property	Type	Description
area	HosDefectArea	Shows where a defect was located on the rig.
category	string	The kind of defect
description	string	A text description of the defect.
major	Array.<string>	A list of major flaws as noted for Canadian standards
minor	Array.<string>	A list of minor flaws as noted for Canadian standards

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

HosCycle enum (string)

Driving cycle behaviour.

Values
Value	Description
canada120h14d	Canada South 120 hour / 14 day (Cycle 2)
canada120h14dN	Canada North 120 hour / 14 day (Cycle 2)
canada70h7d	Canada South 70 hour / 7 day (Cycle 1)
canada80h7d	Canada North 80 hour / 7 days (Cycle 1)
canadaOilGas	Canada Oil and Gas
usa60h7d	USA Federal 60 hour / 7 days
usa60h7d_p	USA Federal 60 hour / 7 days (passenger)
usa70h8d	USA Federal 70 hour / 8 days
usa70h8d_p	USA Federal 70 hour / 8 days (passenger)
usaAlaska70h7d	USA Alaska 70 hour / 7 days
usaAlaska70h7d_p	USA Alaska 70 hour / 7 days (passenger)
usaAlaska80h8d	USA Alaska 80 hour / 8 days
usaAlaska80h8d_p	USA Alaska 80 hour / 8 days (passenger)
usaCalifornia112h8d	USA California 112 hours / 8 days (farm products)
usaCalifornia112h8d_p	USA California 112 hours / 8 days (passenger)
usaCalifornia80h8d	USA California 80 hour / 8 days
usaCalifornia80h8d_p	USA California 80 hour / 8 days (passenger)
usaTexas70h7d	USA Texas 70 hour / 7 day

HosDataTransferType enum (string)

Method of transferring E-Logs to the authorities

Values
Value	Description
canadaEmail	MTO via Email
usaEmail	FMCSA via Email
usaWebservice	FMCSA via Webservice portal

HosDefectArea enum (string)

Shows where a defect was located on the rig.

Values
Value	Description
tractor	Defect on the vehicle.
trailer	Defect on one of the trailers.

HosDefectStatus enum (string)

Resolution status for trip inspection defects

Values
Value	Description
corrected	Issue fixed or resolved
harmless	Issue does not affect operation
satisfactory	No correction required

HosDeferredHoursStatus enum (string)

Deferred hours status for events while running Canadian cycles.

Values
Value	Description
day1	Hours deferred from Day 1.
day2	Hours deferred from Day 2.
none	Hours have not been defefred.

HosDiagnosticCode enum (string)

Data diagnostic events

Values
Value	Description
dataTransfer	Data transfer data diagnostic event
engine	Engine synchronization data diagnostic event
missingData	Missing required data elements data diagnostic event
other	Other ELD identified diagnostic event
power	Power data diagnostic event
unidentified	Unidentified driving records data diagnostic event

HosEventCode enum (string)

Specifies the nature of the change indicated but the HosEventType.

Values
Value	Description
diagnosticCleared	Diagnostic: An data diagnostic event cleared.
diagnosticLogged	Diagnostic: A data diagnostic event logged.
driving	Duty Status: Driver's duty status changed to "Driving".
intermediateConventional	Intermediate: log with conventional location precision.
intermediateReduced	Intermediate: log with reduced location precision.
login	Login: Authenticated driver's ELD login activity.
logout	Login: Authenticated driver's ELD logout activity.
malfunctionCleared	Diagnostic: An ELD malfunction cleared.
malfunctionLogged	Engine Power: An ELD malfunction logged.
none	Other: Driver indication for PC, YM and WT cleared.
offDuty	Duty Status: Driver's duty status changed to "Off-duty".
onDuty	Duty Status: Driver's duty status changed to "On-duty not driving".
personalConveyance	Other: Driver indicates "Authorized Personal use of CMV".
powerupConventional	Engine Power: Engine power-up with conventional location precision.
powerupReduced	Engine Power: Engine power-up with reduced location precision.
shutdownConventional	Engine Power: Engine shut-down with conventional location precision.
shutdownReduced	Engine Power: Engine shut-down with reduced location precision.
sleeperBerth	Duty Status: Driver's duty status changed to "Sleeper Berth".
waiting	Duty Status: Waiting status is an Off-duty for some cases in Oil and Gas cycle.
yardMoves	Other: Driver indicates "Yard moves".

HosEventOrigin enum (string)

Event record origin

Values
Value	Description
automatic	Automatically recorded by ELD
driver	Entered or edited by driver
unidentified	Assumed from unidentified driver profile
user	Edit requested by an authenticated user other than driver

HosEventStatus enum (string)

Event record status

Values
Value	Description
active	Active
inactiveChanged	Inactive - changed
inactiveChangeRejected	Inactive - change rejected
inactiveChangeRequested	Inactive - change requested

HosEventType enum (string)

Event record type

Values
Value	Description
certification	A driver's certification/re-certification of records
cycleChanged	Canadian cycle changed.
deferredHours	Canadian cycle off-duty hours deferred.
diagnostic	A malfunction or data diagnostic detection occurence
dutyStatus	A change in driver's duty-status
enginePower	CMV's engine power up/shutdown activity
extraHours	Canadian cycle additional hours not recorded.
intermediate	An intermediate log
login	A driver's login/logout activity
other	A change in driver's indication of authorized personal use of CMV or yard moves
unknown	Unknown
zoneChanged	Canadian cycle operating zone changed.

HosMalfunctionCode enum (string)

Data diagnostic events

Values
Value	Description
dataRecording	Data recording compliance malfunction
dataTransfer	Data transfer compliance malfunction
engine	Engine synchronization compliance malfunction
other	Other ELD detected malfunction
position	Positioning compliance malfunction
power	Power compliance malfunction
timing	Timing compliance malfunction

HosViolationType enum (string)

Types of violation

Values
Value	Description
break_24	24 Hour Break Required
break_30	30 Minute Break Required
consecutive_off_8	Daily 8 Consecutive Hours Off Duty Required
cycle_120	120 Hour Cycle Limit
cycle_60	60 Hour Cycle Limit
cycle_70	70 Hour Cycle Limit
cycle_switching_36	36 Hours Break Required for Cycle Switching
cycle_switching_72	72 Hours Break Required for Cycle Switching
daily_break_10	Daily 10 Hour Off-Duty Required
daily_break_8	Daily 8 Hour Off-Duty Required
daily_driving_13	Daily 13 Hour Driving Limit
daily_duty_14	Daily 14 Hour On-Duty Limit
deferred_break_10	10 Consecutive Hours Off Duty Required on Day 2
deferred_break_12	Off Duty Time Insufficient on Day 2
driving_10	10 Hour Driving Limit
driving_11	11 Hour Driving Limit
driving_13	13 Hour Driving Limit
duty_14	14 Hour Shift Limit
duty_15	15 Hour On-Duty Limit
duty_16	16 Hour Shift Limit
none	No violation
oil_break_24	3 periods of 24 Hour Break Required

JSON WebSocket

socket object

This WebSocket synchronizes objects between the browser and server side

Usage

var value = trakit.fleetfreedom.socket.member;
/* or */
var result = trakit.fleetfreedom.socket.member(...params);

Properties
Property	Type	Description
lastRequest	Date	A date/time stamp from the last moment a command was sent from the client.
lastResponse	Date	A date/time stamp from the last moment a message was received by the client.
policies	Object	Object with two keys for the current User's Company's policy information.
policies.passwords	CompanyPasswords	The CompanyPasswords informs you on password requirements for changing passwords.
policies.sessions	CompanySessions	The CompanySessions provides behaviour information for maintaining a session.
session	Session	A JSON equivalent Session for the current connection.
state	SocketState	The WebScoket's current connection state.

Functions
Method	Returns	Description
close()	boolean	Closes the WebSocket connection.
dispose()		Closes the WebSocket connection, unbinds all event handlers, and prepares the object for the garbage collector.
open(/** string / url, /* string / ghostId, /* boolean */ keepAlive)	boolean	Opens a WebSocket connection to the Fleet Freedom service.
send(/** string / command, /* SocketRequest / object, /* function / callback, /* number */ timeout)	number	Sends a command an parameters object.
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
mapper(/** Object */ obj)
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

SocketRequest class

Treat the socket request object like a literal, but make sure to include the "reqId" property. The WebSocket will respond to each request with the reqId it was given so you can correlate responses.

Usage

var object = new trakit.fleetfreedom.SocketRequest(/** number */ reqId);

Properties
Property	Type	Description
reqId	number

SocketResponse class

Treat the socket response object like a literal. It will always have the reqId, errorCode, and message properties, but can also contain any number of other properties.

Usage

var object = new trakit.fleetfreedom.SocketResponse(/** number */ errorCode, /** string */ message, /** number */ reqId);

Properties
Property	Type	Description
errorCode	number
message	string
reqId	number

SocketState enum (string)

Defines socket connection states.

Values
Value	Description
closed	The connection is closed. This is the initial state.
closing	The underlying TCP connection may still be open, but the server is no longer accepting commands.
open	The connection to the server is open and ready.
opening	The underlying TCP connection is open, but the server has not yet identified that it is ready.
unknown	Your guess is as good as mine. It should never be this.

Maintenance

MaintenanceInterval class

Inheritance: MVCObject > MaintenanceInterval

The details of an Asset's usage used to calculate the next Maintenance Job for the given schedule.

Usage

var object = new trakit.fleetfreedom.MaintenanceInterval(/** MaintenanceSchedule */ schedule, /** number */ assetId, /** Date */ date, /** number */ odometer, /** number */ engineHours, /** number */ lastJobId);

Properties
Property	Type	Description
asset	Asset	The Vehicle or Trailer being used for this schedule
assetId	number	Unique identifier of the asset being used for this schedule
date	Date	Initial date to use for the schedule's Date Recurrence pattern
engineHours	number	Initial engine hours value (in decimal hours) for the schedule's Engine Hours Recurrence pattern
lastJob	number	The most recent completed job for the asset using the schedule.
lastJobId	number	Unique identifier of the last completed job for the asset.
odometer	number	Initial odometer value (in Km) for the schedule's Odometer Recurrence pattern
schedule	MaintenanceSchedule	The Maintenance Schedule to which this recurrence definition refers

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
predict()	Date	Tries to predict the next lapse for this interval.
predictByDate()	Date	Tries to predict the next lapse for this interval based on the date.
predictByEngineHours()	Date	Tries to predict the next lapse for this interval by averaging the engine hours.
predictByOdometer()	Date	Tries to predict the next lapse for this interval by averaging the odometer.
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

MaintenanceJob class

Inheritance: MVCObject > MaintenanceJob

A log of maintenance to perform on an Asset

Usage

var object = new trakit.fleetfreedom.MaintenanceJob(/** Company */ company, /** trakit.json.MaintenanceJob */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which this Job relates.
assetId	number	The Asset#id to which this Job relates.
company	Company	The Company to which the Job's Asset relates.
completed	Date	Time-stamp from the Job's status change (or creation).
cost	number	Estimated cost for these jobs.
created	Date	The time-stamp from this Job's creation.
duration	TimeSpan	The amount of time spent performing the work.
engineHours	number	The recorded engine hours reading from the vehicle at the time of doing the work.
garage	string	The Service Centre used for these jobs.
id	number	Unique identifier
name	string	Repair or service task.
notes	string	Instructions for these jobs.
odometer	number	The recorded odometer reading from the vehicle at the time of doing the work.
pictures	Array.<Picture>	Images taken while performing the work.
reference	string	Reference code used to track these jobs.
schedule	MaintenanceSchedule	MaintenanceSchedule to which this Job relates.
scheduleId	number	MaintenanceSchedule#id to which this Job relates.
status	MaintenanceJobStatus	The progress on the service work.
technician	string	The mechanic who performed the work.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.MaintenanceJob / json, /* boolean */ silent)	MaintenanceJob	Updates parameters for this MaintenanceJob from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this job. Used internally by Company#findMaintenanceJobs.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

MaintenanceSchedule class

Inheritance: MVCObject > MaintenanceSchedule

A schedule for recurring MaintenanceJobs

Usage

var object = new trakit.fleetfreedom.MaintenanceSchedule(/** Company */ company, /** trakit.json.MaintenanceSchedule */ object);

Properties
Property	Type	Description
company	Company	The Company to which this MaintenanceSchedule relates
cost	number	Estimated cost for these jobs
duration	TimeSpan	Estimated amount of time to complete the work.
fill	string	Hex colour value for fills and backgrounds.
garage	string	The Service Centre used for these jobs
graphic	string	Short string with an icon-code for display purposes.
id	number	Unique identifier
intervals	Dictionary.<number, MaintenanceInterval>	The per-asset details calculated by the system to help predict the creation of Maintenance Jobs.
name	string	Repair or service task
notes	string	Instructions for these jobs
notify	Array.<string>	A list of User#logins who are notified when the schedule predicts a job will need to be completed soon, and/or when it has elapsed.
predictionDays	number	The number of days in advance to predict a job will become pending.
recurDays	number	The maximum number of days between service stops
recurDistance	number	The minimum distance (in Km) between service stops
recurEngineHours	number	The minimum running engine hours (in decimal hours) between service stops
reference	string	Reference code used to track these jobs
stroke	string	Hex colour value for text and outlines.
targets	string	Targeting expression for selecting Vehicle and Trailer type assets.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.MaintenanceSchedule / json, /* boolean */ silent)	MaintenanceSchedule	Updates parameters for this MaintenanceSchedule from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this schedule. Used internally by Company#findMaintenanceSchedules.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

MaintenanceJobStatus enum (string)

The status of a pending or historical maintenance job

Values
Value	Description
cancelled	The work was not done, and the job has been cancelled.
completed	The work was done.
pastdue	The job needs to be done as soon as possible.
pending	The job has to be done within the next two weeks.

Messaging

Message class

Inheritance: MVCObject > Message

An SMS or Email Message

Usage

var object = new trakit.fleetfreedom.Message(/** Company */ company, /** trakit.json.AssetMessage */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which this message relates.
assetId	number	The identifier of the Asset to which this message belongs.
body	string	Message text
delivered	Date	When the message was received or sent by the system.
folder	string	Can be "Inbox" and "Archive"
from	string	Sender's address; either email or phone number
id	number	Unique identifier of the message.
incoming	boolean	True when message was received by Fleet Freedom, and False when sent by Fleet Freedom.
kind	string	MessageTypes used are SMS and Email.
processed	Date	When the message was processed by the system.
readBy	string	The User who read this message. Blank if unread.
status	MessageStatus	Shows message processing status.
subject	string	Email subject. For SMS messages, this is left blank.
to	string	Recipient's address; either email or phone number
user	User	The User who sent or received the message.
userLogin	string	The User#login who sent or received the message.
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.AssetMessage / json, /* boolean */ silent)	Message	Updates parameters for this Message from the given JSON literal
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

MessageStatus enum (string)

Messages have a lifetime and each status represents a memos's progress through it's life.

Values
Value	Description
acknowledged	Sent and has been responded to or acknowledged by the recipient.
bounceback	Sent but returned with error (applies to MessageType#email).
created	Created, but not yet sent to the recipient.
failed	Failed to send.
processed	Sent or received without error.
throttled	Failed to send because too many messages sent to the specified recipient.

MessageType enum (string)

The types of messages supported by Fleet Freedom.

Values
Value	Description
apn	iOS App Message
email	By email
gcm	Android App Message
pnd	Personal Navigation Device (Garmin/Magellan/etc)
sms	By phone
socket	WebSocket alert message
unknown	If the type of memo has not yet been determined, or there was an error determining its type.

Model-View-Control

MVCEvent class

An event object used by classes instead of DOM objects

Usage

var object = /** MVCObject */ mvcobjectInstance.fire(/** string */ type, /** ? */ detail);

Properties
Property	Type	Description
detail	?	An optional value or object used for custom extensions (read-only)
fired	boolean	Indicates whether this event was fired or not
stopped	boolean	Indicates whether this event is being stopped
target	MVCObject	The object from which this event is fired (read-only)
type	string	The event type name (read-only)

Functions
Method	Returns	Description
stop()	boolean	Stops/prevents default action for this event

MVCObject class

A class with which pseudo-MVC functionality is replicated

Usage

var object = new trakit.fleetfreedom.MVCObject();

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

Places (POIs / geofences)

Place class

Inheritance: MVCObject > Place

A Place is a POI, a geofence, a region, or some other geographic area of interest.

Usage

var object = new trakit.fleetfreedom.Place(/** Company */ company, /** trakit.json.PlaceGeneral */ object);
/* or */
var object = /** Company */ companyInstance.createPlace(/** trakit.json.PlaceGeneral */ json);

Properties
Property	Type	Description
address	string	The full street address.
anchor	LatLng	The centre coordinate.
colour	string	Hex colour for this place's area
company	Company	The Company to which this asset belongs.
detail	string	Alias for {@Place#address}.
icon	Icon	The icon used to mark the centre coordinate.
iconId	number	The unique identifier of the Icon for this place.
id	number	Unique identifier.
kind	PlaceShapeType	The type of shape to draw around the centre coordinate.
labels	Array.<string>	Codified labels. See utility#codify.
name	string	Friendly searchable name.
notes	string	Any area specific notes
pictureIds	Array.<number>	Picture#ids taken for this location.
pictures	Array.<Picture>	Pictures taken for this location.
radius	number	When drawing a PlaceShapeType#radial, this specifies how large the circle must be in meters.
reference	string	Customizable field used to refer this place an external system.
shape	Array.<LatLng>	When drawing a PlaceShapeType#polygon or PlaceShapeType#rectangle, the coordinates given represent the outlined shape.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.PlaceGeneral / json, /* boolean */ silent)	Place	Updates parameters for this Place from the given JSON literal
getAssets(/** Array.<AssetPlaceStatusType> */ statuses)	Array.<Asset>	Gets a list of Assets which are interacting with this place.
getBounds()	LatLngBounds	Returns a valid LatLngBounds that contains the shape of this place.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this place. Used internally by Company#findPlaces.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

PlaceShapeType enum (string)

The kinds of shapes used for places on the map.

Values
Value	Description
point	A LatLng only. These types of places do not interact with Assets.
polygon	A non-self-intersecting polygon of more than 2 unique LatLng coordinates. When an Asset is contained, it will interact with the Place.
radial	A LatLng with a radius. When an Asset is within the radius, it will interact with the Place.
rectangle	A LatLngBounds, not a true "rectangle". When an Asset is contained, it will interact with the Place.

Reports

reports object

Utility object for referencing static content.

Usage

var value = trakit.fleetfreedom.reports.member;
/* or */
var result = trakit.fleetfreedom.reports.member(...params);

Values
Property	Type	Default	Description
types	Array.<ReportType>	undefined	Array of supported ReportTypes

ReportNotifications class

A group of users and targeted assets which also receive report notifications

Usage

var object = new trakit.fleetfreedom.ReportNotifications(/** Array.<string> */ users, /** string */ assets);

Properties
Property	Type	Description
assets	string	Targeting expressions for sending report results to targeted assets (only about themselves).
users	Array.<string>	List of users from the target company who will receive report results (via email only) for scheduled reports.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportOptions class

The options and settings used by the report runner to create results.

Usage

var object = new trakit.fleetfreedom.ReportOptions(/** string */ targets, /** Array.<ReportParameter> */ parameters, /** ReportFilterMode */ filtering, /** string */ places, /** Array.<string> */ regions, /** ReportScorecardRules */ scorecardRules);

Properties
Property	Type	Description
filtering	ReportFilterMode	The method by which results will be filtered
parameters	Array.<ReportParameter>	Configured values used to execute the results.
places	string	The SearchPattern used to filter results based on Places.
regions	Array.<string>	Configured values used to execute the results.
scorecardRules	ReportScorecardRules	Rules used to generate scorecard for this report.
targets	string	The SearchPattern used to target the results.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportParameter class

Usage

var object = new trakit.fleetfreedom.ReportParameter(/** ReportParameterType */ type, /** string */ value);

Properties
Property	Type	Description
type	ReportParameterType	The kind of parameter.
value	string	The value given to the report processor.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportRecurrence class

A recurring Report and schedule

Usage

var object = new trakit.fleetfreedom.ReportRecurrence(/** trakit.json.ReportRecurrence */ object);

Properties
Property	Type	Description
end	Date	Local date/time on which the recurring pattern ends (not UTC).
iterations	number	The number of times this schedule has been invoked to generate results.
kind	ReportRecurrenceType	Pattern used to re-create ReportResults.
lastEndDate	Date	Last start date/time range of the schedule.
lastResult	number	Unique identifier of the most recent ReportResult for this schedule's template.
lastStartDate	Date	Last start date/time range of the schedule.
nextEndDate	Date	Ending date/time range predicted for the next occurrence.
nextStartDate	Date	Starting date/time range predicted for the next occurrence.
start	Date	Local date/time from which the recurring pattern begins (not UTC).
timezone	string	The local timezone used to calculate recurring date/time ranges.
weekday	number	A number between 0 and 6 representing the day of the week starting with Sunday.
weekdays	Array.<boolean>	Seven (7) booleans which denote the applicable days of the week starting with Sunday.

Functions
Method	Returns	Description
calculateNextRange()	Array.<Date>	Calculates the next recurring date range for the schedule. Returns an array of zero or two Dates. If the schedule will not allow the template to run again, the array is empty. Otherwise, the first element is the next starting date, and the second element is the ending date.
fromJSON(/** trakit.json.ReportRecurrence */ json)	ReportRecurrence	Updates parameters for this ReportRecurrence from the given JSON literal
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportResult class

Inheritance: MVCObject > ReportResult

The results of a canned report. The full summary and breakdown can be accessed through the Reports API.

Usage

var object = new trakit.fleetfreedom.ReportResult(/** Company */ company, /** trakit.json.ReportResult */ object);

Properties
Property	Type	Description
archive	boolean	A flag to show whether the ReportResult has been archived.
bounds	LatLngBounds	The boundary containing the results of this report.
company	Company	The Company to which this object belongs
completed	Date	The date/time when the results were done processing.
created	Date	When the results were originally requested from the report processor.
error	string	A message to describe why the report failed.
filtered	Array.<Place>	Collection of Places that were used for filtering the results.
filterIds	Array.<number>	A list of Place#ids that were used for filtering the results.
id	number	Unique identifier
name	string	Saved name of the results
notes	string	Saved notes for the results, and possibly the appended error message if the ReportResult#status is ReportStatus.failed
options	ReportOptions	The list of options and parameters for processing.
progress	number	The progress in running and saving the results.
runBy	string	The User who originally created these results.
schedule	ReportSchedule	If created on a nightly schedule, this will be the ReportSchedule that created the report result.
scheduleId	number	The ReportSchedule#id used to create this report result.
scorecards	Array.<ReportScorecard>	Scorecards for all the targeted assets based on the scorecard rules.
status	ReportStatus	Processing status. See ReportStatus for details.
targeted	Array.<Asset>	Collection of targeted Assets that were used to calculate the results.
targetIds	Array.<number>	A list of Asset#ids that were used to calculate the results.
template	ReportTemplate	An optional template to fill in any missing options.
templateId	number	The ReportTemplate#id used to create this report result.
timezone	string	The assumed timezone under which the dates are calculated.
totals	Array.<ReportTotal>	A summed list of totals for the results.
type	ReportType	The kind of logic used to process the results.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.ReportResult / json, /* boolean */ silent)	ReportResult	Updates parameters for this ReportResult from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this report. Used internally by Company#findReportResults.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ReportSchedule class

Determines when and how often a report schedule runs automatically.

Usage

var object = new trakit.fleetfreedom.ReportSchedule(/** Company */ company, /** trakit.json.ReportSchedule */ object);

Properties
Property	Type	Description
company	Company	The Company to which this object belongs
id	number	Unique identifier
name	string	Saved name of the schedule
notes	string	Saved notes for the schedule
notify	ReportNotifications	A group of users and targeted assets which also receive report notifications
options	ReportOptions	The list of options and parameters for processing
schedule	ReportRecurrence	A pattern for automatically re-running the report template
template	ReportTemplate	The report template for which this schedule runs
templateId	number	ID of the report template for which this schedule runs
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
fromJSON(/** trakit.json.ReportSchedule / json, /* boolean */ silent)	ReportSchedule	Updates parameters for this ReportSchedule from the given JSON literal
getNotifyAssets()	Array.<Asset>	Returns a list of assets who will receive notification of new report results (for themselves only) from this schedule.
getNotifyUsers()	Array.<User>	Returns a list of users who will receive notification of new report results from this schedule.
getOwner()	User	Returns the User who owns this schedule. When results are generated, this user's permissions and settings are used.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this schedule. Used internally by Company#findReportSchedules.
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportScorecard class

Infraction parameter used to generate scorecard.

Usage

var object = new trakit.fleetfreedom.ReportScorecard(/** Object */ json);

Properties
Property	Type	Description
condition	string	Type of exception, example speeding, idling, etc...
duration	TimeSpan	Threshold per instance. If the threshold is 0, each instance is used in the calculation.
points	number	Points applied against the base score per instance.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportScorecardParameter class

Infraction parameter used to generate scorecard.

Usage

var object = new trakit.fleetfreedom.ReportScorecardParameter(/** string */ condition, /** string | number | TimeSpan */ duration, /** number */ points);

Properties
Property	Type	Description
condition	string	Type of exception, example speeding, idling, etc...
duration	TimeSpan	Threshold per instance. If the threshold is 0, each instance is used in the calculation.
points	number	Points applied against the base score per instance.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportScorecardRules class

Rules used for generating a scorecard.

Usage

var object = new trakit.fleetfreedom.ReportScorecardRules(/** number */ baseScore, /** Array.<ReportScorecardParameter> */ parameters);

Properties
Property	Type	Description
baseScore	number	Base score for the scorecard.
parameters	Array.<ReportScorecardParameter>	Infraction parameters used to generate the final score.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportTemplate class

Inheritance: MVCObject > ReportTemplate

A Report with all the necessary parameters pre-configured in a ReportType

Usage

var object = new trakit.fleetfreedom.ReportTemplate(/** Company */ company, /** trakit.json.ReportTemplate */ object);

Properties
Property	Type	Description
company	Company	The Company to which this object belongs
fill	string	The colour filling the background of the display icon.
graphic	string	The name of the icon used for display purposes.
id	number	Unique identifier
name	string	Saved name of the template
notes	string	Saved notes for the template
options	ReportOptions	The list of options and parameters for processing.
stroke	string	The colour of the outline for the display icon.
type	ReportType	The kind of logic used to process the results.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.ReportTemplate / json, /* boolean */ silent)	ReportTemplate	Updates parameters for this ReportTemplate from the given JSON literal
getReportResults()	Array.<ReportResult>	Retrieves the ReportResults using this template.
getReportSchedules()	Array.<ReportSchedule>	Retrieves the ReportSchedules for this template.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this template. Used internally by Company#findReportTemplates.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

ReportTotal class

Totalled information from all the results of the report.

Usage

var object = new trakit.fleetfreedom.ReportTotal(/** ReportResult */ result, /** trakit.json.ReportTotal */ json);

Properties
Property	Type	Description
asset	Asset	The Asset to which this total refers.
assetId	number	Asset's Unique identifier
distance	number	The total distance travelled of all summary instances.
duration	TimeSpan	The total duration of all summary instances.
result	ReportResult	The ReportResult to which this total belongs.
stateDetail	string	Unique code given to the report total.
summaryCount	number	The number of summary instances included in this total.
value	number	The total value of all summary instances.
valueType	string	The type of totalled value.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

ReportType class

A definition for the type of report logic used.

Usage

var object = /** ReportTemplate */ reporttemplateInstance.type();

Properties
Property	Type	Description
id	string	Constant identifier. One of the ReportType values.
name	string	Name of this logic type.
notes	string	Notes about this type of report logic.
optional	Array.<ReportParameterType>	Optionally available parameters when creating results.
parameters	Array.<ReportParameterType>	List of mandatory and optional parameters available.
required	Array.<ReportParameterType>	Mandatory parameters when creating results.
template	Array.<ReportParameterType>	Parameters available for creating a ReportTemplate.

ReportFilterMode enum (string)

Drill-down mechanism for highlighting only those places and regions desired in ReportResults.

Values
Value	Description
exclusive	Exclude all results except those whose filters match.
inclusive	Include any results for those whose filters match.
none	Filtering is not enabled for the report.

ReportParameterType enum (string)

The kinds of parameters used for a given report.

Values
Value	Description
attributes	A list of attribute names an Asset must have to be included in the results. Should be a comma separated string of codified tag names.
collate	A choice in the method used to calculate a Summary Instance's values. For an attribute report, the possible values are "instance" where if the attribute is present it is included, and "value" where each attribute's simple value becomes it's own summary instance. For a Tag Summary report, the possible values are "inclusive" where any of the given tags must match, and "exclusive" where all the given tags must match.
distance	A number of seconds representing the minimum distance travelled in a Summary Instance before it is included in the results.
duration	A number of seconds representing the minimum amount of time for a Summary Instance before it is included in the results.
endDate	Ending date/time for the historical data range. The date should be a valid ISO-8601 string.
prolonged	A number of meters representing the maximum amount of time in a Summary Instance before it is split into two and the latter marked as an exception in the results.
rubicon	A number of meters representing the maximum distance travelled in a Summary Instance before it is split into two and the latter marked as an exception in the results.
startDate	Starting date/time for the historical data range. The date should be a valid ISO-8601 string.
tags	The list of tags an Asset must have to be included in the results. Should be a comma separated string of codified tag names.
timeOfDay	Time-span processed on each day. Only data within the time-span is included in the results. The times should be 2 space separated duration strings; see utility#parseTime for an example.

ReportRecurrenceType enum (string)

The pattern used to re-run this report on a schedule.

Values
Value	Description
annually	Yearly based on the ReportRecurrence#start.
daily	Runs once a day at midnight in the local timezone for the previous day.
monthly	Runs once per month in the local timezone for the previous month.
once	Run only once. This type is used for large reports which need to run overnight.
quarterly	Per quarter on the date specified. Used in conjunction with the ReportRecurrence#start to determine which months are included.
weekly	Runs on Sunday at midnight in the local timezone for the previous 7 days.

ReportStatus enum (string)

Describes the progress of the report processor working on this ReportResult.

Values
Value	Description
completed	The ReportResult is completed and ready to view.
created	The ReportResult has been created, but not yet begun processing.
failed	There was a failure during processing. See ReportResult#notes for details.
queued	The system is waiting for resources before processing the report.
running	The report processor has begun processing the results.
saving	Processing of the results is completed and is now being saved for viewing.

Users and Permissions

authorizer object

A collection of utility methods that allows you to check a user's permission to objects within the system. The most common functions you should use are authorizer.hasSimple and authorizer.hasComplex.

Usage

var value = trakit.fleetfreedom.authorizer.member;
/* or */
var result = trakit.fleetfreedom.authorizer.member(...params);

Properties
Property	Type	Description
complex	Array.<PermissionType>	The PermissionTypes which are calculated using labels.
implied	Array.<PermissionType>	A list of PermissionTypes which are implied for each user's own company.
simple	Array.<PermissionType>	PermissionTypes which do not use labels to calculate access.

Functions
Method	Returns	Description
compute(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number / targetCompanyId, /* boolean */ skipImpliedPermissions)	Array.<UserPermission>	Creates a well ordered array of UserPermissions which can be used to further calculate a user's permissions for the target company.
computeAll(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* boolean */ skipImpliedPermissions)	Dictionary.<number, Array.<UserPermission>>	Creates a Dictionary where the key is a Company#id and the values are well ordered arrays of UserPermissions which can be used to further calculate a user's permissions.
computeAllComplex(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> */ fromUser)	Dictionary.<number, Array.<UserPermission>>	Creates a Dictionary where the key is a Company#id and the values are well ordered arrays of complex UserPermissions which can be used to further calculate a user's permissions.
computeAllSimple(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> */ fromUser)	Dictionary.<number, Array.<UserPermission>>	Creates a Dictionary where the key is a Company#id and the values are well ordered arrays of simple UserPermissions which can be used to further calculate a user's permissions.
computeComplex(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number */ targetCompanyId)	Array.<UserPermission>	Creates a well ordered array of complex UserPermissions which can be used to further calculate a user's permissions.
computeSimple(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number */ targetCompanyId)	Array.<UserPermission>	Creates a well ordered array of simple UserPermissions which can be used to further calculate a user's permissions.
computeSimpleLevels(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number */ targetCompanyId)	Dictionary.<PermissionType, PermissionLevel>	Creates a Dictionary where the key is a PermissionType and the values are PermissionLevels.
findAllEscalations(/** number / userCompanyId, /* Dictionary.<number\|Array.<UserPermission>> / before, /* Dictionary.<number\|Array.<UserPermission>> / after, /* Dictionary.<number\|Array.<string>> */ targetCompaniesLabels)	Dictionary.<number, Array.<UserPermission>>	Generates a Dictionary (company identifier as the key) of permissions being escalated between two computed permission states.
findAnyComplex(/** number / userCompanyId, /* Array.<UserPermission> / permissions, /* PermissionType / targetType, /* PermissionLevel */ targetLevel)	boolean	Checks a specific complex permission type, level, but not the labels, and returns true if access is granted. This method can be used as a short-circuit to diving deeper into check label specific permissions.
findComplex(/** number / userCompanyId, /* Array.<UserPermission> / permissions, /* Array.<string> / targetCompanyLabels, /* PermissionType / targetType, /* Array.<string> / targetLabels, /* PermissionLevel */ targetLevel)	boolean	Checks a specific complex permission type, level, and labels from a pre-computed array of permissions, and returns true if access is granted.
findComplexLevel(/** number / userCompanyId, /* Array.<UserPermission> / permissions, /* Array.<string> / targetCompanyLabels, /* PermissionType / targetType, /* Array.<string> */ targetLabels)	PermissionLevel \| undefined	Retrieves the specified complex permission level from a pre-computed array of permissions. If the permission type specified is not found, undefined is returned instead.
findEscalations(/** number / userCompanyId, /* Array.<UserPermission> / before, /* Array.<UserPermission> / after, /* Array.<string> */ targetCompanyLabels)	Array.<UserPermission>	Generates an array of permissions being escalated between two computed permission states for a target company.
findSimple(/** number / userCompanyId, /* Array.<UserPermission> / permissions, /* PermissionType / targetType, /* PermissionLevel */ targetLevel)	boolean	Checks a specific simple permission type and level from a pre-computed array of permissions, and returns true if access is granted.
findSimpleLevel(/** number / userCompanyId, /* Array.<UserPermission> / permissions, /* PermissionType */ targetType)	PermissionLevel \| undefined	Retrieves the specified simple permission level from a pre-computed array of permissions. If the permission type specified is not found, undefined is returned instead.
getComplexLevel(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number / targetCompanyId, /* Array.<string> / targetCompanyLabels, /* PermissionType / targetType, /* Array.<string> */ targetLabels)	PermissionLevel \| undefined	Gets the permission level of the given complex permission type. If the permission type specified is not found, undefined is returned instead.
getSimpleLevel(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number / targetCompanyId, /* PermissionType */ targetType)	PermissionLevel \| undefined	Gets the permission level of the given simple permission type. If the permission type specified is not found, undefined is returned instead.
hasAnyComplex(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number / targetCompanyId, /* PermissionType / targetType, /* PermissionLevel */ targetLevel)	boolean	Checks a specific complex permission type, level, but not the labels, and returns true if access is granted. This method can be used as a short-circuit to diving deeper into check label specific permissions.
hasComplex(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number / targetCompanyId, /* Array.<string> / targetCompanyLabels, /* PermissionType / targetType, /* Array.<string> / targetLabels, /* PermissionLevel */ targetLevel)	boolean	Checks a specific complex permission type, level, and labels, and returns true if access is granted.
hasSimple(/** number / userCompanyId, /* Array.<UserPermission> / fromGroups, /* Array.<UserPermission> / fromUser, /* number / targetCompanyId, /* PermissionType / targetType, /* PermissionLevel */ targetLevel)	boolean	Checks a specific simple permission type and level, and returns true if access is granted.

Contact class

Inheritance: MVCObject > Contact

A Contact is an employee of a Company, but who may also perform other roles in other companies.

Usage

var object = new trakit.fleetfreedom.Contact(/** Company */ company, /** trakit.json.Contact */ object);

Properties
Property	Type	Description
address	string	A physical mail location.
addresses	Dictionary.<string, string>	Mailing addresses for this contact.
company	Company	The Company which employs this contact
dates	Dictionary.<string, Date>	Inportant contact dates like birthdays.
email	string	Primary email address.
emails	Dictionary.<string, string>	Email addresses used for this contact.
fax	number	Why can't we get rid of these damn machines?
id	number	Unique identifier
mobile	number	A cellular phone number.
name	string	This person's name.
notes	string	Miscellaneous notes for this person.
office	number	A workplace landline phone number.
options	Dictionary.<string, string>	Additional information not easily categorized.
otherNames	Dictionary.<string, string>	Other names for this contact.
phones	Dictionary.<string, number>	Phone numbers for this contact including cell, office, home, fax, etc.
pictureIds	Array.<number>	A list of Picture#ids of this person.
pictures	Array.<Picture>	A list of Pictures of this person.
roles	Array.<string>	The types of jobs this person performs for this company
url	string	Website.
urls	Dictionary.<string, string>	Websites and online resources of this contact.
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** Contact / json, /* boolean */ silent)	Contact	Updates parameters for this Contact from the given JSON literal
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this contact. Used internally by Company#findContacts.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

Machine class

Inheritance: MVCObject > Machine

A service account that allowes for API access of Fleet Freedom services.

Usage

var object = /** Company */ companyInstance.createMachine(/** trakit.json.Machine */ json);

Properties
Property	Type	Description
company	Company	The Company which employs this Machine account.
enabled	boolean	Ability to disable this Machine account. Affects ability to use Fleet Freedom services.
formats	Dictionary.<string, string>	The format strings defining the preferred way to display ambiguous values.
groups	Array.<UserGroup>	Groups of which this Machine account is a member
insecure	boolean	When true, no access restrictions (Machine#secret, Machine#referrers, or Machine#ipRanges) are enforced.
ipRanges	Array.<string>	Optional ranges of IP address ranges (using CIDR notation) to limit access to certain IPs. Currently, we only support IPv4.
key	string	The unique identifier used by this Machine account.
language	string	API credentials' preferred region and language
measurements	Dictionary.<string, UserMeasurementPreference>	Preferred way of displaying ambiguous numbers in the context of measurements.
nickname	string	Friendly search-able name for this Machine account.
notAfter	Date	An optional timestamp that restricts this Machine account from being used after the given date.
notBefore	Date	An optional timestamp that restricts this Machine account from being used before the given date.
notes	string	Notes about this Machine account.
options	Dictionary.<string, string>	Additional options which do not fit in with the formats or measurements preferences.
permissions	Array.<UserPermission>	Permissions assigned to this Machine account.
referrers	Array.<string>	Optional list of your managed domains from which this Machine account can be used.
secret	string	A token used for encoding or validating requests.
services	Array.<string>	List of Fleet Freedom service URIs that this Machine account is permitted to access.
timezone	string	API credentials' native Timezone
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.Machine / json, /* boolean */ silent)	Machine	Updates parameters for this servce account from the given JSON literal
getName()	string	Get's the best choice for display name.
getUserGroups()	Array.<UserGroup>	Gets an Array of UserGroups to which these API credentials belongs.
isAllowed()	boolean	Returns true when these API credentials is enabled, can access a Fleet Freedom service, and has a valid operating dates.
isBetween()	boolean	Returns true when the current date/time is after the notBefore value (or it is null) and before the notAfter value (or it is null).
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to these API credentials. Used internally by Company#findMachines.
isRestricted()	boolean	Returns true when the machine has been restricted by secret, HTTP header, or IP range.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

Session class

An active or idling user session

Usage

var object = /** Company */ companyInstance.getSessions,();

Properties
Property	Type	Description
active	boolean	True when an active WebSocket connection exists.
company	Company	The Company which employs the User for this Session.
created	Date	The time-stamp from this session's first login.
handle	string	A unique key to identify this Session. This is not the SessionID.
ipAddress	string	Client's IP address.
lastActivity	Date	The time-stamp of the last command executed by this session.
lastCommand	string	The last socket command or RESTful route invoked by the session.
sockets	number	The number of active WebSocket connections in use by this session.
user	User	The User associated with this Session.
userAgent	string	The client software identification string.

User class

Inheritance: MVCObject > User

A user of Fleet Freedom services

Usage

var object = /** Company */ companyInstance.createUser(/** trakit.json.UserGeneral | trakit.json.UserAdvanced */ json);

Properties
Property	Type	Description
company	Company	The Company which employs the User for this Session
contact	Contact	The full Contact details of this User.
contactId	number	The ID of the contact with the full details for this User.
enabled	boolean	Ability to disable this User. Affects ability to login and notifications.
formatDate	string	Format definition for displaying dates. (Deprecated; use User#formats["date"] instead)
formats	Dictionary.<string, string>	The format strings defining the preferred way to display ambiguous values.
formatTime	string	Format definition for displaying times. (Deprecated; use User#formats["time"] instead)
groupIds	Array.<number>	List of UserGroup#ids for which this user is a member.
groups	Array.<UserGroup>	Groups of which this User is a member
language	string	User's preferred region and language
login	string	The unique username used to login
measureDistance	UserMeasurementPreference	Preferred method of displaying distances and speed. (Deprecated; use User#measurements["distance"] instead)
measurements	Dictionary.<string, UserMeasurementPreference>	Preferred way of displaying ambiguous numbers in the context of measurements.
measureVolume	UserMeasurementPreference	Preferred method of displaying volumes. (Deprecated; use User#measurements["volume"] instead)
nickname	string	Friendly search-able name for this user.
notifications	Array.<UserNotifications>	Notification schedule preferences.
notify	UserNotifications	First notification schedule preferences (Deprecated; use User#notifications[0] instead).
options	Dictionary.<string, string>	Additional options which do not fit in with the formats or measurements preferences.
passwordExpired	boolean	Flags if the user needs to change their password on the next login.
permissions	Array.<UserPermission>	Individual permissions assigned to this User
timezone	string	User's native Timezone
version	Array.<number>	The version flag used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** trakit.json.User / json, /* boolean */ silent)	User	Updates parameters for this User from the given JSON literal
getName()	string	Get's the best choice for display name.
getPictures()	Array.<Picture>	Gets an Array of Pictures for this User.
getSessions()	Array.<Session>	Gets an Array of Sessions which this User has created.
getUserGroups()	Array.<UserGroup>	Gets an Array of UserGroups to which this User belongs.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this user. Used internally by Company#findUsers.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

UserGroup class

Inheritance: MVCObject > UserGroup

A group of permissions for Users

Usage

var object = /** Company */ companyInstance.createUserGroup(/** trakit.json.UserGroup */ json);

Properties
Property	Type	Description
id	number	Unique identifier.
name	string	Easily identifiable name for this group of permissions.
notes	string	Detailed notes about which type of Users should be granted access to this group.
permissions	Array.<UserPermission>	Permissions assigned to Users in this group.
version	Array.<number>	The version flags used to ensure sync operations are done in order.

Functions
Method	Returns	Description
debug(/** RegExp */ pattern)	boolean	Invokes the debugger when MVCObject#fire is called for a matching RegExp.
dispose()		Unbinds all event handlers and prepares the object for disposal by the garbage collector
fire(/** string / type, /* ? */ detail)	MVCEvent	Creates an MVCEvent and raises it with the optional detail MVCEvent#detail
fromJSON(/** UserGroup / json, /* boolean */ silent)	UserGroup	Updates parameters for this UserGroup from the given JSON literal
getUsers()	Array.<User>	Returns a list of Users that belong to this group.
isMatch(/** SearchPattern */ pattern)	boolean	Checks the given SearchPattern for a match to this group. Used internally by Company#findUserGroups.
off(/** string / type, /* function */ handler)	boolean	Removes an event handler
on(/** string / type, /* function */ handler)	boolean	Adds an event handler
once(/** string / type, /* function */ handler)	boolean	Adds an event handler that fires once, then unbinds itself
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.
trace(/** RegExp */ pattern)	boolean	Writes all calls to MVCObject#fire to the console.info matching the given RegExp.
uses(/** string / type, /* function */ handler)	boolean	Checks to see if the given type/handler is bound for this object

UserNotifications class

User notification preferences

Usage

var object = new trakit.fleetfreedom.UserNotifications(/** string */ name, /** boolean */ enabled, /** Array.<boolean> */ weekdays, /** string */ start, /** string */ end, /** string */ email, /** number */ sms, /** Array.<UserNotificationsMethod> */ online, /** Array.<UserNotificationsMethod> */ offline);

Properties
Property	Type	Description
email	string	When provided, email notifications are sent to this address instead of the Contact#email or User#login.
enabled	boolean	Flags whether this schedule is in use.
end	TimeSpan	Time-stamp to denote when notifications should no longer be sent.
name	string	Nickname for this schedule
offline	Array.<UserNotificationsMethod>	The types of notifications to send while this User's session is inactive.
online	Array.<UserNotificationsMethod>	The types of notifications to send while this User's session has an active WebSocket connection.
sms	number	When provided, SMS notifications are sent to this phone number instead of the Contact#mobile.
start	TimeSpan	Starting time-stamp for when notifications should be sent.
weekdays	Array.<boolean>	A seven item, boolean array identifying the days of the weeks for which notifications should be sent.

Functions
Method	Returns	Description
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

UserPermission class

Individual permissions.

Usage

var object = new trakit.fleetfreedom.UserPermission(/** number */ company, /** PermissionMethod */ method, /** PermissionType */ kind, /** PermissionLevel */ level, /** Array.<string> */ labels);

Properties
Property	Type	Description
company	number	The unique identifier of the company for which this permission applies.
kind	PermissionType	The kind of permission assigned. Please see the permissions documentation.
labels	Array.<string>	The Company#labels names used to apply this permission. So far, this only applies to assetGeneral, assetAdvanced, and placeGeneral.
level	PermissionLevel	The amount of access granted or revoked.
method	PermissionMethod	Whether the permission is given or taken away.

Functions
Method	Returns	Description
equals(/** UserPermission */ other)	boolean	Compares this UserPermission to another to see if they are equivalent.
toJSON()	Object	Creates a literal of this object. Used internally by JSON.stringify.

PermissionLevel enum (string)

Defines the amount of access granted or revoked.

Values
Value	Description
full	Read, update, and create/delete.
read	Read-only access.
update	Read and update