safeframe
Version:
SafeFrame provides a consistent JS API to include 3rd party content
457 lines (269 loc) • 12.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>$sf.pub | SafeFrames JS API</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<meta name="mobileoptimized" content="0" />
<link rel="stylesheet" href="../css/all.css" media="all" />
<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" />
<link rel="stylesheet" href="../css/handheld.css" media="handheld" />
<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" />
<script src="../javascript/all.js"></script>
<!--[if lt IE 9]>
<script src="../javascript/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="index">
<div class="menu">
<div class="indexLinks">
</div>
<h2 class="heading1">Classes</h2>
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
<nav>
<ul class="classList" id="ClassList">
<li><a href="../symbols/%24sf.html">$sf</a></li>
<li><a href="../symbols/%24sf.env.html">$sf<span class='break'> </span>.<span class='break'> </span>env</a></li>
<li><a href="../symbols/%24sf.env.ua.html">$sf<span class='break'> </span>.<span class='break'> </span>env<span class='break'> </span>.<span class='break'> </span>ua</a></li>
<li><a href="../symbols/%24sf.lib.html">$sf<span class='break'> </span>.<span class='break'> </span>lib</a></li>
<li><a href="../symbols/%24sf.lib.dom.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>dom</a></li>
<li><a href="../symbols/%24sf.lib.dom.iframes.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>dom<span class='break'> </span>.<span class='break'> </span>iframes</a></li>
<li><a href="../symbols/%24sf.lib.dom.msghost.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>dom<span class='break'> </span>.<span class='break'> </span>msghost</a></li>
<li><a href="../symbols/%24sf.lib.lang.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>lang</a></li>
<li><a href="../symbols/%24sf.lib.lang.ParamHash.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>lang<span class='break'> </span>.<span class='break'> </span>ParamHash</a></li>
<li><a href="../symbols/%24sf.pub.html">$sf<span class='break'> </span>.<span class='break'> </span>pub</a></li>
<li><a href="../symbols/%24sf.pub.Config.html">$sf<span class='break'> </span>.<span class='break'> </span>pub<span class='break'> </span>.<span class='break'> </span>Config</a></li>
<li><a href="../symbols/%24sf.pub.PosConfig.html">$sf<span class='break'> </span>.<span class='break'> </span>pub<span class='break'> </span>.<span class='break'> </span>PosConfig</a></li>
<li><a href="../symbols/%24sf.pub.Position.html">$sf<span class='break'> </span>.<span class='break'> </span>pub<span class='break'> </span>.<span class='break'> </span>Position</a></li>
<li><a href="../symbols/%24sf.vend.html">$sf<span class='break'> </span>.<span class='break'> </span>vend</a></li>
</ul>
</nav>
</div>
<div class="fineprint" style="clear:both">
<footer>
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
Template: <a href="" target="_blank">Codeview</a> 1.2.1<br />
Generated on:
<time datetime='2012-7-6' pubdate>2012-7-6 16:05</time>
</footer>
</div>
</div>
<div class="index indexStatic"></div>
<div class="content">
<div class="innerContent">
<article>
<header>
<h1 class="classTitle">
Namespace <span>$sf.pub</span>
</h1>
<div class="intro">
<p class="description summary">
$sf.pub Defines the Publisher side api, and helper functions
</p>
<ul class="summary">
</ul>
</div>
</header>
<!--
#### METHODS SUMMARY
-->
<section>
<div class="props">
<h2 class="sectionTitle">Method Summary</h2>
<nav>
<table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class $sf.pub.">
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr
class='item0'
>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">$sf.pub.<b><a href="../symbols/%24sf.pub.html#.boot">boot</a></b>()
</div>
<div class="description">Search for SafeFrames tags and render them.</div>
</td>
</tr>
<tr
class='item1'
>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">$sf.pub.<b><a href="../symbols/%24sf.pub.html#.get">get</a></b>()
</div>
<div class="description">Gets a copy of the Position configuration, content, and meta data for a given SafeFrame</div>
</td>
</tr>
<tr
class='item2'
>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">$sf.pub.<b><a href="../symbols/%24sf.pub.html#.nuke">nuke</a></b>(pos_id*)
</div>
<div class="description">Remove / destroy one or more SafeFrames from the publisher page</div>
</td>
</tr>
<tr
class='item3'
>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">$sf.pub.<b><a href="../symbols/%24sf.pub.html#.render">render</a></b>(pos*)
</div>
<div class="description">Render one or more $sf.pub.Position objects into the page</div>
</td>
</tr>
<tr
class='item4'
>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">$sf.pub.<b><a href="../symbols/%24sf.pub.html#.status">status</a></b>()
</div>
<div class="description">Returns a string as to whether or not the library is busy, empty string is returned on idle</div>
</td>
</tr>
</tbody>
</table>
</nav>
</div>
</section>
<!--
#### EVENTS SUMMARY
-->
<!--
#### CONSTRUCTOR DETAILS
-->
<!--
#### FIELD DETAILS
-->
<!--
#### METHOD DETAILS
-->
<section>
<div class="details props">
<div class="innerProps">
<h2 class="sectionTitle">
Method Detail
</h2>
<ul class="methodDetail" id="MethodDetail">
<li
class='item0'
>
<div class="fixedFont heading" id=".boot">
<span class='lighter'>
<static>
</span>
<span class="light">$sf.pub.</span><b>boot</b>()
</div>
<div class="description">
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.
</div>
<div class="hr"></div>
</li>
<li
class='item1'
>
<div class="fixedFont heading" id=".get">
<span class='lighter'>
<static>
</span>
<span class="light">{Object}</span>
<span class="light">$sf.pub.</span><b>get</b>()
</div>
<div class="description">
Gets a copy of the Position configuration, content, and meta data for a given SafeFrame
</div>
<dl class="detailList nomargin">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> </dd>
</dl>
<div class="hr"></div>
</li>
<li
class='item2'
>
<div class="fixedFont heading" id=".nuke">
<span class='lighter'>
<static>
</span>
<span class="light">$sf.pub.</span><b>nuke</b>(pos_id*)
</div>
<div class="description">
Remove / destroy one or more SafeFrames from the publisher page
</div>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>pos_id*</b>
</dt>
<dd>One or more position ids to remove from the page. If no arguments are specifed, all positions currently rendered are removed.</dd>
</dl>
<div class="hr"></div>
</li>
<li
class='item3'
>
<div class="fixedFont heading" id=".render">
<span class='lighter'>
<static>
</span>
<span class="light">$sf.pub.</span><b>render</b>(pos*)
</div>
<div class="description">
Render one or more $sf.pub.Position objects into the page
</div>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/%24sf.pub.Position.html">$sf.pub.Position</a>}</span> <b>pos*</b>
</dt>
<dd>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</dd>
</dl>
<div class="hr"></div>
</li>
<li
class='item4'
>
<div class="fixedFont heading" id=".status">
<span class='lighter'>
<static>
</span>
<span class="light">{String}</span>
<span class="light">$sf.pub.</span><b>status</b>()
</div>
<div class="description">
Returns a string as to whether or not the library is busy, empty string is returned on idle
</div>
<dl class="detailList nomargin">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{String}</span> </dd>
</dl>
</li>
</ul>
</div>
</div>
</section>
<!--
#### EVENT DETAILS
-->
</article>
</div>
</div>
<script type="text/javascript">
wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
codeview.classFilter.Init()
</script>
</body>
</html>