Package com.blukii.sdk.info

Class BlukiiInfo

java.lang.Object

com.blukii.sdk.info.BlukiiInfo

public final class BlukiiInfo
extends Object

Main controller class of package info, for interacting with blukii Manager Info CMS (see manager.blukii.com)

BlukiiClient class contains discovery functions as follows:

• Request for getting blukii Info output data.
• Reporting of blukii Info clicks.
• Reporting of blukii Info violations.

Note: These functions needs to set an developers API key by (@see BlukiiCloud.setApiKey(String)). Settings of credentials and user login is not needed for BlukiiInfo functions.

Additionally, 'android.permission.INTERNET' has to be declared as 'user-permission' in your apps manifest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BlukiiInfo.OnGetInfoBundlesListener	Listener for callbacks of function getInfoBundles(List, OnGetInfoBundlesListener).
static interface	BlukiiInfo.OnGetInfoDataListener	Listener for callbacks of function getInfoData(List, OnGetInfoDataListener).
static interface	BlukiiInfo.OnReportListener	Listener for callbacks of function reportClick(String, long, OnReportListener) and reportInfoViolation(InfoData, String, String, String, String, OnReportListener).

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INFODATA_CACHETIMEOUT_DEFAULT	Default cache timeout: 180000 milliseconds (30 minutes).
static final String	OUTPUTLANGUAGE_ENGLISH	Output language id for English
static final String	OUTPUTLANGUAGE_FRENCH	Output language id for French
static final String	OUTPUTLANGUAGE_GERMAN	Output language id for German

Method Summary

Modifier and Type	Method	Description
static String	convertBarCodeToBlukiiId(String barCode)	Converts a numbered barcode string into the blukii ID format.
static String	convertNfcToBlukiiId(String nfcCode)	Converts a NFC Code into the blukii ID format.
static List<String>	extractBlukiiIds(List<DiscoveryData> discoveryDataList)	Static helper for extracting all blukii IDs out of a list of DiscoveryData objects, as it is retrieved by BlukiiiClient discovery (see BlukiiClient.OnDiscoveryListener.onDiscoveryResult(List)).
void	getInfoBundles(List<String> infoBundleIds, BlukiiInfo.OnGetInfoBundlesListener listener)	Request to blukii Manager Info CMS for retrieving info bundles data of a list ob bundle IDs.
void	getInfoData(List<String> blukiiIds, BlukiiInfo.OnGetInfoDataListener listener)	Request to blukii Manager Info CMS for retrieving output data of a list of blukii IDs.
int	getInfoDatacacheTimeout()	Gets the timeout for the resolver cache.
void	reportClick(String blukiiId, long timeStamp, BlukiiInfo.OnReportListener listener)	Reports to blukii Manager Info CMS that a blukii Info has been clicked by user.
void	reportInfoViolation(InfoData infoData, String language, String senderName, String senderEmail, String messageText, BlukiiInfo.OnReportListener listener)	Reports a blukii Info to blukii Manager Info CMS support if the blukii Info data violates copyright laws or contains any not allowed content.
void	setInfoDatacacheTimeout(int infoDatacacheTimeout)	Gets the timeout for the resolver cache.

Methods inherited from class java.lang.Object

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

Field Details

OUTPUTLANGUAGE_ENGLISH

public static final String OUTPUTLANGUAGE_ENGLISH

Output language id for English

See Also:

• InfoData.getOutputDataList()
• InfoBundleData.getOutputDataList()
• Constant Field Values

OUTPUTLANGUAGE_FRENCH

public static final String OUTPUTLANGUAGE_FRENCH

Output language id for French

See Also:

• InfoData.getOutputDataList()
• InfoBundleData.getOutputDataList()
• Constant Field Values

OUTPUTLANGUAGE_GERMAN

public static final String OUTPUTLANGUAGE_GERMAN

Output language id for German

See Also:

• InfoData.getOutputDataList()
• InfoBundleData.getOutputDataList()
• Constant Field Values

INFODATA_CACHETIMEOUT_DEFAULT

public static final int INFODATA_CACHETIMEOUT_DEFAULT

Default cache timeout: 180000 milliseconds (30 minutes).

Relevant for getInfoData(List, OnGetInfoDataListener)

See Also:

• getInfoDatacacheTimeout()
• setInfoDatacacheTimeout(int)
• Constant Field Values

Method Details

getInfoDatacacheTimeout

public int getInfoDatacacheTimeout()

Gets the timeout for the resolver cache.

Relevant for getInfoData(List, OnGetInfoDataListener)

You can use this feature to minimize network traffic by caching retrieved values. If InfoData is found for one blukii id the next network request will be done again only after cache timeout.

If value is 0, cache is off.

Returns:

timeout for resolver cache in milliseconds as integer

See Also:

• setInfoDatacacheTimeout(int)
• INFODATA_CACHETIMEOUT_DEFAULT
• getInfoData(List, OnGetInfoDataListener)

setInfoDatacacheTimeout

public void setInfoDatacacheTimeout(int infoDatacacheTimeout)

Gets the timeout for the resolver cache.

