com.kontakt.sdk.android.ble.security.auth

Class AuthToken

java.lang.Object

com.kontakt.sdk.android.ble.security.auth.AuthToken

public class AuthToken
extends java.lang.Object

AuthToken is used to authorize with beacons with firmwares 4.0 or higher and beacons pro.
This authorization is required before conducting some of the operations.

AuthToken can be obtained in 2 ways. Using Kontakt Cloud (recommended!) and offline - by providing device's password. The latter is not recommended as it may desynchronize beacon with the cloud and should only be used if one knows what he is doing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthToken.AuthTokenCallback Used to provide AuthToken when requesting from Kontakt Cloud.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPassword()
java.lang.String	getToken()
java.lang.String	getUniqueId()
static AuthToken	obtain(java.lang.String password) Used to obtain AuthToken by providing beacon's password.
static void	obtain(java.lang.String uniqueId, AuthToken.AuthTokenCallback callback) Used to obtain AuthToken by requesting it from Kontakt Cloud.
static void	obtain(java.lang.String uniqueId, KontaktCloud kontaktCloud, AuthToken.AuthTokenCallback callback) Used to obtain AuthToken by requesting it from Kontakt Cloud.

Methods inherited from class java.lang.Object

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

Method Detail

obtain

public static void obtain(java.lang.String uniqueId,
                          AuthToken.AuthTokenCallback callback)

Used to obtain AuthToken by requesting it from Kontakt Cloud.
This is recommended and safe way of obtaining AuthTokens.

This method creates KontaktCloud instance implicitly. If you already have an instance you can use obtain(String, KontaktCloud, AuthTokenCallback) method.

Parameters:

uniqueId - Beacon's unique id

callback - AuthToken.AuthTokenCallback instance.

obtain

public static void obtain(java.lang.String uniqueId,
                          KontaktCloud kontaktCloud,
                          AuthToken.AuthTokenCallback callback)

Used to obtain AuthToken by requesting it from Kontakt Cloud.
This is recommended and safe way of obtaining AuthTokens.

Parameters:

uniqueId - Beacon's unique id

callback - AuthToken.AuthTokenCallback instance.

obtain

public static AuthToken obtain(java.lang.String password)

Used to obtain AuthToken by providing beacon's password.
WARNING! This should only be used in special cases as offline authorization may desynchronize the beacon with Kontakt Cloud. Always obtain AuthToken by communicating with KontaktCloud when possible.

Parameters:

password - Beacon's password

Returns:

AuthToken object

getUniqueId

public java.lang.String getUniqueId()

getToken

public java.lang.String getToken()

getPassword

public java.lang.String getPassword()