JavaScript API Reference | Developers

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
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
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);

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.
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.
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.
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.socket.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.socket.Asset | trakit.socket.AssetGeneral | trakit.socket.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.
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.socket.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.socket.Message */ 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.socket.Asset \| trakit.socket.AssetGeneral \| trakit.socket.AssetAdvanced / json, /* boolean */ silent)	Asset	Updates parameters for this Asset from the given JSON literal
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
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.
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.socket.Asset | trakit.socket.PersonGeneral | trakit.socket.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.
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.socket.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.socket.Message */ 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.socket.Asset \| trakit.socket.AssetGeneral \| trakit.socket.AssetAdvanced / json, /* boolean */ silent)	Person	Updates parameters for this Person from the given JSON literal
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
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.
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.socket.Asset | trakit.socket.TrailerGeneral | trakit.socket.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)
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.socket.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.socket.Message */ 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.socket.Asset \| trakit.socket.TrailerGeneral \| trakit.socket.AssetAdvanced / json, /* boolean */ silent)	Trailer	Updates parameters for this Trailer from the given JSON literal.
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
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.
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.socket.Asset | trakit.socket.VehicleGeneral | trakit.socket.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.
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.socket.DispatchTask */ task)	DispatchTask	Creates a new DispatchTask and adds it to the Dispatch#tasks array
createMessage(/** trakit.socket.Message */ 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.socket.Asset \| trakit.socket.VehicleGeneral \| trakit.socket.VehicleAdvanced / json, /* boolean */ silent)	Vehicle	Updates parameters for this Vehicle from the given JSON literal
getDispatchTaskById(/** number */ id)	DispatchTask	Retrieves the DispatchTask with the given id or null if none found.
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.
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.socket.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.socket.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.socket.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.socket.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.socket.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.socket.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.

Billing

BillableHostingDiscount class

Inheritance: MVCObject > BillableHostingDiscount

A billing rule for assets

Usage

var object = new trakit.fleetfreedom.BillableHostingDiscount(/** BillingProfile */ profile, /** trakit.socket.BillableHostingDiscount */ object);

Properties
Property	Type	Description
amount	string	Cost per Asset.
limit	number	The number of units to which this billing rule applies.
name	string	The name of this billing rule.
notes	string	Notes about billing this rule.
percentage	boolean	When true, the amount is used as a percentage value instead of a currency values.
reference	string	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
services	Array.<BillableHostingType>	The type of services being discounted.
suspended	boolean	Does this hosting rule apply to suspended resources.
targets	Array.<SearchPattern>	Which assets are targetted by this hosting rule.

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(/** BillableHostingDiscount / json, /* boolean */ silent)	BillableHostingDiscount	Updates parameters for this BillableHostingDiscount 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

BillableHostingLicense class

Inheritance: MVCObject > BillableHostingLicense

A billing rule for assets

Usage

var object = new trakit.fleetfreedom.BillableHostingLicense(/** BillingProfile */ profile, /** trakit.socket.BillableHostingLicense */ object);

Properties
Property	Type	Description
amount	string	Cost per Asset.
kind	BillableLicenseType	The type of hardware license.
limit	number	The number of units to which this billing rule applies.
name	string	The name of this billing rule.
notes	string	Notes about billing this rule.
reference	string	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
suspended	boolean	Does this hosting rule apply to suspended resources.
targets	Array.<SearchPattern>	Which assets are targetted by this hosting rule.

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(/** BillableHostingLicense / json, /* boolean */ silent)	BillableHostingLicense	Updates parameters for this BillableHostingLicense 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

BillableHostingRule class

Inheritance: MVCObject > BillableHostingRule

A billing rule for assets

Usage

var object = new trakit.fleetfreedom.BillableHostingRule(/** BillingProfile */ profile, /** trakit.socket.BillableHostingRule */ object);

Properties
Property	Type	Description
amount	string	Cost per Asset.
limit	number	The number of units to which this billing rule applies.
name	string	The name of this billing rule.
notes	string	Notes about billing this rule.
reference	string	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
service	BillableHostingType	The type of service being billed.
suspended	boolean	Does this hosting rule apply to suspended resources.
targets	Array.<SearchPattern>	Which assets are targetted by this hosting rule.

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(/** BillableHostingRule / json, /* boolean */ silent)	BillableHostingRule	Updates parameters for this BillableHostingRule 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

