Wahoo Fitness API  3.6.1
Documentation for the iPhone version of the Wahoo Fitness API.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
WFAntFSClientBase Class Reference

Represents the base class for ANT FS Client implementations. More...

#import <WFAntFSClientBase.h>

+ Inheritance diagram for WFAntFSClientBase:
+ Collaboration diagram for WFAntFSClientBase:

Instance Methods

(BOOL- addFITFile:
 Adds the specified FIT file to the directory which will be available from the client for download. More...
 
(BOOL- closeBeacon
 Closes the ANT FS Client beacon. More...
 
(BOOL- openBeacon
 Opens the ANT FS Client beacon. More...
 
(BOOL- specifySettings:
 Creates a FIT settings file based on the specified parameters. More...
 
(BOOL- startAntFSClient
 Starts the ANT FS Client. More...
 

Properties

id< WFAntFSDeviceDelegatedelegate
 Gets or sets the instance which will handle delegated methods for the WFAntFSDevice. More...
 

Detailed Description

Represents the base class for ANT FS Client implementations.

Method Documentation

- (BOOL) addFITFile: (NSString *)  filePath

Adds the specified FIT file to the directory which will be available from the client for download.

The ANT FS Client will expose a directory of files available for download. The directory is populated via this method, or implicitly through the specifySettings: method.

Parameters
filePathThe path to the FIT file to be added.
Returns
TRUE if the file was added, otherwise FALSE.
- (BOOL) closeBeacon

Closes the ANT FS Client beacon.

Returns
TRUE if the beacon was closed, otherwise FALSE.
- (BOOL) openBeacon

Opens the ANT FS Client beacon.

Returns
TRUE if the beacon was opened, otherwise FALSE.
- (BOOL) specifySettings: (WFFitnessEquipmentSettings_t *)  pstSettings

Creates a FIT settings file based on the specified parameters.

A SETTINGS type FIT file will be created and added to the directory of files available for download from the ANT FS Client.

Parameters
pstSettingsA pointer to a WFFitnessEquipmentSettings_t structure containing the settings.
Returns
TRUE if the settings file was created, otherwise FALSE.
- (BOOL) startAntFSClient

Starts the ANT FS Client.

Returns
TRUE if the ANT FS Client was started, otherwise FALSE.

Property Documentation

- (id<WFAntFSDeviceDelegate>) delegate
readwritenonatomicretaininherited

Gets or sets the instance which will handle delegated methods for the WFAntFSDevice.

Note
The WFAntFSDeviceDelegate protocol defines common functionallity for all types of ANT FS devices. The WFAntFileManagerDelegate and WFAntFSClientDelegate protocols extend this protocol for the specific FS mode. The delegate property should be set to a delegate of the appropriate specific protocol for the mode. As of API v2.1.3, this would be WFAntFileManagerDelegate for ANT FS devices using host mode, and WFAntFSClientDelegate for client mode devices.