com.swirl

Class NearbyManager

java.lang.Object

com.swirl.Manager

com.swirl.NearbyManager

public class NearbyManager
extends Manager

The NearbyManager uses the Nearby APIs to scan for beacons registered using the google beacon platform. The Nearby APIs return messages attached to beacons with many types. The NearbyManager handles these attachements in different ways.

If the Eddystone-UID namespaces are requested to be scanned, then for every Eddystone-UID message (type MESSAGE_TYPE_EDDYSTONE_UID) delivered, the NearbyManager will convert it to a corresponding Eddystone BeaconAdvertisement and broadcast that on the event bus. If the message namespace is MESSAGE_TYPE_SWIRL, the NearbyManager will convert the message to a BeaconAdvertisement using the beacon identity contained in the attchement. Finally, for all other attachment types, a NearbyMessage will be broadcast on the bus with the type and content information contained. A convenience method on SwirlListener: protected void onNearbyMessage(NearbyManager manager, String namespace, String type, byte[] content, int rssi) can be overridden to get notified when those messages arrive.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NearbyManager.NearbyMessage

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MESSAGE_TYPE_SWIRL The type string assigned to default 'swirl' attachements.

Constructor Summary

Constructors

Constructor and Description
NearbyManager(android.app.Activity activity)

Method Summary

Modifier and Type	Method and Description
NearbyManager	addEddystoneNamespace(java.lang.String namespace) Add a given Eddystone 10-digit UID to the list of monitored namespaces
NearbyManager	addNamespaceType(java.lang.String namespace, java.lang.String type) Add a given message namespace and type to the list of monitored messages
static NearbyManager	getInstance() Returns the last NearbyManager created.
void	init(android.content.Context context, EventBus events, java.util.concurrent.ScheduledExecutorService executor) Called when the manager is created to provide its execution environment.
void	onConnected(android.os.Bundle opts)
void	onConnectionFailed(ConnectionResult result)
void	onConnectionSuspended(int code)
void	onIntent(android.content.Intent intent)
void	setActivity(android.app.Activity activity) Nearby API's need to have an activity context in order to function, this can be called to provide a valid context whenever it is available or changes
NearbyManager	setFilter(MessageFilter.Builder messageFilterBuilder) Override the internal default message filters and supply your own.
void	start() This is called by the system when started or when a manager is added to a started system.
void	stop() This is called by the system when stopped.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_TYPE_SWIRL

public static final java.lang.String MESSAGE_TYPE_SWIRL

The type string assigned to default 'swirl' attachements. These attachements are added to beacons in the google beacon platform when registered through the swirl platform. These attachments allow swirl content to be served, when using Nearby for beacon detection.

See Also:

Constant Field Values

Constructor Detail

NearbyManager

public NearbyManager(android.app.Activity activity)

Method Detail

getInstance

public static NearbyManager getInstance()

Returns the last NearbyManager created. Usually there is only one. It will return null if there is no NearbyManager.

Returns:

NearbyManager

init

public void init(android.content.Context context,
                 EventBus events,
                 java.util.concurrent.ScheduledExecutorService executor)

Description copied from class: Manager

Called when the manager is created to provide its execution environment.

Parameters:

context - The application context to use

events - The EventBus that the manager is a member of

executor - The Executor to use and on which events are dispatched

addEddystoneNamespace

public NearbyManager addEddystoneNamespace(java.lang.String namespace)

Add a given Eddystone 10-digit UID to the list of monitored namespaces

Parameters:

namespace - 10-digit Eddystone namespace

addNamespaceType

public NearbyManager addNamespaceType(java.lang.String namespace,
                                      java.lang.String type)

Add a given message namespace and type to the list of monitored messages

Parameters:

namespace - project or public attachment namespace

type - attachement type

setFilter

public NearbyManager setFilter(MessageFilter.Builder messageFilterBuilder)

Override the internal default message filters and supply your own.

Parameters:

messageFilterBuilder - The filter to supply

setActivity

public void setActivity(android.app.Activity activity)

Nearby API's need to have an activity context in order to function, this can be called to provide a valid context whenever it is available or changes

Parameters:

activity - an android Context which is an Activity

onIntent

public void onIntent(android.content.Intent intent)

onConnected

public void onConnected(android.os.Bundle opts)

onConnectionSuspended

public void onConnectionSuspended(int code)

onConnectionFailed

public void onConnectionFailed(ConnectionResult result)

start

public void start()

This is called by the system when started or when a manager is added to a started system.

stop

public void stop()

This is called by the system when stopped.