public interface

CapabilityApi

com.google.android.gms.wearable.CapabilityApi

Class Overview

Exposes an API to learn about capabilities provided by nodes on the Wear network.

Capabilities are local to an application.

Summary

Nested Classes
interface CapabilityApi.AddLocalCapabilityResult Result returned from addLocalCapability(GoogleApiClient, String)  
interface CapabilityApi.CapabilityListener Listener for changes in the reachable nodes providing a capability. 
interface CapabilityApi.GetAllCapabilitiesResult Result returned from getAllCapabilities(GoogleApiClient, int)  
interface CapabilityApi.GetCapabilityResult Result returned from getCapability(GoogleApiClient, String, int)  
interface CapabilityApi.RemoveLocalCapabilityResult Result returned from removeLocalCapability(GoogleApiClient, String)  
Constants
int FILTER_ALL Filter type for getCapability(GoogleApiClient, String, int), getAllCapabilities(GoogleApiClient, int): If this filter is set then the full set of nodes that declare the given capability will be included in the capability's CapabilityInfo.
int FILTER_REACHABLE Filter type for getCapability(GoogleApiClient, String, int), getAllCapabilities(GoogleApiClient, int): If this filter is set then only reachable nodes that declare the given capability will be included in the capability's CapabilityInfo.
Public Methods
abstract PendingResult<Status> addCapabilityListener(GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability)
Registers a listener to be notified of capabilities being added to or removed from the Wear network.
abstract PendingResult<CapabilityApi.AddLocalCapabilityResult> addLocalCapability(GoogleApiClient client, String capability)
Announces that a capability has become available on the local node.
abstract PendingResult<CapabilityApi.GetAllCapabilitiesResult> getAllCapabilities(GoogleApiClient client, int nodeFilter)
Returns information about all capabilities, including the nodes that declare those capabilities.
abstract PendingResult<CapabilityApi.GetCapabilityResult> getCapability(GoogleApiClient client, String capability, int nodeFilter)
Returns information about a capability, including the nodes that declare that capability.
abstract PendingResult<Status> removeCapabilityListener(GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability)
Removes a listener which was previously added through addCapabilityListener(GoogleApiClient, CapabilityApi.CapabilityListener, String).
abstract PendingResult<CapabilityApi.RemoveLocalCapabilityResult> removeLocalCapability(GoogleApiClient client, String capability)
Announces that a capability is no longer available on the local node.

Constants

public static final int FILTER_ALL

Filter type for getCapability(GoogleApiClient, String, int), getAllCapabilities(GoogleApiClient, int): If this filter is set then the full set of nodes that declare the given capability will be included in the capability's CapabilityInfo.

Constant Value: 0 (0x00000000)

public static final int FILTER_REACHABLE

Filter type for getCapability(GoogleApiClient, String, int), getAllCapabilities(GoogleApiClient, int): If this filter is set then only reachable nodes that declare the given capability will be included in the capability's CapabilityInfo.

Constant Value: 1 (0x00000001)

Public Methods

public abstract PendingResult<Status> addCapabilityListener (GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability)

Registers a listener to be notified of capabilities being added to or removed from the Wear network. Calls to this method should be balanced with removeCapabilityListener(GoogleApiClient, CapabilityApi.CapabilityListener, String) to avoid leaking resources.

Callers wishing to be notified of events in the background should use WearableListenerService.

public abstract PendingResult<CapabilityApi.AddLocalCapabilityResult> addLocalCapability (GoogleApiClient client, String capability)

Announces that a capability has become available on the local node.

public abstract PendingResult<CapabilityApi.GetAllCapabilitiesResult> getAllCapabilities (GoogleApiClient client, int nodeFilter)

Returns information about all capabilities, including the nodes that declare those capabilities. The filter parameter controls whether all nodes are returned, FILTER_ALL, or only those that are currently reachable by this node, FILTER_REACHABLE.

The local node will never be returned in the set of nodes.

public abstract PendingResult<CapabilityApi.GetCapabilityResult> getCapability (GoogleApiClient client, String capability, int nodeFilter)

Returns information about a capability, including the nodes that declare that capability. The filter parameter controls whether all nodes are returned, FILTER_ALL, or only those that are currently reachable by this node, FILTER_REACHABLE.

The local node will never be returned in the set of nodes.

public abstract PendingResult<Status> removeCapabilityListener (GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability)

Removes a listener which was previously added through addCapabilityListener(GoogleApiClient, CapabilityApi.CapabilityListener, String). The listener is only removed from listening for the capability provided and will continue to receive messages for any other capabilities it was previously registered for that have not also been removed.

public abstract PendingResult<CapabilityApi.RemoveLocalCapabilityResult> removeLocalCapability (GoogleApiClient client, String capability)

Announces that a capability is no longer available on the local node. Note: this will not remove any capabilities announced in the Manifest for an app.