<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta name="generator" content="JsDoc Toolkit" /> <title>JsDoc Reference - SIPml.Session.Publish</title> <style type="text/css"> /* default.css */ body { font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; width: 800px; } .header { clear: both; background-color: #ccc; padding: 8px; } h1 { font-size: 150%; font-weight: bold; padding: 0; margin: 1em 0 0 .3em; } hr { border: none 0; border-top: 1px solid #7F8FB1; height: 1px; } pre.code { display: block; padding: 8px; border: 1px dashed #ccc; } #index { margin-top: 24px; float: left; width: 160px; position: absolute; left: 8px; background-color: #F3F3F3; padding: 8px; } #content { margin-left: 190px; width: 600px; } .classList { list-style-type: none; padding: 0; margin: 0 0 0 8px; font-family: arial, sans-serif; font-size: 1em; overflow: auto; } .classList li { padding: 0; margin: 0 0 8px 0; } .summaryTable { width: 100%; } h1.classTitle { font-size:170%; line-height:130%; } h2 { font-size: 110%; } caption, div.sectionTitle { background-color: #7F8FB1; color: #fff; font-size:130%; text-align: left; padding: 2px 6px 2px 6px; border: 1px #7F8FB1 solid; } div.sectionTitle { margin-bottom: 8px; } .summaryTable thead { display: none; } .summaryTable td { vertical-align: top; padding: 4px; border-bottom: 1px #7F8FB1 solid; border-right: 1px #7F8FB1 solid; } /*col#summaryAttributes {}*/ .summaryTable td.attributes { border-left: 1px #7F8FB1 solid; width: 140px; text-align: right; } td.attributes, .fixedFont { line-height: 15px; color: #002EBE; font-family: "Courier New",Courier,monospace; font-size: 13px; } .summaryTable td.nameDescription { text-align: left; font-size: 13px; line-height: 15px; } .summaryTable td.nameDescription, .description { line-height: 15px; padding: 4px; padding-left: 4px; } .summaryTable { margin-bottom: 8px; } ul.inheritsList { list-style: square; margin-left: 20px; padding-left: 0; } .detailList { margin-left: 20px; line-height: 15px; } .detailList dt { margin-left: 20px; } .detailList .heading { font-weight: bold; padding-bottom: 6px; margin-left: 0; } .light, td.attributes, .light a:link, .light a:visited { color: #777; font-style: italic; } .fineprint { text-align: right; font-size: 10px; } </style> </head> <body> <!-- ============================== header ================================= --> <!-- begin static/header.html --> <div id="header"> </div> <!-- end static/header.html --> <!-- ============================== classes index ============================ --> <div id="index"> <!-- begin publish.classesIndex --> <div align="center"><a href="../index.html">Class Index</a> | <a href="../files.html">File Index</a></div> <hr /> <h2>Classes</h2> <ul class="classList"> <li><i><a href="../symbols/_global_.html">_global_</a></i></li> <li><a href="../symbols/SIPml.html">SIPml</a></li> <li><a href="../symbols/SIPml.Event.html">SIPml.Event</a></li> <li><a href="../symbols/SIPml.EventTarget.html">SIPml.EventTarget</a></li> <li><a href="../symbols/SIPml.Session.html">SIPml.Session</a></li> <li><a href="../symbols/SIPml.Session.Call.html">SIPml.Session.Call</a></li> <li><a href="../symbols/SIPml.Session.Configuration.html">SIPml.Session.Configuration</a></li> <li><a href="../symbols/SIPml.Session.Event.html">SIPml.Session.Event</a></li> <li><a href="../symbols/SIPml.Session.Message.html">SIPml.Session.Message</a></li> <li><a href="../symbols/SIPml.Session.Publish.html">SIPml.Session.Publish</a></li> <li><a href="../symbols/SIPml.Session.Registration.html">SIPml.Session.Registration</a></li> <li><a href="../symbols/SIPml.Session.Subscribe.html">SIPml.Session.Subscribe</a></li> <li><a href="../symbols/SIPml.Stack.html">SIPml.Stack</a></li> <li><a href="../symbols/SIPml.Stack.Configuration.html">SIPml.Stack.Configuration</a></li> <li><a href="../symbols/SIPml.Stack.Event.html">SIPml.Stack.Event</a></li> </ul> <hr /> <!-- end publish.classesIndex --> </div> <div id="content"> <!-- ============================== class title ============================ --> <h1 class="classTitle"> Class SIPml.Session.Publish </h1> <!-- ============================== class summary ========================== --> <p class="description"> <br />Extends <a href="../symbols/SIPml.Session.html">SIPml.Session</a>.<br /> <br /><i>Defined in: </i> <a href="../symbols/src/SIPml.js.html">SIPml.js</a>. </p> <!-- ============================== constructor summary ==================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class SIPml.Session.Publish."> <caption>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/SIPml.Session.Publish.html#constructor">SIPml.Session.Publish</a></b>(session, configuration) </div> <div class="description">SIP PUBLISH (for presence status publication) session class.You should never create an instance of this class by yourself.</div> </td> </tr> </tbody> </table> <!-- ============================== properties summary ===================== --> <!-- ============================== methods summary ======================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class SIPml.Session.Publish."> <caption>Method Summary</caption> <thead> <tr> <th scope="col">Method Attributes</th> <th scope="col">Method Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/SIPml.Session.Publish.html#publish">publish</a></b>(content, contentType, configuration) </div> <div class="description">Sends a SIP PUBLISH (for presence status publication) request.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/SIPml.Session.Publish.html#unpublish">unpublish</a></b>(configuration) </div> <div class="description">Remove/unpublish presence data from the server.</div> </td> </tr> </tbody> </table> <dl class="inheritsList"> <dt>Methods borrowed from class <a href="../symbols/SIPml.Session.html">SIPml.Session</a>: </dt><dd><a href="../symbols/SIPml.Session.html#accept">accept</a>, <a href="../symbols/SIPml.Session.html#getId">getId</a>, <a href="../symbols/SIPml.Session.html#getRemoteFriendlyName">getRemoteFriendlyName</a>, <a href="../symbols/SIPml.Session.html#getRemoteUri">getRemoteUri</a>, <a href="../symbols/SIPml.Session.html#reject">reject</a>, <a href="../symbols/SIPml.Session.html#setConfiguration">setConfiguration</a></dd><dt>Methods borrowed from class <a href="../symbols/SIPml.EventTarget.html">SIPml.EventTarget</a>: </dt><dd><a href="../symbols/SIPml.EventTarget.html#addEventListener">addEventListener</a>, <a href="../symbols/SIPml.EventTarget.html#removeEventListener">removeEventListener</a></dd> </dl> <!-- ============================== events summary ======================== --> <!-- ============================== constructor details ==================== --> <div class="details"><a name="constructor"> </a> <div class="sectionTitle"> Class Detail </div> <div class="fixedFont"> <b>SIPml.Session.Publish</b>(session, configuration) </div> <div class="description"> SIP PUBLISH (for presence status publication) session class.You should never create an instance of this class by yourself. Please use <a href="SIPml.Stack.html#newSession">stack.newSession()</a> function to create a new presence publication session. </div> <pre class="code"> var session = <a href="SIPml.Stack.html#newSession">stack.newSession</a>('publish', { expires: 200, events_listener: { events: '*', listener: function(e){} }, sip_headers: [ { name: 'Event', value: 'presence' } // very important ], sip_caps: [ { name: '+g.oma.sip-im', value: null }, { name: '+audio', value: null }, { name: 'language', value: '\"en,fr\"' } ] });</pre> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{tsip_session}</span> <b>session</b> </dt> <dd>Private session object.</dd> <dt> <span class="light fixedFont">{<a href="../symbols/SIPml.Session.Configuration.html">SIPml.Session.Configuration</a>}</span> <b>configuration</b> <i>Optional</i> </dt> <dd>Configuration value.</dd> </dl> <dl class="detailList"> <dt class="heading">Since:</dt> <dd>version 1.1.0</dd> </dl> </div> <!-- ============================== field details ========================== --> <!-- ============================== method details ========================= --> <div class="sectionTitle"> Method Detail </div> <a name="publish"> </a> <div class="fixedFont"> <span class="light">{Integer, Integer}</span> <b>publish</b>(content, contentType, configuration) </div> <div class="description"> Sends a SIP PUBLISH (for presence status publication) request. </div> <pre class="code"> var session = <a href="SIPml.Stack.html#newSession">stack.newSession</a>('publish'); var contentType = 'application/pidf+xml'; var content = '<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n' + '<presence xmlns=\"urn:ietf:params:xml:ns:pidf\"\n' + ' xmlns:im=\"urn:ietf:params:xml:ns:pidf:im\"' + ' entity=\"sip:bob@example.com\">\n' + '<tuple id=\"s8794\">\n' + '<status>\n'+ ' <basic>open</basic>\n' + ' <im:im>away</im:im>\n' + '</status>\n' + '<contact priority=\"0.8\">tel:+33600000000</contact>\n' + '<note xml:lang=\"fr\">Bonjour de Paris :)</note>\n' + '</tuple>\n' + '</presence>'; session.publish(content, contentType,{ expires: 200, sip_caps: [ { name: '+g.oma.sip-im' }, { name: '+sip.ice' }, { name: 'language', value: '\"en,fr\"' } ], sip_headers: [ { name: 'Event', value: 'presence' }, { name: 'Organization', value: 'Doubango Telecom' } ] });</pre> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Object|String}</span> <b>content</b> <i>Optional</i> </dt> <dd>The request content.</dd> <dt> <span class="light fixedFont">{String}</span> <b>contentType</b> <i>Optional</i> </dt> <dd>The content type.</dd> <dt> <span class="light fixedFont">{<a href="../symbols/SIPml.Session.Configuration.html">SIPml.Session.Configuration</a>}</span> <b>configuration</b> <i>Optional</i> </dt> <dd>Configuration value.</dd> </dl> <dl class="detailList"> <dt class="heading">Since:</dt> <dd>version 1.1.0</dd> </dl> </dl> <dl class="detailList"> <dt class="heading">Throws:</dt> <dt> <span class="light fixedFont">{ERR_INVALID_PARAMETER_VALUE | ERR_NOT_READY}</span> <b></b> </dt> <dd><font color="red">ERR_INVALID_PARAMETER_VALUE</font> | <font color="red">ERR_NOT_READY</font></dd> </dl> <dl class="detailList"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{Integer}</span> 0 if successful; otherwise nonzero</dd> <dd><span class="light fixedFont">{Integer}</span> 0 if successful; otherwise nonzero</dd> </dl> <dl class="detailList"> <dt class="heading">See:</dt> <dd><a href="#unpublish">unpublish</a></dd> </dl> <hr /> <a name="unpublish"> </a> <div class="fixedFont"> <b>unpublish</b>(configuration) </div> <div class="description"> Remove/unpublish presence data from the server. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{<a href="../symbols/SIPml.Session.Configuration.html">SIPml.Session.Configuration</a>}</span> <b>configuration</b> <i>Optional</i> </dt> <dd>Configuration value.</dd> </dl> <dl class="detailList"> <dt class="heading">Since:</dt> <dd>version 1.1.0</dd> </dl> </dl> <dl class="detailList"> <dt class="heading">Throws:</dt> <dt> <span class="light fixedFont">{ERR_INVALID_PARAMETER_VALUE | ERR_NOT_READY}</span> <b></b> </dt> <dd><font color="red">ERR_INVALID_PARAMETER_VALUE</font> | <font color="red">ERR_NOT_READY</font></dd> </dl> <dl class="detailList"> <dt class="heading">See:</dt> <dd><a href="#publish">publish</a></dd> </dl> <!-- ============================== event details ========================= --> <hr /> </div> <!-- ============================== footer ================================= --> <div class="fineprint" style="clear:both"> Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Wed Sep 25 2013 03:40:14 GMT+0200 (CEST) </div> </body> </html>