Classes

Class $sf.pub.Position

Class Summary
Constructor Attributes Constructor Name and Description
 
$sf.pub.Position(posIDorObj, html, meta, conf)
Construction a postion content object that contains HTML, optionally meta-data, and optionally a position configuration to use.

Class Detail

$sf.pub.Position(posIDorObj, html, meta, conf)
Construction a postion content object that contains HTML, optionally meta-data, and optionally a position configuration to use. The id specified must match an id for a $sf.pub.PosConfig (although said config could be specfied directly here via arguments).
Parameters:
{Object|String} posIDorObj
The id of the position which maps to its configuration, or an object represeting the various values of an $sf.pub.Position instance.
{String} posIDorObj.id Optional
The id of the position which maps to its configuration.
{String} posIDorObj.html Optional
The HTML content to be rendered inside the SafeFrame. Note that HTML strings which have SCRIPT tags or other special characters may need to be properly escaped in order to avoid JavaScript syntax errors.
{String} posIDorObj.src Optional
An optional URL to be used for redering inside the SafeFrame which will automatically generate a SCRIPT tag with the specified URL.
{$sf.pub.PosMeta} posIDorObj.meta Optional
An optional instance of the $sf.pub.PosMeta object to be passed along into the SafeFrame
{Object} posIDorObj.conf Optional
An optional representation of an $sf.pub.PosConfig object to be used as the configuration for the SafeFrame position.
{String} html Optional
The HTML content to be rendered inside the SafeFrame. Note that HTML strings which have SCRIPT tags or other special characters may need to be properly escaped in order to avoid JavaScript syntax errors.
{$sf.pub.PosMeta} meta Optional
An optional instance of the $sf.pub.PosMeta object to be passed along into the SafeFrame
{Object} conf Optional
An optional representation of an $sf.pub.PosConfig object to be used as the configuration for the SafeFrame position.