Communicator Plugin API Version 1.10

Class Index | File Index

Classes


Class Garmin.Device

Garmin.Device
Defined in: GarminDevice.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Garmin.Device(displayName, number)
A place-holder for Garmin device information.
Method Summary
Method Attributes Method Name and Description
 
addChild(child)
Add a child device
 
Adds a data type to the list of data types supported by this device
 
The array of child devices
 
A description of the device.
 
getDeviceDataType(extension)
Returns a specific DeviceDataType object
 
Returns a hash containing all DeviceDataType objects
<static>  
Garmin.Device.getDisplayName()
The display name of this device.
 
The device id
 
The device number that the plug-in uses to identify this device
 
The parent device object, null if this device has no parent.
 
The parent device's number.
 
The part number of the device
 
The software version currently on the device
 
Check if device is a File-based device.
 
Set description of the device
 
setId(device)
set device id
 
Set if device is a File-based device.
 
setParent(parent)
Set parent device
 
Set parent device number
 
Set part number of device
 
Software version installed on device
 
Returns true if the device has read support for the file type
 
Check if device has write support for the file type.
Class Detail
Garmin.Device(displayName, number)
A place-holder for Garmin device information.
Parameters:
{String} displayName
for the device
{Number} number
of the model
Method Detail
addChild(child)
Add a child device
Parameters:
{Garmin.Device} child
object

addDeviceDataType(dataType)
Adds a data type to the list of data types supported by this device
Parameters:
dataType
A DeviceDataType object containing information about the data type being added

{Array} getChildren()
The array of child devices
Returns:
{Array} of Garmin.Device objects

{String} getDescription()
A description of the device. This usually represents the model name of the device and includes the software version, i.e. "Forerunner 405 Jun 27 2008 2.17" In the GarminDevice XML, this is Model > Description.
Returns:
device description

{Garmin.DeviceDataType} getDeviceDataType(extension)
Returns a specific DeviceDataType object
Parameters:
extension
The file extension of the data type you are trying to get
Returns:
The DeviceDataType object containing the specified extension

{Hash} getDeviceDataTypes()
Returns a hash containing all DeviceDataType objects
Returns:
all DeviceDataType objects

<static> {String} Garmin.Device.getDisplayName()
The display name of this device.
Returns:
display name

{String} getId()
The device id
Returns:
The device id

{Number} getNumber()
The device number that the plug-in uses to identify this device
Returns:
device number

{Garmin.Device} getParent()
The parent device object, null if this device has no parent.
Returns:
{Garmin.Device} parent device

{Number} getParentNumber()
The parent device's number. -1 if this device has no parent.
Returns:
{Number} parent device number

{String} getPartNumber()
The part number of the device
Returns:
The part number of the device

{String} getSoftwareVersion()
The software version currently on the device
Returns:
software version

{Boolean} isFileBased()
Check if device is a File-based device. Will return false for all devices on plug-in versions prior to 2.8.1.0
Returns:
{Boolean} true if device is file based
See:
Garmin.DevicePlugin#isDeviceFileBased

setDescription(device)
Set description of the device
Parameters:
{String} device
description

setId(device)
set device id
Parameters:
{String} device
id

setIsFileBased(set)
Set if device is a File-based device.
Parameters:
{Boolean} set
if device is file based

setParent(parent)
Set parent device
Parameters:
{Garmin.Device} parent
device object

setParentNumber(parent)
Set parent device number
Parameters:
{Number} parent
device number

setPartNumber(part)
Set part number of device
Parameters:
{String} part
number

setSoftwareVersion()
Software version installed on device
Parameters:
{String} Garmin.Device

{Boolean} supportDeviceDataTypeRead(extension)
Returns true if the device has read support for the file type
Parameters:
{String} extension
The extension of the file type you are checking for support
Returns:
read support for the file type

{Boolean} supportDeviceDataTypeWrite(extension)
Check if device has write support for the file type.
Parameters:
{String} extension
The extension of the file type you are checking for support
Returns:
True if write support

Documentation generated by JsDoc Toolkit 2.3.2 on Fri Jan 10 2014 09:48:22 GMT-0700 (MST)