new Masterdata()
- Since:
-
- 2.0.0
Methods
-
<static> createGetImageUrlRequest(sItemID)
This function will create a request object for the function 'getImageUrl'.
-
Parameters:
Name Type Description sItemID
string Item ID to get the item image url for a GK masterdata item. - Since:
-
- 2.0.0
Returns:
(String) Returns a stringified Object for the getImageUrl request. -
<static> createGetItemDataByIDRequest(sItemID)
This function will create a request object for the function 'getItemDataByID'.
-
Parameters:
Name Type Description sItemID
string Item ID to get the item information for GK masterdata items. - Since:
-
- 2.0.0
Returns:
(String) Returns a stringified Object for the getItemDataByID request. -
<static> createGetItemDataListByIDListRequest(aItemIDList)
This function will create a request object for the function 'getItemDataListByIDList'.
-
Parameters:
Name Type Description aItemIDList
Array Array of item IDs to get the item information for GK masterdata items. - Since:
-
- 2.0.0
Returns:
(String) Returns a stringified Object for the getItemDataListByIDList request. -
<static> getImageUrl(sResultFunction, sErrorFunction, oCreateGetImageUrlRequest)
This function will provide an image url via an item ID and the Digital Signage Server.
-
Parameters:
Name Type Description sResultFunction
string Name of the success callback function. Data type is string but internal data type is function. sErrorFunction
string Name of the error callback function. Data type is string but internal data type is function. oCreateGetImageUrlRequest
string Stringified Object from the createGetImageUrlRequest. Data type is string but internal data type is Object. The internally used object should look like the following example: { itemID: "03039", type: "item" } - Since:
-
- 2.0.0
-
<static> getItemDataByID(sResultFunction, sErrorFunction, oGetItemDataByIDRequest)
This function will provide GK masterdata item information for a given item ID.
-
Parameters:
Name Type Description sResultFunction
string Name of the success callback function. Data type is string but internal data type is function. sErrorFunction
string Name of the error callback function. Data type is string but internal data type is function. oGetItemDataByIDRequest
string Stringified Object from the createGetItemDataByIDRequest. Data type is string but internal data type is Object. The internally used object should look like the following example: { itemID: "030039" } - Since:
-
- 2.0.0
-
<static> getItemDataListByIDList(sResultFunction, sErrorFunction, oGetItemDataListByIDListRequest)
This function will provide an array of GK masterdata items with their information for a given item ID list.
-
Parameters:
Name Type Description sResultFunction
string Name of the success callback function. Data type is string but internal data type is function. sErrorFunction
string Name of the error callback function. Data type is string but internal data type is function. oGetItemDataListByIDListRequest
string Stringified Object from the createGetItemDataListByIDListRequest. Data type is string but internal data type is Object. The internally used object should look like the following example: { itemIDList: ["03039", "65005", "65007"] } - Since:
-
- 2.0.0