HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk

Namespace s7sdk.MediaSetParser

Static functions for handling MediaSet (req=set ImageServing) responses.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
s7sdk.MediaSetParser.findCompanyNameInAsset(inAsset)
Finds the company name in a complex asset value.
<static>  
s7sdk.MediaSetParser.parse(jsonItem, isCommands, aemmode, dir)
Top-level function for parsing a req=set response in JSON format.
<static>  
s7sdk.MediaSetParser.parseAssetForSetReq(inAsset)
parseAssetForSetReq is used to finds the "company"-name,"" and "" for creating "set"-request in a complex asset value.
Namespace Detail
s7sdk.MediaSetParser
Method Detail
<static> s7sdk.MediaSetParser.findCompanyNameInAsset(inAsset)
Finds the company name in a complex asset value.
Parameters:
inAsset
Asset value including the company name.
Returns:
Company root value.

<static> {s7sdk.MediaSetDesc} s7sdk.MediaSetParser.parse(jsonItem, isCommands, aemmode, dir)
Top-level function for parsing a req=set response in JSON format.
Parameters:
{Object} jsonItem
The JSON item from the Image Server req=set,json request that represents the media set.
{String} isCommands
additional Image Serving commands which are optionally defined in the end of asset= modifier. Are appended to the end of all image item names created by the parser.
aemmode
dir
Returns:
{s7sdk.MediaSetDesc} If successful, returns item hierarchy stored in a MediaSetDesc object.
See:
s7sdk.MediaSetDesc

<static> {req:|name:|mod:} s7sdk.MediaSetParser.parseAssetForSetReq(inAsset)
parseAssetForSetReq is used to finds the "company"-name,"" and "" for creating "set"-request in a complex asset value. By the rule: - if asset "complex", then ?req=set&imageSet={}& - if not "complex", then ?req=set&
Parameters:
inAsset
Asset value including the company name.
Returns:
{req:|name:|mod:} .

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 15 2020 11:59:12 GMT-0000 (UTC)