BillableRatePlan class

Inheritance: MVCObject > BillableRatePlan

A cellular/data rate plan

Usage

var object = new trakit.fleetfreedom.BillableRatePlan(/** BillingProfile */ profile, /** trakit.socket.BillableRatePlan */ object);

Properties
Property	Type	Description
amountOverageKB	number	Cost per kilobytes over the included volume.
amountOverageSMS	number	Cost per message over the included volume.
name	string	The name of this billing rule.
notes	string	Notes about billing this rule.
reference	string	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
volumeKB	number	The volume of data (in kilobytes) included with this plan.
volumeSMS	number	The number of SMS messages included with the plan.

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(/** BillableRatePlan / json, /* boolean */ silent)	BillableRatePlan	Updates parameters for this BillableRatePlan 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

BillableReseller class

Inheritance: MVCObject > BillableReseller

Custom portal service details

Usage

var object = new trakit.fleetfreedom.BillableReseller(/** BillingProfile */ profile, /** trakit.socket.BillableReseller */ object);

Properties
Property	Type	Description
billingSystem	boolean	Is this company allowed to use the billing system
instances	number	Number of websites hosted.
name	string	The name of this billing rule.
notes	string	Notes about billing this rule.
reference	string	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
virtualSMS	number	Number of virtual numbers used to send/receive SMS messages.

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(/** BillableReseller / json, /* boolean */ silent)	BillableReseller	Updates parameters for this BillableReseller 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

BillableSmsProfile class

Description of a tiered SMS messaging limit

Usage

var object = new trakit.fleetfreedom.BillableSmsProfile(/** trakit.socket.BillableSmsProfile */ object);

Properties
Property	Type	Description
amount	number	Cost per SMS message sent. Received messages are free.
limit	number	The maximum number of messages sent per cycle

BillableSupport class

Inheritance: MVCObject > BillableSupport

Support contract details

Usage

var object = new trakit.fleetfreedom.BillableSupport(/** BillingProfile */ profile, /** trakit.socket.BillableSupport */ object);

Properties
Property	Type	Description
amountOverage	number	Cost (per hour) over the included amount.
included	number	Amount of included time for this customer/technical support package.
name	string	The name of this billing rule.
notes	string	Notes about billing this rule.
reference	string	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...

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(/** BillableSupport / json, /* boolean */ silent)	BillableSupport	Updates parameters for this BillableSupport 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

BillingProfile class

The billing policies and details for a specific Company

Usage

var object = new trakit.fleetfreedom.BillingProfile(/** trakit.socket.BillingProfile */ object);

Properties
Property	Type	Description
billee	number	Unique identifier of the Company receiving the bill. Most of the time, this value is the same as the BillingProfile#company.
company	number	Company that owns this profile and is sending the bill.
currency	BillingCurrency	Kind of money
cycle	BillingCycle	How many times should we create a bill
cycleEnd	Date	When should the cycle end (customer cancelled)
cyclePostDated	bool	Pro-rated, or post-dated.
cycleStart	Date	When is the first day of the billing cycle
googleServicesEnabled	bool	Are the Google services available to be proxied by the service?
id	number	Unique identifier of this billing profile
messages	Array.<BillableSmsProfile>	SMS messaging tiers
name	string	The name of this billing profile.
notes	string	Notes about billing this profile.
target	number	Unique identifier of the Company to which this rule pertains.

Functions
Method	Returns	Description
fromJSON(/** BillingProfile / json, /* boolean */ silent)	BillingProfile	Updates parameters for this BillingProfile from the given JSON literal
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.

BillableHostingType enum (string)

Defines the kind of service being billed.

Values
Value	Description
asset	Generic dot-on-a-map tracking
cargo	Cargo and delivery audit
dispatch	Tasks assignable to vehicles or persons
elogs	FMCSA compliant E-Logs and Hours of Service
forms	Mobile forms
inventory	Inventory management
mobile	Employee/driver tracking
streetview	Dashcam and live images hosting
vehicle	Vehicle tracking (includes VBus data, and engine hours)

BillableLicenseType enum (string)

The kind of license being billed.

Values
Value	Description
smartwitness	SmartWitness data hosting fee

BillingCurrency enum (string)

