com.dsi.ant.plugins.antplus.pcc

Class AntPlusWatchDownloaderPcc

java.lang.Object

com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

com.dsi.ant.plugins.antplus.pcc.AntPlusWatchDownloaderPcc

public class AntPlusWatchDownloaderPcc
extends AntPluginPcc

Enables communication between a client and the WatchDownloader plugin service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AntPlusWatchDownloaderPcc.DeviceInfo Device information, used in available devices list and making requests
static class	AntPlusWatchDownloaderPcc.DeviceListUpdateCode Defines the codes explaining the changes occurring to the device list received by the AntPlusWatchDownloaderPcc.IAvailableDeviceListReceiver.
static interface	AntPlusWatchDownloaderPcc.IAvailableDeviceListReceiver Receiver for the AvailableDeviceList event, which is: Broadcasts the current list of devices available to connect to along with information identifying any change since the last update, if applicable.
static interface	AntPlusWatchDownloaderPcc.IDownloadActivitiesFinishedReceiver Receiver for the download activity commands.
class	AntPlusWatchDownloaderPcc.IpcDefines Defines the keys and values used to communicate between the PCC and plugin.

Nested classes/interfaces inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

AntPluginPcc.IDeviceStateChangeReceiver, AntPluginPcc.IPluginAccessResultReceiver<T extends AntPluginPcc>

Field Summary

Fields inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

PATH_ANTPLUS_PLUGINS_PKG

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancelListenForNewActivities(java.util.UUID targetDeviceUUID) Cancels any listenForNewActivities commands pending for the given device for your application, or cancels all listenForNewActivities commands for all devices if UUID is null.
boolean	listenForNewActivities(java.util.UUID targetDeviceUUID, AntPlusWatchDownloaderPcc.IDownloadActivitiesFinishedReceiver downloadActivitiesFinishedReceiver, FitFileCommon.IFitFileDownloadedReceiver fitFileDownloadedReceiver) Submits a request to download all new activities from the target device until the request is cancelled.
void	requestCurrentDeviceList() Requests the current device list.
static PccReleaseHandle<AntPlusWatchDownloaderPcc>	requestDeviceListAccess(Context bindToContext, AntPluginPcc.IPluginAccessResultReceiver<AntPlusWatchDownloaderPcc> resultReceiver, AntPluginPcc.IDeviceStateChangeReceiver stateReceiver, AntPlusWatchDownloaderPcc.IAvailableDeviceListReceiver availableDeviceListRecevier) Send a request to the plugin for access to receive device list updates and make requests.
boolean	requestDownloadAllActivities(java.util.UUID targetDeviceUUID, AntPlusWatchDownloaderPcc.IDownloadActivitiesFinishedReceiver downloadActivitiesFinishedReceiver, FitFileCommon.IFitFileDownloadedReceiver fitFileDownloadedReceiver, AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier) Requests a download of all activities from the device.
boolean	requestDownloadNewActivities(java.util.UUID targetDeviceUUID, AntPlusWatchDownloaderPcc.IDownloadActivitiesFinishedReceiver downloadActivitiesFinishedReceiver, FitFileCommon.IFitFileDownloadedReceiver fitFileDownloadedReceiver, AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier) Requests a download of all new activities from the device.

Methods inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

getAntDeviceNumber, getCurrentDeviceState, getDeviceName, getInstalledPluginsVersionNumber, getInstalledPluginsVersionString, getMissingDependencyName, getMissingDependencyPackageName, isUserPreferredDeviceForPlugin, isUserRecognizedDevice, releaseAccess, startPluginManagerActivity

Methods inherited from class java.lang.Object

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

Method Detail

requestDeviceListAccess

public static PccReleaseHandle<AntPlusWatchDownloaderPcc> requestDeviceListAccess(Context bindToContext,
                                                                  AntPluginPcc.IPluginAccessResultReceiver<AntPlusWatchDownloaderPcc> resultReceiver,
                                                                  AntPluginPcc.IDeviceStateChangeReceiver stateReceiver,
                                                                  AntPlusWatchDownloaderPcc.IAvailableDeviceListReceiver availableDeviceListRecevier)