You can use this feature to minimize network traffic by caching retrieved values. If InfoData is found for one blukii id the next network request will be done again only after cache timeout.

If value is 0, cache is off.

Parameters:

infoDatacacheTimeout - cache timeout in milliseconds, default is INFODATA_CACHETIMEOUT_DEFAULT

See Also:

• getInfoDatacacheTimeout()
• INFODATA_CACHETIMEOUT_DEFAULT
• getInfoData(List, OnGetInfoDataListener)

getInfoData

@RequiresPermission("android.permission.INTERNET")
public void getInfoData(@NonNull
 List<String> blukiiIds,
 @NonNull
 BlukiiInfo.OnGetInfoDataListener listener)

Request to blukii Manager Info CMS for retrieving output data of a list of blukii IDs.

The blukiiIds must follow the blukii Id format like 'blukii BXXXXX 1234567890AB'

If request is successful, callback BlukiiInfo.OnGetInfoDataListener.onGetInfoData(List, boolean) is called, otherwise an error response is called to callback BlukiiInfo.OnGetInfoDataListener.onError(BlukiiCloudError).

Please find the following static helper functions for extracting or converting blukii IDs.

• extractBlukiiIds(List)
• convertBarCodeToBlukiiId(String)
• convertNfcToBlukiiId(String)

Parameters:

blukiiIds - list of blukii IDs

listener - listener for BlukiiInfo.OnGetInfoDataListener callbacks.

See Also:

• BlukiiInfo.OnGetInfoDataListener
• getInfoDatacacheTimeout()
• extractBlukiiIds(List)
• convertBarCodeToBlukiiId(String)
• convertNfcToBlukiiId(String)

getInfoBundles

@RequiresPermission("android.permission.INTERNET")
public void getInfoBundles(@NonNull
 List<String> infoBundleIds,
 @NonNull
 BlukiiInfo.OnGetInfoBundlesListener listener)

Request to blukii Manager Info CMS for retrieving info bundles data of a list ob bundle IDs.

Bundle IDs are encoded and can be read from and InfoData object via InfoData.getBundleList(), if the corresponding info is part of at least one info bundle.

If request is successful, callback BlukiiInfo.OnGetInfoBundlesListener.onGetInfoBundles(List, boolean) is called, otherwise an error response is called to callback BlukiiInfo.OnGetInfoBundlesListener.onError(BlukiiCloudError).

Parameters:

infoBundleIds - list of bundle IDs

listener - listener for BlukiiInfo.OnGetInfoBundlesListener callbacks.

See Also:

• BlukiiInfo.OnGetInfoBundlesListener
• getInfoDatacacheTimeout()

reportInfoViolation

@RequiresPermission("android.permission.INTERNET")
public void reportInfoViolation(@NonNull
 InfoData infoData,
 @NonNull
 String language,
 @NonNull
 String senderName,
 @NonNull
 String senderEmail,
 @NonNull
 String messageText,
 @NonNull
 BlukiiInfo.OnReportListener listener)

Reports a blukii Info to blukii Manager Info CMS support if the blukii Info data violates copyright laws or contains any not allowed content.

Parameters:

infoData - InfoData object, retrieved by getInfoData(List, OnGetInfoDataListener)

language - language id of the violated output (see InfoData.getOutputDataList())

senderName - Name of person who sends the report

senderEmail - Email of person who sends the report

messageText - Message text that describes the violation

listener - listener for BlukiiInfo.OnReportListener callbacks

See Also:

• BlukiiInfo.OnReportListener

reportClick

@RequiresPermission("android.permission.INTERNET")
public void reportClick(@NonNull
 String blukiiId,
 long timeStamp,
 @NonNull
 BlukiiInfo.OnReportListener listener)

Reports to blukii Manager Info CMS that a blukii Info has been clicked by user.

Parameters:

blukiiId - blukii id of the Info that has been clicked

timeStamp - time of click

listener - listener for BlukiiInfo.OnReportListener callbacks

extractBlukiiIds

public static List<String> extractBlukiiIds(@NonNull
 List<DiscoveryData> discoveryDataList)

Static helper for extracting all blukii IDs out of a list of DiscoveryData objects, as it is retrieved by BlukiiiClient discovery (see BlukiiClient.OnDiscoveryListener.onDiscoveryResult(List)).

Parameters:

discoveryDataList - list of DiscoveryData objects

Returns:

list of blukii IDs

convertBarCodeToBlukiiId

public static String convertBarCodeToBlukiiId(String barCode)

Converts a numbered barcode string into the blukii ID format.

The following formats can be converted:

• EAN-8
• EAN-13
• UPC-A
• PZN-7 (must start with '-')
• PZN-8 (must start with '-')

Parameters:

barCode - numbered barcode string

Returns:

blukii ID, null if not supported barcode format

convertNfcToBlukiiId

public static String convertNfcToBlukiiId(String nfcCode)

Converts a NFC Code into the blukii ID format.

The NFC code must contain the NFC tag's mac address as hex string.

Parameters:

nfcCode - NFC hex string

Returns:

blukii ID, null if NFC hex string is not valid