com.dsi.ant.plugins.antplus.pcc

Class AntPlusGeocachePcc.IpcDefines

java.lang.Object

com.dsi.ant.plugins.antplus.pcc.AntPlusGeocachePcc.IpcDefines

Enclosing class:

AntPlusGeocachePcc

public class AntPlusGeocachePcc.IpcDefines
extends java.lang.Object

Defines the keys and values used to communicate between the PCC and plugin. User code should never have to reference these defines.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_intNONCE Random or pseudo-random number from 0-65535 that will be hashed by the geocache to produce an authentication token.
static java.lang.String	MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_longSERIALNUMBER Serial number of the GPS receiver.
static java.lang.String	MSG_CMD_GEOCACHE_REQUESTDEVICEDATA_PARAM_boolUPDATEVISITCOUNT If true, notifies the plugin to update the logged visits data to include this 'visit'.
static java.lang.String	MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_boolCLEARALLEXISTINGDATA If true, all current data on the device will be erased, and the device will be programmed with only the data provided in programmingData (which therefore must include the minimum required data).
static java.lang.String	MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_longPROGRAMMINGPIN This PIN must match the current PIN on the device if it is set.
static java.lang.String	MSG_CMD_GEOCACHE_REQUESTS_PARAM_boolSUBSCRIBEPROGRESSUPDATES If true, notifies the plugin to send progress updates.
static java.lang.String	MSG_CMD_GEOCACHE_REQUESTS_PARAM_intTARGETDEVICEID The deviceID of the target device to make the request on.
static int	MSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN Requests the specified device to generate an auth token.
static int	MSG_CMD_GEOCACHE_whatREQUESTCURRENTDEVICELIST Requests the current device list.
static int	MSG_CMD_GEOCACHE_whatREQUESTDEVICEDATA Requests the data available from the specified device.
static int	MSG_CMD_GEOCACHE_whatREQUESTDEVICEPROGRAMMING Requests the plugin to program the specified device with the provided data.
static java.lang.String	MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_intSTATUSCODE The AntPlusGeocachePcc.GeocacheRequestStatus defining the result of the authentication token request.
static java.lang.String	MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_longAUTHTOKEN The authentication token sent by the device, or -1 if the request was unsuccessful.
static java.lang.String	MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayIntDEVICEIDS Devices currently available to connect to.
static java.lang.String	MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayStringDEVICEIDENTIFIERSTRINGS The character identification of devices in the current devices list.
static java.lang.String	MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGECODE A AntPlusGeocachePcc.DeviceChangingCode indicating what is changing on the list.
static java.lang.String	MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGINGDEVICEID The device ID of a device that has changed according to the changeCode or -1 if N/A for current code.
static java.lang.String	MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_bundleDOWNLOADEDDATA The complete set of data downloaded from the device or null if the download was unsuccessful.
static java.lang.String	MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_intSTATUSCODE The AntPlusGeocachePcc.GeocacheRequestStatus defining the result of the download.
static java.lang.String	MSG_EVENT_GEOCACHE_PROGRAMMINGFINISHED_PARAM_intSTATUSCODE The AntPlusGeocachePcc.GeocacheRequestStatus defining the result of the programming task.
static java.lang.String	MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intTOTALUNITSWORK The total number of work units to finish in the given task.
static java.lang.String	MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intWORKUNITSFINISHED The current number of work units finished.
static int	MSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED Receives the result of a finished authentication token request.
static int	MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST Broadcasts the current list of devices available to connect to along with information identifying any change since the last update, if applicable.
static int	MSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED Receives the result of a finished data download.
static int	MSG_EVENT_GEOCACHE_whatPROGRAMMINGFINISHED Receives the result of a finished programming task.
static int	MSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE Communicates the work done.
static int	MSG_REQACC_PARAM_MODE_iCONTINUOUSSEARCH Geocache specific parameter to request access to the geocache singleton
static java.lang.String	PATH_ANTPLUS_GEOCACHEPLUGIN_PKG The plugin package path.
static java.lang.String	PATH_ANTPLUS_GEOCACHEPLUGIN_SERVICE The plugin service path.

Constructor Summary

Constructors

Constructor and Description
AntPlusGeocachePcc.IpcDefines()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATH_ANTPLUS_GEOCACHEPLUGIN_PKG

public static final java.lang.String PATH_ANTPLUS_GEOCACHEPLUGIN_PKG

The plugin package path.

See Also:

Constant Field Values

PATH_ANTPLUS_GEOCACHEPLUGIN_SERVICE

public static final java.lang.String PATH_ANTPLUS_GEOCACHEPLUGIN_SERVICE

The plugin service path.

See Also:

Constant Field Values

MSG_REQACC_PARAM_MODE_iCONTINUOUSSEARCH

public static final int MSG_REQACC_PARAM_MODE_iCONTINUOUSSEARCH

Geocache specific parameter to request access to the geocache singleton

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST

public static final int MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST

Broadcasts the current list of devices available to connect to along with information identifying any change since the last update, if applicable.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayIntDEVICEIDS

public static final java.lang.String MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayIntDEVICEIDS

Devices currently available to connect to. Sent in the MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayStringDEVICEIDENTIFIERSTRINGS

public static final java.lang.String MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayStringDEVICEIDENTIFIERSTRINGS

The character identification of devices in the current devices list. Note: The length of this array and the indices correlate directly with the currentDevices list. Sent in the MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGECODE

public static final java.lang.String MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGECODE

A AntPlusGeocachePcc.DeviceChangingCode indicating what is changing on the list. Sent in the MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGINGDEVICEID

