Connect IQ/APIメモ/Toybox/Ant/ChannelAssignment - api_programming @ ウィキ

http://developer.garmin.com/downloads/connect-iq/monkey-c/doc/Toybox/Ant/ChannelAssignment.html

Class: Toybox::Ant::ChannelAssignment

• Since : 1.0.0

Instance Attribute Summary

(collapse)

   - (Object) channelType

   Whether the channel is to be primarily sending data (master) or receiving data(slave).
   - (Object) network

   The network the channel should operate under.

Instance Method Summary

(collapse)

   - (ChannelAssignment) initialize(c, n) constructor

   Constructor for the channel object.
   - (Boolean) isBackgroundScanEnabled

   See if background scanning is enabled for the channel assignment.
   - (Boolean) setBackgroundScan(isBackgroundScanEnabled)

   Set background scan to be enabled or disabled.

Constructor Details

• (ChannelAssignment) initialize(c, n)

Constructor for the channel object. By default disables background scanning.

Parameters:

   c (enum) —

   Channel type specifier
   n —

   Network
   [CHANNEL_TYPE_TX_NOT_RX] (Hash) —

   a customizable set of options
   [CHANNEL_TYPE_RX_NOT_TX] (Hash) —

   a customizable set of options
   [CHANNEL_TYPE_RX_ONLY] (Hash) —

   a customizable set of options
   [NETWORK_PUBLIC] (Hash) —

   a customizable set of options
   [NETWORK_PLUS] (Hash) —

   a customizable set of options
   [NETWORK_PRIVATE] (Hash) —

   a customizable set of options

Since:

   1.0.0

Instance Attribute Details

(Object) channelType

Whether the channel is to be primarily sending data (master) or receiving data(slave)

• Since : 1.0.0

(Object) network

The network the channel should operate under.

• Since : 1.0.0

Instance Method Details

(Boolean) isBackgroundScanEnabled

See if background scanning is enabled for the channel assignment.

Returns:

   (Boolean) —

   true - If background scan is enabled.

Since:

   1.2.0

• (Boolean) setBackgroundScan(isBackgroundScanEnabled)

Set background scan to be enabled or disabled. Enabling background scan can only be done on Receive Only channels.

Parameters:

   isBackgroundScanEnabled (Boolean) —

   true to enable background scan, false otherwise.

Returns:

   (Boolean) —

   true - If the background scan property was successfully set.

Since:

   1.2.0

Generated on Thu Feb 18 15:00:16 2016 by yard 0.8.7.6 (ruby-2.2.1).