Send a request to the plugin for access to receive device list updates and make requests.

Parameters:

bindToContext - The context to which the plugin will be bound. Used for plugin lifecycle management.

resultReceiver - The receiver to receive the results of the request. Possible returns include:

• RequestAccessResult.SUCCESS
• RequestAccessResult.USER_CANCELLED
• RequestAccessResult.CHANNEL_NOT_AVAILABLE
• RequestAccessResult.BAD_PARAMS
• RequestAccessResult.ADAPTER_NOT_DETECTED
• RequestAccessResult.DEPENDENCY_NOT_INSTALLED
• RequestAccessResult.OTHER_FAILURE

stateReceiver - The receiver to receive the state updates of the accessed device, if successful. This receiver will receive notifications of all state changes to the device that occur subsequent to the initial state returned in the result receiver.

availableDeviceListRecevier - Receives the available device list and updates to that list. Call requestCurrentDeviceList() after receiving access to get the current list.

Returns:

A release handle for the device. This can be used to guarantee the device is properly shutdown and cleaned up, even before the device is actually received through the result receiver.

requestCurrentDeviceList

public void requestCurrentDeviceList()

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

requestDownloadAllActivities

public boolean requestDownloadAllActivities(java.util.UUID targetDeviceUUID,
                                   AntPlusWatchDownloaderPcc.IDownloadActivitiesFinishedReceiver downloadActivitiesFinishedReceiver,
                                   FitFileCommon.IFitFileDownloadedReceiver fitFileDownloadedReceiver,
                                   AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier)

Requests a download of all activities from the device.

Parameters:

targetDeviceUUID - The target device to make the request on.

downloadActivitiesFinishedReceiver - The receiver to receive the status of the file download.

fitFileDownloadedReceiver - The receiver to receive each downloaded file from the device as it is downloaded over ANT-FS.

antFsProgressUpdateRecevier - Optional. The receiver to receive the state updates of the ANT-FS connection or null.

Returns:

True if request was submitted successfully and you are guaranteed a result on the result receiver.

requestDownloadNewActivities

public boolean requestDownloadNewActivities(java.util.UUID targetDeviceUUID,
                                   AntPlusWatchDownloaderPcc.IDownloadActivitiesFinishedReceiver downloadActivitiesFinishedReceiver,
                                   FitFileCommon.IFitFileDownloadedReceiver fitFileDownloadedReceiver,
                                   AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier)

Requests a download of all new activities from the device.

Parameters:

targetDeviceUUID - The target device to make the request on.

downloadActivitiesFinishedReceiver - The receiver to receive the status of the file download.

fitFileDownloadedReceiver - The receiver to receive each downloaded file from the device as it is downloaded over ANT-FS.

antFsProgressUpdateRecevier - Optional. The receiver to receive the state updates of the ANT-FS connection or null.

Returns:

True if request was submitted successfully and you are guaranteed a result on the result receiver.

listenForNewActivities

public boolean listenForNewActivities(java.util.UUID targetDeviceUUID,
                             AntPlusWatchDownloaderPcc.IDownloadActivitiesFinishedReceiver downloadActivitiesFinishedReceiver,
                             FitFileCommon.IFitFileDownloadedReceiver fitFileDownloadedReceiver)

Submits a request to download all new activities from the target device until the request is cancelled. This function will cause the plugin to automatically check periodically for new activities. This function will cancel and override any existing listenForNewActivities for the target device.

Parameters:

targetDeviceUUID - The target device to make the request on.

downloadActivitiesFinishedReceiver - The receiver to receive the status of the file download.

fitFileDownloadedReceiver - The receiver to receive each downloaded file from the device as it is downloaded over ANT-FS.

Returns:

True if request was submitted successfully. False if the device UUID is not valid.

cancelListenForNewActivities

public boolean cancelListenForNewActivities(java.util.UUID targetDeviceUUID)

Cancels any listenForNewActivities commands pending for the given device for your application, or cancels all listenForNewActivities commands for all devices if UUID is null.

Parameters:

targetDeviceUUID - The target device to cancel commands for, or null to cancel all commands from your application.

Returns:

True if the target command(s) are cancelled. False if there was an error cancelling the commands.