Communicator Plugin API Version 1.9

Class Index | File Index

Classes


Class Garmin.DeviceDataType

Garmin.DeviceDataType
Defined in: GarminDevice.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Garmin.DeviceDataType(typeName, extension)
A place-holder for Garmin Device Data Type information
Method Summary
Method Attributes Method Name and Description
 
 
 
 
 
getReadFilePath(readFilePath)
 
 
getWriteFilePath(writeFilePath)
 
Returns value indicating if the device supports read access for this file type
 
return the value indicating if the device supports write access for this file type
 
setFilePath(filePath)
 
setIdentifier(identifier-)
 
setReadAccess(readAccess)
 
setReadFilePath(readFilePath)
 
 
setWriteFilePath(writeFilePath)
Class Detail
Garmin.DeviceDataType(typeName, extension)
A place-holder for Garmin Device Data Type information
Parameters:
{String} typeName
for the data type
{String} extension
file extension for the data type
Method Detail
{String} getDisplayName()
Returns:
The type/display name of this data type

{String} getFileExtension()
Returns:
The file extension of this data type

{String} getFilePath()
Returns:
The file path for this data type

{String} getIdentifier()
Returns:
The identifier for this data type

getReadFilePath(readFilePath)
Parameters:
readFilePath
- the readFilePath for this datatype

{String} getTypeName()
Returns:
The type name of this data type

getWriteFilePath(writeFilePath)
Parameters:
writeFilePath
- the readFilePath for this datatype

{Boolean} hasReadAccess()
Returns value indicating if the device supports read access for this file type
Returns:
supports read access for this file type

{Boolean} hasWriteAccess()
return the value indicating if the device supports write access for this file type
Returns:
supports write access for this file type

setFilePath(filePath)
Parameters:
filePath
- the filepath for this datatype

setIdentifier(identifier-)
Parameters:
identifier-
the identifier for this datatype

setReadAccess(readAccess)
Parameters:
readAccess
True == has read access

{String} setReadFilePath(readFilePath)
Parameters:
readFilePath
Returns:
The read file path for this data type

setWriteAccess(has)
Parameters:
{Boolean} has
write access

{String} setWriteFilePath(writeFilePath)
Parameters:
writeFilePath
Returns:
The write file path for this data type

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Jul 25 2011 09:36:50 GMT-0700 (MST)