com.kontakt.sdk.android.common.model

Class Beacon

java.lang.Object

com.kontakt.sdk.android.common.model.Device

com.kontakt.sdk.android.common.model.Beacon

All Implemented Interfaces:

IBeacon, IDevice

public class Beacon
extends Device
implements IBeacon

Beacon model represents JSON model of Beacon device with kontakt.io logic applied.

Beacon is a property of a Manager (Manager). It acts also as a container for Actions and may be assigned to certain Venue (Venue). Beacon is obtainable via REST Client. Please, note that there is also Beacon class representing real Beacon device that appears immediately once it is detected by Android Device' BluetoothAdapter (android.bluetooth.BluetoothAdapter).

By convention this model is fully immutable. To create new instance of the model, please use the Beacon.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Beacon.Builder The type Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR Parcelable CREATOR constant.
protected int	databaseId The Database id.

Constructor Summary

Constructors

Constructor and Description
Beacon(Beacon.Builder builder) Instantiates a new Beacon model.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
static Beacon	from(JSONObject jsonObject) Creates new instance of Beacon from JSON content.
int	getDatabaseId() Gets database id.
java.lang.String	getSecureNamespace() Gets secure namespace
java.util.UUID	getSecureProximityUUID() Gets secure proximity uuid
boolean	isShuffled() Checks if device is shuffled
protected void	parcelProperties(Bundle bundle)

Methods inherited from class com.kontakt.sdk.android.common.model.Device

calculateHashCode, equals, fromList, getAccess, getActionsCount, getAlias, getDeviceProfiles, getDeviceType, getFirmwareVersion, getId, getInstanceId, getInterval, getLatitude, getLongitude, getMacAddress, getMajor, getManagerId, getMinor, getModel, getName, getNamespace, getProximityUUID, getSpecification, getTxPower, getUniqueId, getUrl, getVenue, hashCode, writeToParcel

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kontakt.sdk.android.common.model.IBeacon

getActionsCount, getAlias, getId, getInterval, getManagerId, getName, getTxPower, getUniqueId, getVenue

Field Detail

CREATOR

public static final <any> CREATOR

Parcelable CREATOR constant. This model may be put into Bundle once you decide to save its state. However, please be aware of some limitations.

• There may be situations in which parent object may contain a member holding reference to the parent object in its member. Once such object is parceled, every child will be recreated with its member set to null. This limitation prevents from infinite parceling recursion causing StackOverflowError
• Every model that contains FileData as its member will be recreated with this member set to null. Please organise the access to the data in different way.

For more information concerning parceling see attached links.

See Also:

Android SDK documentation - Parcelable, Android SDK documentation - Activity.onSaveInstanceState(android.os.Bundle) method, Android SDK documentation - Bundle

databaseId

protected final int databaseId

The Database id. The database Id was introduced once you decide to persist your model in local storage (e.g. android.database.sqlite.SQLiteDatabase). If you do not need to use it, ignore it during model building.

Constructor Detail

Beacon

public Beacon(Beacon.Builder builder)

Instantiates a new Beacon model.

Parameters:

builder - Beacon builder

Method Detail

isShuffled

public boolean isShuffled()

Description copied from interface: IDevice

Checks if device is shuffled

Specified by:

isShuffled in interface IDevice

Returns:

true or false

getSecureProximityUUID

public java.util.UUID getSecureProximityUUID()

Description copied from interface: IDevice

Gets secure proximity uuid

Specified by:

getSecureProximityUUID in interface IDevice

Returns:

uuid

getSecureNamespace

public java.lang.String getSecureNamespace()

Description copied from interface: IDevice

Gets secure namespace

Specified by:

getSecureNamespace in interface IDevice

Returns:

the secure namespace

parcelProperties

protected void parcelProperties(Bundle bundle)

Specified by:

parcelProperties in class Device

from

public static Beacon from(JSONObject jsonObject)

Creates new instance of Beacon from JSON content. The raw content may be obtained via REST Client.

Parameters:

jsonObject - the json object with content

Returns:

the beacon instance

getDatabaseId

public int getDatabaseId()

Gets database id.

Returns:

the database id

describeContents

public int describeContents()