EMB_Item Class

retrieves the data of an item More...

Macros
#define	EMB_TYPE_ID_EMBB_OBJ   2000
	The type id that is used to distinguish the data type of an EMBB related object when it is carried in a SHI_Data object container. More...

Typedefs
typedef struct EMB_Epl	EMB_Epl
	Opaque structure for EPL. More...
typedef struct EMB_Gko	EMB_Gko
	Opaque structure for GKO. More...
typedef struct EMB_Mbb	EMB_Mbb
	Opaque structure for MBB. More...
typedef struct EMB_Item	EMB_Item
	EMBB item is an object that retrieved from EMBB Storage. More...

Enumerations
enum	EMB_ItemType {   EMB_IT_UNKNOWN = 0,   EMB_IT_EPL,   EMB_IT_GKO,   EMB_IT_MBB }
	EMBB item type. More...
enum	EMB_TargetType {   EMB_TG_NONE = 0,   EMB_TG_DEVICE,   EMB_TG_GROUP }
	EMBB target type. More...

Functions
EMB_EXPORT EMB_UInt32	EMB_Item_GetItemId (const EMB_Item *item)
	Gets the item id of the retrieved EMBB item. More...
EMB_EXPORT EMB_ByteArray	EMB_Item_GetId (const EMB_Item *item)
	Gets the id of the retrieved EMBB item. More...
EMB_EXPORT EMB_ItemType	EMB_Item_GetType (const EMB_Item *item)
	Gets the type of the retrieved EMBB item. More...
EMB_EXPORT EMB_ByteArray	EMB_Item_GetData (const EMB_Item *item)
	Gets the data of the retrieved EMBB item. More...
EMB_EXPORT EMB_UInt32	EMB_Item_GetFirstUse (const EMB_Item *item)
	Gets the "first use" date of the retrieved EMBB item. More...
EMB_EXPORT EMB_UInt32	EMB_Item_GetExpirationDate (const EMB_Item *item)
	Gets the expiration date of the retrieved EMBB item. More...
EMB_EXPORT EMB_TargetType	EMB_Item_GetTargetType (const EMB_Item *item)
	Gets the target type of the retrieved EMBB item. More...
EMB_EXPORT EMB_ByteArray	EMB_Item_GetTargetId (const EMB_Item *item)
	Gets the target id of the retrieved EMBB item. More...

Detailed Description

retrieves the data of an item

Macro Definition Documentation

EMB_TYPE_ID_EMBB_OBJ

#define EMB_TYPE_ID_EMBB_OBJ   2000

The type id that is used to distinguish the data type of an EMBB related object when it is carried in a SHI_Data object container.

Typedef Documentation

EMB_Epl

typedef struct EMB_Epl EMB_Epl

Opaque structure for EPL.

EMB_Gko

typedef struct EMB_Gko EMB_Gko

Opaque structure for GKO.

EMB_Item

typedef struct EMB_Item EMB_Item

EMBB item is an object that retrieved from EMBB Storage.

EMB_Mbb

typedef struct EMB_Mbb EMB_Mbb

Opaque structure for MBB.

Enumeration Type Documentation

EMB_ItemType

enum EMB_ItemType

EMBB item type.

EMBB item of EPL and GKO are saved into the EMBB Storage. The MBB used to remove the content-id from Wasabi License store.

Enumerator
EMB_IT_UNKNOWN	The item value type is unknown.
EMB_IT_EPL	The item value type is EPL.
EMB_IT_GKO	The item value type is GKO.
EMB_IT_MBB	The item value type is MBB.

EMB_TargetType

enum EMB_TargetType

EMBB target type.

Enumerator
EMB_TG_NONE	The target value type is none.
EMB_TG_DEVICE	The item value type is device.
EMB_TG_GROUP	The item value type is group.

Function Documentation

EMB_Item_GetData()

EMB_EXPORT EMB_ByteArray EMB_Item_GetData

(

const EMB_Item *

item

)

Gets the data of the retrieved EMBB item.

Parameters

item	Retrieved EMBB item.

Returns

A EMB_ByteArray structure containing the data of the retrieved EMBB item.

EMB_Item_GetExpirationDate()

EMB_EXPORT EMB_UInt32 EMB_Item_GetExpirationDate

(

const EMB_Item *

item

)

Gets the expiration date of the retrieved EMBB item.

Parameters

item	Retrieved EMBB item.

Returns

The expiration date expressed in number of UTC (Coordinated Universal Time) minutes since January 1, 1970 or zero if there is no expiration date.

EMB_Item_GetFirstUse()

EMB_EXPORT EMB_UInt32 EMB_Item_GetFirstUse

(

const EMB_Item *

item

)

Gets the "first use" date of the retrieved EMBB item.

If the "first use" is 0 then corresponding expiration value is equal to the expiration value when EPL or GKO is received.

The "first use" and expiration values get updated only upon very first request of EnableContent.

Parameters

item	Retrieved EMBB item.

Returns

The "first use" date expressed in number of UTC (Coordinated Universal Time) minutes since January 1, 1970 or zero if there is no "first use" date.

EMB_Item_GetId()

EMB_EXPORT EMB_ByteArray EMB_Item_GetId

(

const EMB_Item *

item

)

Gets the id of the retrieved EMBB item.

Parameters

item	Retrieved EMBB item.

Returns

If the EMBB item is of EPL type, the content id is returned. If the EMBB item is of GKO type, the group id is returned.

EMB_Item_GetItemId()

EMB_EXPORT EMB_UInt32 EMB_Item_GetItemId

(

const EMB_Item *

item

)

Gets the item id of the retrieved EMBB item.

The item id is the id that was assigned by the EMBB Storage when the item was added.

Parameters

item	Retrieved EMBB item.

Returns

The item id of the EMBB item.

EMB_Item_GetTargetId()

EMB_EXPORT EMB_ByteArray EMB_Item_GetTargetId

(

const EMB_Item *

item

)

Gets the target id of the retrieved EMBB item.

This API must be enclosed between WSB_Runtime_Initialize and WSB_Runtime_Terminate.

Parameters

item	Retrieved EMBB item.

Returns

device id when the EPL is targeted at a device group id when the EPL is targeted at a group device id when the GKO is targeted at a device

EMB_Item_GetTargetType()

EMB_EXPORT EMB_TargetType EMB_Item_GetTargetType

(

const EMB_Item *

item

)

Gets the target type of the retrieved EMBB item.

Parameters

item	Retrieved EMBB item.

Returns

If the EPL item is targeted at a device, then EMB_TG_DEVICE. If the EPL item is targeted at a group, then EMB_TG_GROUP. If the GKO item is targeted at a device, then EMB_TG_DEVICE. If the GKO item is targeted to 0, then EMB_TG_GROUP. else EMB_TG_NONE.

EMB_Item_GetType()

EMB_EXPORT EMB_ItemType EMB_Item_GetType

(

const EMB_Item *

item

)

Gets the type of the retrieved EMBB item.

Parameters

item	Retrieved EMBB item.

Returns

If the EMBB item is of EPL type, then EMB_IT_EPL. If the EMBB item is of GKO type, then EMB_IT_GKO. else EMB_IT_UNKNOWN.