Namespace $sf.pub
$sf.pub Defines the Publisher side api, and helper functions
Method Summary
Method Detail
-
<static> $sf.pub.boot()Search for SafeFrames tags and render them. This function is called automatically whenever the SafeFrames publisher library is loaded. However a configuration can be applied to not have SafeFrames tags automatically be rendered, requiring a controlled call to this function.
-
<static> {Object} $sf.pub.get()Gets a copy of the Position configuration, content, and meta data for a given SafeFrame
- Returns:
- {Object}
-
<static> $sf.pub.nuke(pos_id*)Remove / destroy one or more SafeFrames from the publisher page
- Parameters:
- {String} pos_id*
- One or more position ids to remove from the page. If no arguments are specifed, all positions currently rendered are removed.
-
<static> $sf.pub.render(pos*)Render one or more $sf.pub.Position objects into the page
- Parameters:
- {$sf.pub.Position} pos*
- An instance of an $sf.pub.Position object to render. Note that said object must have a corresponding $sf.pub.PosConfig, as well as $sf.pub.Config must have been set
-
<static> {String} $sf.pub.status()Returns a string as to whether or not the library is busy, empty string is returned on idle
- Returns:
- {String}