Defines password expiration behaviour for the Company.

Values
Value	Description
CAD	Canadian dollars
EURO	Eurozone currency
USD	American dollars

BillingCycle enum (string)

The type of repeating cycle used for generating bills.

Values
Value	Description
annually	Once per year
daily	Every day
monthly	Once a month
quarterly	Every three months
weekly	Each week

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

Usage

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

Properties
Property	Type	Description
analytics	CompanyAnalytics	Real-time analytic rules and summaries for assets
assets	Array.<Asset>	List or virtual assets, persons, vehicles, and trailers
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
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
maintenanceJobs	Array.<MaintenanceJob>	Historical maintenance for Assets
maintenanceSchedules	Array.<MaintenanceSchedule>	Recurring maintenance rules for Assets
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>
providerConfigurations	Array.<ProviderConfiguration>	Configured ProviderConfigurationTypes for this company's providers
providers	Array.<Provider>	Company owned modems, apps, and other event providers
providerScripts	Array.<ProviderScript>
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
sessionPolicy	CompanySessions	Policy regarding session expiration
sessions	Array.<UserSession>	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
createAnalyticRule(/** trakit.socket.AnalyticRule */ json)	AnalyticRule	Creates a new AnalyticRule and adds it to the CompanyHoS#inspections array.
createAnalyticSummary(/** trakit.socket.AnalyticSummary */ json)	AnalyticSummary	Creates a new AnalyticSummary and adds it to the CompanyHoS#inspections array.
createAsset(/** trakit.socket.Asset \| trakit.socket.AssetGeneral \| trakit.socket.AssetAdvanced */ json)	Asset	Creates a new Asset and adds it to the Company#assets array
createBehaviour(/** trakit.socket.Behaviour */ json)	Behaviour	Creates a new Behaviour and adds it to the Company#behaviours array.
createBehaviourScript(/** trakit.socket.BehaviourScript */ json)	BehaviourScript	Creates a new BehaviourScript and adds it to the Company#behaviourScripts array.
createContact(/** trakit.socket.Contact */ json)	Contact	Creates a new Contact and adds it to the Company#contacts array
createHosCarrier(/** trakit.socket.HosCarrier */ json)	HosCarrier	Creates a new HosCarrier and adds it to the CompanyHoS#carriers array.
createHosEvent(/** trakit.socket.HosEvent */ json)	HosEvent	Creates a new HosEvent and adds it to the CompanyHoS#events array.
createHosInspection(/** trakit.socket.HosInspection */ json)	HosInspection	Creates a new HosInspection and adds it to the CompanyHoS#inspections array.
createIcon(/** trakit.socket.Icon */ json)	Icon	Creates a new Icon and adds it to the Company#icons array.
createLabel(/** trakit.socket.LabelStyle */ json)	LabelStyle	Creates a new LabelStyle and adds it to the Company#labels array
createMaintenanceJob(/** trakit.socket.MaintenanceJob */ json)	MaintenanceJob	Creates a new MaintenanceJob and adds it to the Company#maintenanceJobs array.
createMaintenanceSchedule(/** trakit.socket.MaintenanceSchedule */ json)	MaintenanceSchedule	Creates a new MaintenanceSchedule and adds it to the Company#maintenanceSchedules array.
createPerson(/** trakit.socket.Asset \| trakit.socket.AssetGeneral \| trakit.socket.AssetAdvanced */ json)	Person	Creates a new Person and adds it to the Company#assets array.
createPicture(/** trakit.socket.Picture */ json)	Picture	Creates a new Picture and adds it to the Company#pictures array
createPlace(/** trakit.socket.PlaceGeneral */ json)	Place	Creates a new Place and adds it to the Company#places array.
createProvider(/** trakit.socket.Provider */ json)	Provider	Creates a new Provider and adds it to the Company#providers array.
createProviderConfig(/** trakit.socket.ProviderConfig */ json)	ProviderConfig	Creates a new ProviderConfig and adds it to the Company#providerConfigs array.
createProviderConfiguration(/** trakit.socket.ProviderConfiguration */ json)	ProviderConfiguration	Creates a new ProviderConfiguration and adds it to the Company#providerConfigurations array.
createProviderScript(/** trakit.socket.ProviderScript */ json)	ProviderScript	Creates a new ProviderScript and adds it to the Company#providerScripts array.
createReportResult(/** trakit.socket.ReportResult */ json)	ReportResult	Creates a new ReportResult and adds it to the Company#reportResults array.
createReportSchedule(/** trakit.socket.ReportSchedule */ json)	ReportSchedule	Creates a new ReportSchedule and adds it to the Company#reportSchedules array.
createReportTemplate(/** trakit.socket.ReportTemplate */ json)	ReportTemplate	Creates a new ReportTemplate and adds it to the Company#reportTemplates array.
createSession(/** trakit.socket.SessionHandle */ json)	UserSession	Creates a new UserSession and adds it to the Company#sessions array.
createTrailer(/** trakit.socket.Asset \| trakit.socket.AssetGeneral \| trakit.socket.AssetAdvanced */ json)	Trailer	Creates a new Trailer and adds it to the Company#assets array.
createUser(/** trakit.socket.User */ json)	User	Creates a new User and adds it to the Company#users array
createUserGroup(/** trakit.socket.UserGroup */ json)	UserGroup	Creates a new UserGroup and adds it to the Company#userGroups array
createVehicle(/** trakit.socket.Asset \| trakit.socket.AssetGeneral \| trakit.socket.AssetAdvanced */ 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.
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.
findBillingBundles(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<BillingBundle>	Finds all the BillingBundles that match the given search expression. Internally, this method invokes BillingBundle#isMatch.
findBillingRules(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<BillingRule>	Finds all the BillingRules that match the given search expression. Internally, this method invokes BillingRule#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.
findIcons(/** string \| SearchPattern \| Array.<SearchPattern> */ expression)	Array.<Icon>	Finds all the Icons that match the given search expression. Internally, this method invokes Icon#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.
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.
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.socket.Company \| trakit.socket.CompanyGeneral \| trakit.socket.CompanyLabels \| trakit.socket.CompanyPolicies \| trakit.socket.CompanyReseller / json, /* boolean */ silent)	Company	Updates parameters for this Company from the given JSON literal
getAnalyticRuleById(/** number */ id)	AnalyticRule	Retrieves the AnalyticRule with the given id or null if none found
getAnalyticSummaryById(/** number */ id)	AnalyticSummary	Retrieves the AnalyticSummary with the given id or null if none found
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.
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
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
getMaintenanceJobById(/** number */ id)	Provider	Retrieves the MaintenanceJob with the given id or null if none found
getMaintenanceScheduleById(/** number */ id)	Provider	Retrieves the MaintenanceSchedule 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(/** number */ 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
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
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)	UserSession	Retrieves the UserSession 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 UserTemplate 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
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

CompanyAnalytics class

Container for Real-time analytic information related to the company

Usage

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

Properties
Property	Type	Description
company	Company	The Company to which this object belongs
rules	Array.<AnalyticRule>
summaries	Array.<AnalyticSummary>

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

CompanyBilling class

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

Usage

var object = /** Company */ companyInstance.fromJSON(/** trakit.socket.Company | trakit.socket.CompanyGeneral | trakit.socket.CompanyLabels | trakit.socket.CompanyPolicies | trakit.socket.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.socket.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.socket.Company | trakit.socket.CompanyGeneral | trakit.socket.CompanyLabels | trakit.socket.CompanyPolicies | trakit.socket.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.socket.Company | trakit.socket.CompanyGeneral | trakit.socket.CompanyLabels | trakit.socket.CompanyPolicies | trakit.socket.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.socket.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.socket.Company | trakit.socket.CompanyGeneral | trakit.socket.CompanyLabels | trakit.socket.CompanyPolicies | trakit.socket.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.socket.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.

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

Contacts

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.socket.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

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.socket.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.
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.
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.socket.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.socket.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	string	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	string	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.socket.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.socket.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.
template	ProviderConfigurationType	The type of 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.socket.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.socket.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.socket.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

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.socket.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	string	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.socket.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
airlink	Sierra Wireless RAP compatible modems (AirLink)
bewhere	BeWhere asset trackers
bluetree	BlueTree and Sixnet BT series modems (Red Lion)
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

Dispatch class

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

Usage

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

Properties
Property	Type	Description
asset	Asset	The Asset to which this Dispatch is assigned
colour	string	The hex colour of the polyline
directions	Array.<string>	Instructions on how to travel between Tasks
polyline	Array.<LatLng>	The shape of the turn-by-turn directions
tasks	Array.<DispatchTask>	List of tasks to perform during this Dispatch

Functions
Method	Returns	Description
fromJSON(/** Dispatch */ json)	Dispatch	Updates parameters for this Dispatch from the given JSON literal
getBounds()	LatLngBounds	Gets a latlng bounding box for the tasks (and optional directions)
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(/** Asset */ asset, /** trakit.socket.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
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	number	The expected time-on-site (in seconds; affects ETAs for other tasks in a Dispatch).
eta	Date	Expected Time of Arrival.
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.
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.socket.DispatchTask / json, /* boolean */ silent)	DispatchTask	Updates parameters for this DispatchTask 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

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

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.
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.socket.StreetAddress */ json)	StreetAddress	Creates a StreetAddress out of a trakit.socket.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.socket.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.socket.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.socket.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.socket.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.socket.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.socket.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
caliPassenger80h8d	California Passenger 80 hour / 8 day
caliProperty80h8d	California Property 80 hour / 8 day
canada120h14d	Canada South 120 hour / 14 day (Cycle 2)
canada70h7d	Canada South 70 hour / 7 day (Cycle 1)
canadaOilGas	Canada South Oil and Gas
texas70h7d	Texas 70 hour / 7 day
usaPassenger60h7d	USA Passenger 60 hour / 7 day
usaProperty60h7d	USA Property 60 hour / 7 day
usaProperty70h8d	USA Property 70 hour / 8 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

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"
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
diagnostic	A malfunction or data diagnostic detection occurence
dutyStatus	A change in driver's duty-status
enginePower	CMV's engine power up/shutdown activity
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

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
cycle_120	120 Hour Cycle Limit
cycle_60	60 Hour Cycle Limit
cycle_70	70 Hour Cycle Limit
daily_break_10	Daily 10 Hour Off-Duty Required
daily_driving_13	Daily 13 Hour Driving Limit
daily_duty_14	Daily 14 Hour On-Duty Limit
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

Icons

Icon class

Inheritance: MVCObject > Icon

A mapped iconic representation of an Asset

Usage

var object = new trakit.fleetfreedom.Icon(/** Company */ company, /** trakit.socket.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.socket.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.

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.

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	UserSession	A JSON equivalent UserSession 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
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.

Label and Tag styles

LabelStyle class

Inheritance: MVCObject > LabelStyle

Labels are styled based on the available style definition

Usage

var object = /** Company */ companyInstance.createLabel(/** trakit.socket.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.socket.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

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.socket.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	number	The amount of time (in seconds) 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.socket.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.socket.MaintenanceSchedule */ object);

Properties
Property	Type	Description
company	Company	The Company to which this MaintenanceSchedule relates
cost	number	Estimated cost for these jobs
duration	number	Estimated amount of time (in seconds) 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.socket.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(/** Asset */ asset, /** trakit.socket.Message */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which this object relates
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.socket.Message / 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

Photos / Images

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.socket.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.
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.socket.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 number.
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.socket.PlaceGeneral */ object);
/* or */
var object = /** Company */ companyInstance.createPlace(/** trakit.socket.PlaceGeneral */ json);

Properties
Property	Type	Description
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	The full street 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.socket.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.

Real-time Analytics

AnalyticRule class

Inheritance: MVCObject > AnalyticRule

Usage

var object = new trakit.fleetfreedom.AnalyticRule(/** Company */ company, /** trakit.socket.AnalyticRule */ object);

Properties
Property	Type	Description
company	Company	The Company to which this asset belongs.

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.socket.AnalyticRule / json, /* boolean */ silent)	AnalyticRule	Updates parameters for this AnalyticRule 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

AnalyticSummary class

Inheritance: MVCObject > AnalyticSummary

Analysis for an asset of a specific type and instance.

Usage

var object = new trakit.fleetfreedom.AnalyticSummary(/** Company */ company, /** trakit.socket.AnalyticSummary */ object);

Properties
Property	Type	Description
asset	Asset	The Asset to which this asset belongs.
company	Company	The Company to which this asset belongs.
complete	boolean	Denotes that an event has been processed to invalidate the sequence and end the summary.
distance	number	The distance travelled in kilometres by the asset.
duration	number	The amount of time that passed.
eventCount	number	The number of events included in the calculation.
firstDate	Date	Timestamp from the first event in the sequence.
firstState	trakit.socket.AssetAdvanced	The first asset state which begins this summary instance.
id	number	Unique identifier
kind	AnalyticType	The type of analysis done.
lastDate	Date	Timestamp from the last event in the sequence.
lastState	trakit.socket.AssetAdvanced	The asset state that ended this summary instance.
polyline	Array.<LatLng>	A path created from all the asset's positions in sequence.
state	string	Code given to this analysis for the asset.
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.socket.AnalyticSummary / json, /* boolean */ silent)	AnalyticSummary	Updates parameters for this AnalyticSummary 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

