Class Garmin.Device

Object
   |
   +--Garmin.Device

class Garmin.Device

Garmin.Device A place-holder for Garmin device information.
Defined in GarminDevice.js

Constructor Detail

Garmin.Device

Garmin.Device(<String> displayName, <Number> number)

Parameters:
displayName - for the device
number - of the model

__Garmin.Device.addDeviceDataType

void __Garmin.Device.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

__Garmin.Device.getDescription

String __Garmin.Device.getDescription()

Returns:
A description of the device

__Garmin.Device.getDeviceDataType

Garmin.DeviceDataType __Garmin.Device.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

__Garmin.Device.getDeviceDataTypes

Hash __Garmin.Device.getDeviceDataTypes()

Returns:
The hash containing all DeviceDataType objects

__Garmin.Device.getDisplayName

String __Garmin.Device.getDisplayName()

Returns:
The display name of this device

__Garmin.Device.getId

Number __Garmin.Device.getId()

Returns:
The device id

__Garmin.Device.getNumber

Number __Garmin.Device.getNumber()

Returns:
The device number that the plug-in uses to identify this device

__Garmin.Device.getPartNumber

String __Garmin.Device.getPartNumber()

Returns:
The part number of the device

__Garmin.Device.getSoftwareVersion

String __Garmin.Device.getSoftwareVersion()

Returns:
The software version currently on the device

__Garmin.Device.setDescription

void __Garmin.Device.setDescription(description)

__Garmin.Device.setId

void __Garmin.Device.setId(id)

__Garmin.Device.setPartNumber

void __Garmin.Device.setPartNumber(partNumber)

__Garmin.Device.setSoftwareVersion

void __Garmin.Device.setSoftwareVersion(softwareVersion)

__Garmin.Device.supportDeviceDataTypeRead

Boolean __Garmin.Device.supportDeviceDataTypeRead(extension)

Parameters:
extension - The extension of the file type you are checking for support

Returns:
True if the device has read support for the file type

__Garmin.Device.supportDeviceDataTypeWrite

Boolean __Garmin.Device.supportDeviceDataTypeWrite(extension)

Parameters:
extension - The extension of the file type you are checking for support

Returns:
True if the device has write support for the file type

addDeviceDataType

void 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

getDescription

String getDescription()

Returns:
A description of the device

getDeviceDataType

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

getDeviceDataTypes

Hash getDeviceDataTypes()

Returns:
The hash containing all DeviceDataType objects

getDisplayName

String getDisplayName()

Returns:
The display name of this device

getId

Number getId()

Returns:
The device id

getNumber

Number getNumber()

Returns:
The device number that the plug-in uses to identify this device

getPartNumber

String getPartNumber()

Returns:
The part number of the device

getSoftwareVersion

String getSoftwareVersion()

Returns:
The software version currently on the device

initialize

void initialize(displayName, number)

setDescription

void setDescription(description)

setId

void setId(id)

setPartNumber

void setPartNumber(partNumber)

setSoftwareVersion

void setSoftwareVersion(softwareVersion)

supportDeviceDataTypeRead

Boolean supportDeviceDataTypeRead(extension)

Parameters:
extension - The extension of the file type you are checking for support

Returns:
True if the device has read support for the file type

supportDeviceDataTypeWrite

Boolean supportDeviceDataTypeWrite(extension)

Parameters:
extension - The extension of the file type you are checking for support

Returns:
True if the device has write support for the file type