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
<WFAntFSClientDelegate> Protocol Reference

Defines the interface for callback methods used by the WFAntFSClientBase. More...

#import <WFAntFSClientDelegate.h>

+ Inheritance diagram for <WFAntFSClientDelegate>:
+ Collaboration diagram for <WFAntFSClientDelegate>:

Instance Methods

(void) - antFSClient:connectedDevice:
 Invoked when the ANT FS Client has connected to a host. More...
 
(void) - antFSClient:encounteredError:
 Invoked when the ANT FS Client encounters an error. More...
 
(void) - antFSClient:receivedResponse:
 Invoked when the ANT FS Client receives a response from the ANT device. More...
 
(void) - antFSDevice:instanceCreated:
 Invoked when the WFAntFSDevice instance has been created. More...
 

Detailed Description

Defines the interface for callback methods used by the WFAntFSClientBase.

Note
This protocol inherits methods of the WFAntFSDeviceDelegate protocol.

Method Documentation

- (void) antFSClient: (WFAntFSClientBase *)  fsClient
connectedDevice: (BOOL bAuthenticated 
optional

Invoked when the ANT FS Client has connected to a host.

Parameters
fsClientThe WFAntFSClientBase instance.
bAuthenticatedTRUE if the host has authenticated, otherwise FALSE.
- (void) antFSClient: (WFAntFSClientBase *)  fsClient
encounteredError: (WFAntFSClientError_t error 
optional

Invoked when the ANT FS Client encounters an error.

Parameters
fsClientThe WFAntFSClientBase instance.
errorA WFAntFSClientError_t value indicating the type of error.
- (void) antFSClient: (WFAntFSClientBase *)  fsClient
receivedResponse: (ANTFS_RESPONSE responseCode 
optional

Invoked when the ANT FS Client receives a response from the ANT device.

Parameters
fsClientThe WFAntFSClient instance.
responseCodeAn ANTFS_RESPONSE value indicating the type of response.
- (void) antFSDevice: (WFAntFSDevice *)  fsDevice
instanceCreated: (BOOL bSuccess 
requiredinherited

Invoked when the WFAntFSDevice instance has been created.

See the requestAntFSDevice:toDelegate: (WFHardwareConnector(AntFS)) method for documentation regarding instantiating a WFAntFSDevice.

Note
This method is REQUIRED for classes adopting the WFAntFSDeviceDelegate protocol.
Parameters
fsDeviceThe WFAntFSDevice instance. This instance is passed as the base class WFAntFSDevice. As this base class does not define functionallity useful to the application, the reference should be cast to the specific type appropriate for the WFAntFSDeviceType_t requested. For example, if WF_ANTFS_DEVTYPE_GARMIN_FR310 was specified in the requestAntFSDevice:toDelegate: (WFHardwareConnector(AntFS)) call, the specific type of the instance returned is WFGarminFR310Manager.
bSuccessTRUE if the instance was created, otherwise FALSE.