safeframe

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="generator" content="JsDoc Toolkit" /> <title>$sf.pub.Config | 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>  </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"> Class <span>$sf.pub.Config</span> </h1> <div class="intro"> <p class="description summary"> </p> <ul class="summary"> </ul> </div> </header> <section> <div class="props"> <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class $sf.pub.Config."> <caption class="sectionTitle">Class Summary</caption> <thead> <tr> <th scope="col">Constructor Attributes</th> <th scope="col">Constructor Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription" > <div class="fixedFont"> <b><a href="../symbols/%24sf.pub.Config.html#constructor">$sf.pub.Config</a></b>(conf) </div> <div class="description">Configure the base-level settings for the SafeFrames library Note that only one configuration can be active at a given time.</div> </td> </tr> </tbody> </table> </div> </section>    <section> <div class="details props"> <div class="innerProps"> <h2 class="sectionTitle" id="constructor"> Class Detail </h2> <div class="fixedFont"> <b>$sf.pub.Config</b>(conf) </div> <div class="description"> Configure the base-level settings for the SafeFrames library Note that only one configuration can be active at a given time. Therefore you cannot change the configuration by creating a new $sf.pub.Config while the SafeFrames library is busy (however you can add new position configurations). Instatiating a new config, when the library is not busy will destroy / remove all currently managed positions and there configurations. </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Object}</span> <b>conf</b> </dt> <dd>An object containing properties for configuration</dd> <dt> <span class="light fixedFont">{Boolean}</span> <b>conf.auto</b> <i>Optional</i> </dt> <dd>Whether or not to have SafeFrames automatically boostrap an render any SafeFrames tags within the page</dd> <dt> <span class="light fixedFont">{String}</span> <b>conf.cdn</b> </dt> <dd>The protocol,host name, and port parts of a URI, that is a 2ndary origin, used with SafeFrames to render content. For example JS files would be loaded from conf.cdn+"/"+conf.root+"/"+conf.version+"/[filename]"</dd> <dt> <span class="light fixedFont">{Boolean}</span> <b>conf.debug</b> <i>Optional</i> </dt> <dd>Whether or not debug mode is on or off</dd> <dt> <span class="light fixedFont">{String}</span> <b>conf.root</b> </dt> <dd>The root path part of the URI that is a 2ndary origin, used with SafeFrames to render content. For example the HTML file for rendering content into would beloaded from conf.cdn+"/"+conf.root+"/"+conf.version+"/"+conf.renderFile</dd> <dt> <span class="light fixedFont">{String}</span> <b>conf.renderFile</b> </dt> <dd>The filename (may also include path info), for which to render content into via a SafeFrame.</dd> <dt> <span class="light fixedFont">{String}</span> <b>conf.msgFile</b> <i>Optional</i> </dt> <dd>The filename (may also include path info), for which to use as a proxy for x-domain messaging whenever HTML5 messaging is not available. Only required if supporting older browsers.</dd> <dt> <span class="light fixedFont">{Number}</span> <b>conf.to</b> <i>Optional</i> </dt> <dd>The maximum amount of time in milliseconds to wait for a SafeFrame to finish rendering, defaults to 60 seconds.</dd> <dt> <span class="light fixedFont">{Function}</span> <b>conf.onBeforePosMsg</b> <i>Optional</i> </dt> <dd>A callback function that gets fired before any cancellable action is requested to be peformed from a a SafeFrame, such as expansion, etc. Return true out of this callback function to cancel/disallow the action in question.</dd> <dt> <span class="light fixedFont">{Function}</span> <b>conf.onPosMsg</b> <i>Optional</i> </dt> <dd>A callback function that gets fired when an action requested by a SafeFrame is performed</dd> <dt> <span class="light fixedFont">{Function}</span> <b>conf.onStartPosRender</b> <i>Optional</i> </dt> <dd>A callback function that gets fired when a SafeFrame starts to render 3rd party content.</dd> <dt> <span class="light fixedFont">{Function}</span> <b>conf.onEndPosRender</b> <i>Optional</i> </dt> <dd>A callback function that gets fired when a SafeFrame finishes rendering 3rd party content.</dd> <dt> <span class="light fixedFont">{Object}</span> <b>conf.positions</b> <i>Optional</i> </dt> <dd>A map of positions to automatically configure, where each key equals the id of the $sf.pub.PosConfig object, and the value is an object containing said object's settings.</dd> </dl> </div> </div> </section>    </article> </div> </div> <script type="text/javascript"> wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660) codeview.classFilter.Init() </script> </body> </html>