AnalyticType enum (string)

The types an analyses being performed.

Values
Value	Description
places	All Places visited.
regions	Every geographic region such as cities, provinces/states, and countries.
tags	Analysis for each Status Tag applied to each asset.
tasks	Life-time of each Task assigned to each asset.

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.socket.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.socket.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.socket.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.socket.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.socket.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.socket.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(/** 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.

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.socket.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.socket.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.socket.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	number	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)	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)	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.

User class

Inheritance: MVCObject > User

A user of Fleet Freedom services

Usage

var object = /** Company */ companyInstance.createUser(/** trakit.socket.User */ 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.socket.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.<UserSession>	Gets an Array of UserSessions 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.socket.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 */ type, /** PermissionLevel */ level, /** Array.<string> */ labels);

Properties
Property	Type	Description
company	number	The unique identifier of the company for which this permission applies.
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.
type	PermissionType	The kind of permission assigned. Please see the permissions documentation.

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.

UserSession 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.

Functions
Method	Returns	Description
equals(/** UserSession */ other)	boolean	Compares this UserSession 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 access; does not allow for create or delete.

PermissionMethod enum (string)

The two types of permission assignment

Values
Value	Description
grant	Give access
revoke	Take access away

PermissionType enum (string)

The kinds of permissions available for UserPermissions.

Values
Value	Description
analyticRule	Rules definiting real-time analytic calculations.
analyticSummary	Updates to the calculations of real-time analytics.
assetAdvanced	Assets' advanced properties such as position, attributes, and status tags.
assetGeneral	Assets' general properties such as name, icon, and labels.
assetMessage	Messages from assets and Alerts to the session user.
behaviour	Configured behaviours.
behaviourLog	View and clear the log of debug messages for a behaviour or script.
behaviourScript	Behaviour script logic.
companyCreate	Access to add a new child company.
companyGeneral	Basic information about the company. This permissions is required to have access to other aspects of the company.
companyLabels	Company's label and tag styles.
companyPolicies	Company's SessionPolicy and PasswordPolicy.
companyReseller	Reseller and white-labeler specific settings.
contact	Contact information.
dispatchTask	Assets' tasks information.
hosCarrier	Hours of Service Carriers.
hosEvent	Driver's E-log event records.
hosInspection	Driver vehicle inspection reports.
icon	Icon information.
maintenanceJob	Historical vehicle and trailer maintenance work.
maintenanceSchedule	Recurring maintenance work for vehicles and trailers.
picture	Picture information.
placeGeneral	Place information.
providerAdvanced	Raw provider (device) data like GPS coordinates and parsed ODB-II values.
providerConfigType	Allows read-only access to the logic types for provider configuration.
providerConfiguration	Provider (device) configurations.
providerGeneral	Provider (device) information like name, notes, and selected asset.
providerScript	Allows access to Provider (device) logic scripts.
reportResult	Historical asset details like breadcrumb trails.
reportSchedule	Schedules used to automatically create report results overnight.
reportTemplate	Report configurations.
session	Access to retrieve a list of active sessions and kill sessions.
userAdvanced	User information such as permissions and group membership.
userGeneral	General user information such as name, contact information, and preferences.
userGroup	Group information for easy access control.

UserMeasurementPreference enum (string)

Exposes the different kinds of measurement system we can use.

Values
Value	Description
british	Use British Standard always.
metric	Use metric always.
native	Show the measurements in the local format.
standard	Use US Standard always.

UserNotificationsMethod enum (string)

Exposes the different kinds of notification methods we can use.

Values
Value	Description
email	Send an Email
popup	Show a pop-up message in the Fleet Freedom UI
sms	Send an SMS message

White Labelling

ColourStyle class

Definition of a colour pair for colouring and outlining.

Usage

var object = new trakit.fleetfreedom.ColourStyle(/** Company */ company, /** trakit.socket.ColourStyle */ object);

Properties
Property	Type	Description
fill	string	Hex colour value for fills and backgrounds.
stroke	string	Hex colour value for text and outlines.

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

CompanyReseller class

Defines the seller company's details for white-labelling.

Usage

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

Properties
Property	Type	Description
company	Company	The Company that is the reseller.
contactInfo	Dictionary.<string, number>	A list of Contacts for company specific things like Technical Support, Billing, etc...
domain	string	The domain to the instance of v4. It does not contain the protocol because all instances are required to be HTTPS.
favourite	string	The name of the image uploaded as the icon (for bookmarks).
gamut	Dictionary.<string, ColourStyle>	Colours used as templates for status tags, labels, and places.
graphics	Dictionary.<string, string>	A list of symbol names and their corresponding FontAwesome icon names.
icon	string	The name of the image uploaded as the logo (for mobile).
languages	Array.<string>	A list of supported languages for your customers.
logo	string	The name of the image uploaded as the logo.
notifyEmail	NotificationServerEmail	The server used for notification and conversational email messages sent and received by the system.
notifySms	NotificationServerSms	Definition for load-balanced outbound SMS numbers for the reseller.
recoverBody	string	The body of the email sent to a user requesting a password reset.
recoverIsHtml	string	When true, sends the password reset email as an HTML email instead of plain text.
recoverSubject	string	The subject of the email sent to a user requesting a password reset.
serviceName	string	The name of the branded service being provided to the seller's customers.
termsPreamble	string	A preamble to the general terms and conditions offered by Fleet Freedom.
termsUpdated	Date	The date and time when the terms were updated. This will promt users who are logging-in to re-agree to the new terms
version	Array.<number>	The version flag used to ensure sync operations are done in order.
website	Dictionary.<string, string>	Themed colours used in the web-based UI.

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

NotificationServerEmail class

The server used for notification and conversational email messages sent and received by the system.

Usage

var object = /** CompanyReseller */ companyresellerInstance.fromJSON(/** trakit.socket.CompanyReseller */ json);

Properties
Property	Type	Description
incomingAddress	string	The domain or IP address of the incoming email server.
incomingLogin	string	The username used to login to the incoming email server.
incomingMessageNumber	number	IMAP message sequence number so only recent messages are retrieved.
incomingPort	number	The port number of the incoming email server.
incomingSecure	boolean	Is the incoming email server using a secure SSL/TLS connection (it should).
incomingType	IncomingEmailServerType	The type of incoming protocol to use (IMAP or POP3).
outgoingAddress	string	The domain or IP address of the outgoing email server.
outgoingLogin	string	The username used to login to the outgoing email server.
outgoingPort	number	The port number of the outgoing email server.
outgoingReplyTo	string	An optional field which can be set as the "sent from" and/or "reply-to" address.
outgoingSecure	boolean	Is the outgoing email server using a secure SSL/TLS connection (it should).
outgoingType	OutgoingEmailServerType	The type of outgoing protocol to use (only SMTP).
reseller	CompanyReseller	The CompanyReseller to which this object belongs

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

NotificationServerSms class

Definition for load-balanced outbound SMS numbers for the White-labelling profile.

Usage

var object = /** CompanyReseller */ companyresellerInstance.fromJSON(/** trakit.socket.CompanyReseller */ json);

Properties
Property	Type	Description
notifyLimit	CompanyReseller	A per-number/per-day limit on the amount of Notifications sent.
phoneNumbers	Dictionary.<string, Array>	All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.
reseller	CompanyReseller	The CompanyReseller to which this object belongs

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

IncomingEmailServerType enum (string)

The types of email protocols supported for incoming mail servers.

Values
Value	Description
IMAP	Internet Message Access Protocol (default)
POP3	Post Office Protocol v3

OutgoingEmailServerType enum (string)

The types of email protocols supported for sending messages.

Values
Value	Description
SMTP	Simple Mail Transfer Protocol