public static final java.lang.String MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGINGDEVICEID

The device ID of a device that has changed according to the changeCode or -1 if N/A for current code. Sent in the MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE

public static final int MSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE

Communicates the work done. The percentage of work done is 100*(workUnitsFinished/totalUnitsWork).

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intWORKUNITSFINISHED

public static final java.lang.String MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intWORKUNITSFINISHED

The current number of work units finished. Sent in the MSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intTOTALUNITSWORK

public static final java.lang.String MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intTOTALUNITSWORK

The total number of work units to finish in the given task. Sent in the MSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_whatPROGRAMMINGFINISHED

public static final int MSG_EVENT_GEOCACHE_whatPROGRAMMINGFINISHED

Receives the result of a finished programming task.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_PROGRAMMINGFINISHED_PARAM_intSTATUSCODE

public static final java.lang.String MSG_EVENT_GEOCACHE_PROGRAMMINGFINISHED_PARAM_intSTATUSCODE

The AntPlusGeocachePcc.GeocacheRequestStatus defining the result of the programming task. Sent in the MSG_EVENT_GEOCACHE_whatPROGRAMMINGFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED

public static final int MSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED

Receives the result of a finished data download.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_intSTATUSCODE

public static final java.lang.String MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_intSTATUSCODE

The AntPlusGeocachePcc.GeocacheRequestStatus defining the result of the download. Sent in the MSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_bundleDOWNLOADEDDATA

public static final java.lang.String MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_bundleDOWNLOADEDDATA

The complete set of data downloaded from the device or null if the download was unsuccessful. To see what data is present on the device iterate through the Bundle#keySet() comparing with the keys defined in AntPlusGeocachePcc.GeocacheDeviceData. Sent in the MSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED

public static final int MSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED

Receives the result of a finished authentication token request.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_intSTATUSCODE

public static final java.lang.String MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_intSTATUSCODE

The AntPlusGeocachePcc.GeocacheRequestStatus defining the result of the authentication token request. Sent in the MSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_longAUTHTOKEN

public static final java.lang.String MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_longAUTHTOKEN

The authentication token sent by the device, or -1 if the request was unsuccessful. Sent in the MSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED event.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_whatREQUESTCURRENTDEVICELIST

public static final int MSG_CMD_GEOCACHE_whatREQUESTCURRENTDEVICELIST

Requests the current device list. The list will come in on the receiver passed to AntPlusGeocachePcc#requestListAndRequestAccess(Context, IPluginAccessResultReceiver, IDeviceStateChangeReceiver, IAvailableDeviceListReceiver).

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_whatREQUESTDEVICEDATA

public static final int MSG_CMD_GEOCACHE_whatREQUESTDEVICEDATA

Requests the data available from the specified device.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_REQUESTDEVICEDATA_PARAM_boolUPDATEVISITCOUNT

public static final java.lang.String MSG_CMD_GEOCACHE_REQUESTDEVICEDATA_PARAM_boolUPDATEVISITCOUNT

If true, notifies the plugin to update the logged visits data to include this 'visit'. Devices will only be auto-updated once during any period the plugin detects it is within range regardless of how many times this flag is set, so always setting this flag to true is recommended. Sent in the MSG_CMD_GEOCACHE_whatREQUESTDEVICEDATA command.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN

public static final int MSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN

Requests the specified device to generate an auth token.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_intNONCE

public static final java.lang.String MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_intNONCE

Random or pseudo-random number from 0-65535 that will be hashed by the geocache to produce an authentication token. Sent in the MSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN command.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_longSERIALNUMBER

public static final java.lang.String MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_longSERIALNUMBER

Serial number of the GPS receiver. Sent in the MSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN command.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_whatREQUESTDEVICEPROGRAMMING

public static final int MSG_CMD_GEOCACHE_whatREQUESTDEVICEPROGRAMMING

Requests the plugin to program the specified device with the provided data. If the device is not programmed, the minimum required data must be sent in the programmingData bundle. But, if the device is already programmed, the existing data will be overwritten according to the behaviour defined by the clearAllExistingData parameter.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_longPROGRAMMINGPIN

public static final java.lang.String MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_longPROGRAMMINGPIN

This PIN must match the current PIN on the device if it is set. If the device's PIN is not set, the value of this parameter is not used.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_boolCLEARALLEXISTINGDATA

public static final java.lang.String MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_boolCLEARALLEXISTINGDATA

If true, all current data on the device will be erased, and the device will be programmed with only the data provided in programmingData (which therefore must include the minimum required data). If false, allows for partial data update where all existing non-provided data fields will be maintained on the device and only provided data fields are overwritten. If the device is not programmed this parameter is ignored. Sent in the MSG_CMD_GEOCACHE_whatREQUESTDEVICEPROGRAMMING command.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_REQUESTS_PARAM_boolSUBSCRIBEPROGRESSUPDATES

public static final java.lang.String MSG_CMD_GEOCACHE_REQUESTS_PARAM_boolSUBSCRIBEPROGRESSUPDATES

If true, notifies the plugin to send progress updates.

See Also:

Constant Field Values

MSG_CMD_GEOCACHE_REQUESTS_PARAM_intTARGETDEVICEID

public static final java.lang.String MSG_CMD_GEOCACHE_REQUESTS_PARAM_intTARGETDEVICEID

The deviceID of the target device to make the request on.

See Also:

Constant Field Values

Constructor Detail

AntPlusGeocachePcc.IpcDefines

public AntPlusGeocachePcc.IpcDefines()