com.kontakt.sdk.android.common.model

Class Config

java.lang.Object

com.kontakt.sdk.android.common.model.Config

All Implemented Interfaces:

android.os.Parcelable, IConfig

public class Config
extends java.lang.Object
implements IConfig, android.os.Parcelable

Config represents configuration which Beacon device must be updated with. Once the real device becomes updated with parameters matching the Config parameters, the pending Config is removed after sending back the Config by RESTClient with applyConfig() method.

Please, consider fetching and applying Configs for Beacon once you establish connection with Beacon device.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.Builder Config Builder.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<Config>	CREATOR Parcelable CREATOR constant.
protected int	databaseId The Database id.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object object)
static Config	from(org.json.JSONObject jsonObject) Create Config instance from JSON content.
int	getDatabaseId() Gets database id.
java.lang.String	getDeviceName() Gets device name from config
java.lang.String	getDevicePassword() Gets device password from config
java.util.List<DeviceProfile>	getDeviceProfiles() Gets device profiles
java.lang.String	getDeviceUniqueId() Gets beacon unique id.
java.util.UUID	getId() Gets Config id.
java.lang.String	getInstanceId() Gets Instance Id
int	getInterval() Gets interval.
int	getMajor() Gets major.
int	getMinor() Gets minor.
java.lang.String	getNamespace() Gets Eddystone namespace
java.util.UUID	getProximityUUID() Gets proximity uUID.
int	getTxPower() Gets tx power.
java.lang.String	getUrl() Gets Eddystone Url
int	hashCode()
java.lang.Boolean	isShuffled() Checks if device is shuffled
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.os.Parcelable

describeContents

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<Config> 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. SQLiteDatabase). If you do not need to use it, ignore it during model building.

Method Detail

getId

public java.util.UUID getId()

Description copied from interface: IConfig

Gets Config id.

Specified by:

getId in interface IConfig

Returns:

the id

getDeviceUniqueId

public java.lang.String getDeviceUniqueId()

Description copied from interface: IConfig

Gets beacon unique id.

Specified by:

getDeviceUniqueId in interface IConfig

Returns:

the beacon unique id

getProximityUUID

public java.util.UUID getProximityUUID()

Description copied from interface: IConfig

Gets proximity uUID.

Specified by:

getProximityUUID in interface IConfig

Returns:

the proximity uUID

getMajor

public int getMajor()

Description copied from interface: IConfig

Gets major.

Specified by:

getMajor in interface IConfig

Returns:

the major

getMinor

public int getMinor()

Description copied from interface: IConfig

Gets minor.

Specified by:

getMinor in interface IConfig

Returns:

the minor

getTxPower

public int getTxPower()

Description copied from interface: IConfig

Gets tx power.

Specified by:

getTxPower in interface IConfig

Returns:

the tx power

getInterval

public int getInterval()

Description copied from interface: IConfig

Gets interval.

Specified by:

getInterval in interface IConfig

Returns:

the interval

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IConfig

Gets Eddystone namespace

Specified by:

getNamespace in interface IConfig

Returns:

the namespace

getInstanceId

public java.lang.String getInstanceId()

Description copied from interface: IConfig

Gets Instance Id

Specified by:

getInstanceId in interface IConfig

Returns:

the instance id

getUrl

public java.lang.String getUrl()

Description copied from interface: IConfig

Gets Eddystone Url

Specified by:

getUrl in interface IConfig

Returns:

the url

getDeviceProfiles

public java.util.List<DeviceProfile> getDeviceProfiles()

Description copied from interface: IConfig

Gets device profiles

Specified by:

getDeviceProfiles in interface IConfig

Returns:

the device profile

isShuffled

public java.lang.Boolean isShuffled()

Description copied from interface: IConfig

Checks if device is shuffled

Specified by:

isShuffled in interface IConfig

Returns:

null, true or false

getDeviceName

public java.lang.String getDeviceName()

Description copied from interface: IConfig

Gets device name from config

Specified by:

getDeviceName in interface IConfig

Returns:

the device name

getDevicePassword

public java.lang.String getDevicePassword()

Description copied from interface: IConfig

Gets device password from config

Specified by:

getDevicePassword in interface IConfig

Returns:

the device password

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

from

public static Config from(org.json.JSONObject jsonObject)

Create Config instance from JSON content.

Parameters:

jsonObject - the json object

Returns:

the config

getDatabaseId

public int getDatabaseId()

Gets database id.

Returns:

the database id

describeContents

public int describeContents()