com.dsi.ant

Class AntService

java.lang.Object

com.dsi.ant.AntService

public class AntService
extends java.lang.Object

This is the starting point for using the ANT API, by calling bindService() you allow communication with the ANT Radio Service.

This class provides the interface that applications use to request connections to various components of the ANT Radio Service. Unlike standard system services which are always running, the ANT Radio Service will preserve resources by only running while an application is bound to it. For this reason you must stay bound with the ANT Radio Service at all times you are using a component.

Currently available components are:

• AntChannelProvider

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AntService.Component Used internally by the API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_BIND_ANT_RADIO_SERVICE Use this as the action parameter of a binding intent get a service interface back which can be wrapped by an AntService object.
static int	SERVICE_VERSION_CODE_NOT_INSTALLED The value returned by getVersionCode(Context) if ANT Radio Service is not installed.
static int	SERVICE_VERSION_CODE_NOT_YET_KNOWN The value returned by getVersionCode(Context) if ANT Radio Service is unknown.

Constructor Summary

Constructors

Constructor and Description
AntService(IBinder binder) Creates a new AntService using the binding obtained from bindService(Context, ServiceConnection) to communicate with the ANT Radio service.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	bindService(Context bindContext, ServiceConnection conn) Connect to the ANT Radio Service, creating it if needed.
static void	displayAntSettings(Context context) Starts the ANT settings system settings activity.
AntAdapterProvider	getAdapterProvider() Provides a connection to the Adapter Provider component in the ANT Radio Service.
AntChannelProvider	getChannelProvider() Provides a connection to the Channel Provider component in the ANT Radio Service.
static int	getVersionCode(Context context) Gets the version code for ANT Radio Service.
static java.lang.String	getVersionName(Context context) Gets the version name for ANT Radio Service.
static boolean	hasAdapterProviderSupport() Used internally by the ANT API.
static boolean	hasAdapterWideConfigurationSupport() Used internally by the ANT API.
static boolean	hasContinuousScanSupport() Used internally by the ANT API.
static boolean	requiresBundle() Used internally by the ANT API.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_BIND_ANT_RADIO_SERVICE

public static final java.lang.String ACTION_BIND_ANT_RADIO_SERVICE

Use this as the action parameter of a binding intent get a service interface back which can be wrapped by an AntService object.

Since:

4.0

See Also:

Constant Field Values

SERVICE_VERSION_CODE_NOT_YET_KNOWN

public static final int SERVICE_VERSION_CODE_NOT_YET_KNOWN

The value returned by getVersionCode(Context) if ANT Radio Service is unknown.

Since:

4.7.3

See Also:

Constant Field Values

SERVICE_VERSION_CODE_NOT_INSTALLED

public static final int SERVICE_VERSION_CODE_NOT_INSTALLED

The value returned by getVersionCode(Context) if ANT Radio Service is not installed.

Since:

4.1

See Also:

Constant Field Values

Constructor Detail

AntService

public AntService(IBinder binder)

Creates a new AntService using the binding obtained from bindService(Context, ServiceConnection) to communicate with the ANT Radio service. This binding should be acquired by using ACTION_BIND_ANT_RADIO_SERVICE

Parameters:

binder - The service binding used to talk to the ANT Radio service.

Since:

4.0

Method Detail

requiresBundle

public static boolean requiresBundle()

Used internally by the ANT API. Checks if the installed version of the ANT Radio Service expects a bundle with extra data.

Returns:

True if parcels must include a bundle.

Since:

4.1

hasAdapterWideConfigurationSupport

public static boolean hasAdapterWideConfigurationSupport()

Used internally by the ANT API. Checks if the installed version of the ANT Radio Service has support for adapter wide configuration.

Returns:

True if there is support for adapter wide configuration, False if not supported or service is not bound.

Since:

4.1

hasContinuousScanSupport

public static boolean hasContinuousScanSupport()

Used internally by the ANT API. Checks if the installed version of the ANT Radio Service has support for continuous scan.

Returns:

True if there is support for continuous scan.

Since:

4.11.1

hasAdapterProviderSupport

public static boolean hasAdapterProviderSupport()

Used internally by the ANT API. Checks if the installed version of the ANT Radio Service has support for adapter provider.

Returns:

True if there is support for adapter provider.

Since:

4.7.2

bindService

public static boolean bindService(Context bindContext,
                  ServiceConnection conn)

Connect to the ANT Radio Service, creating it if needed. The function should be used in the same manner as a standard Android Context#bindService(Intent, ServiceConnection, int) call except it automatically handles the intent and flags parameters. This defines a dependency between your application and the ANT Radio Service. The given conn will receive the service object when it is created and be told if it dies and restarts. The ANT Radio Service will be considered required by the system only for as long as bindContext exists. For example, if this Context is an Activity that is stopped, the ANT Radio Service will not be required to continue running until the Activity is resumed.

This function will throw SecurityException if you do not have permission to bind to the ANT Radio Service.

Parameters:

bindContext - The context used to perform the bind

conn - The service connection to receive the binder

Returns:

If you have successfully bound to the service, true is returned; false is returned if the connection is not made so you will not receive the service object.

Throws:

java.lang.SecurityException

Since:

4.0

See Also:

Context#unbindService(ServiceConnection)

getChannelProvider

public AntChannelProvider getChannelProvider()
                                      throws RemoteException

Provides a connection to the Channel Provider component in the ANT Radio Service. Only requests the remote connection the first time, then returns a cached copy.

Returns:

A Channel Provider you may acquire ANT Channels from.

Throws:

RemoteException

Since:

4.0

getAdapterProvider

public AntAdapterProvider getAdapterProvider()
                                      throws RemoteException,
                                             UnsupportedFeatureException

Provides a connection to the Adapter Provider component in the ANT Radio Service. Only requests the remote connection the first time, then returns a cached copy.

Returns:

An Adapter Provider you may obtain hardware information from.

Throws:

RemoteException

UnsupportedFeatureException - if feature is not supported by the installed ANT Radio Service.

Since:

4.7.2

getVersionCode

public static int getVersionCode(Context context)

Gets the version code for ANT Radio Service.

Parameters:

context - The current context.

Returns:

If the context is null and the service has not yet been bound returns SERVICE_VERSION_CODE_NOT_YET_KNOWN. Otherwise, it returns the version code of the ANT Radio Service, or if the service package name does not exist in the android package info returns SERVICE_VERSION_CODE_NOT_INSTALLED.

Since:

4.1

getVersionName

public static java.lang.String getVersionName(Context context)

Gets the version name for ANT Radio Service.

Parameters:

context - The current context.

Returns:

If the context is null and the service has not yet been bound returns SERVICE_VERSION_NAME_NOT_YET_KNOWN. Otherwise, it returns the version name of the ANT Radio Service, or if the service package name does not exist in the android package info returns SERVICE_VERSION_NAME_NOT_INSTALLED.

Since:

4.1

displayAntSettings

public static void displayAntSettings(Context context)

Starts the ANT settings system settings activity.

Parameters:

context - The current context

Throws:

ActivityNotFoundException - on Android devices that do not have the ANT Android system settings built in to their firmware

Since:

4.8.1