<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Module: packet/literal</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Module: packet/literal</h1> <section> <header> <h2> packet/literal </h2> </header> <article> <div class="container-overview"> <div class="description">Implementation of the Literal Data Packet (Tag 11)<br/> <br/> RFC4880 5.9: A Literal Data packet contains the body of a message; data that is not to be further interpreted.</div> <dt> <h4 class="name" id="module:packet/literal"><span class="type-signature"></span>new (require("packet/literal"))<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line34">line 34</a> </li></ul></dd> </dl> </dd> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line18">line 18</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Requires</h3> <ul> <li><a href="module-enums.html">module:enums</a></li> <li><a href="module-util.html">module:util</a></li> </ul> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="getBytes"><span class="type-signature"></span>getBytes<span class="signature">()</span><span class="type-signature"> → {String}</span></h4> </dt> <dd> <div class="description"> Get the byte sequence representing the literal packet data </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line79">line 79</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> A sequence of bytes </div> <dl> <dt> Type </dt> <dd> <span class="param-type">String</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getText"><span class="type-signature"></span>getText<span class="signature">()</span><span class="type-signature"> → {String}</span></h4> </dt> <dd> <div class="description"> Returns literal data packets as native JavaScript string with normalized end of line to \n </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line57">line 57</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> literal data as text </div> <dl> <dt> Type </dt> <dd> <span class="param-type">String</span> </dd> </dl> </dd> <dt> <h4 class="name" id="read"><span class="type-signature"></span>read<span class="signature">(input, position, len)</span><span class="type-signature"> → {<a href="literal.html">module:packet/literal</a>}</span></h4> </dt> <dd> <div class="description"> Parsing function for a literal data packet (tag 11). </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>input</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Payload of a tag 11 packet</td> </tr> <tr> <td class="name"><code>position</code></td> <td class="type"> <span class="param-type">Integer</span> </td> <td class="description last">Position to start reading from the input string</td> </tr> <tr> <td class="name"><code>len</code></td> <td class="type"> <span class="param-type">Integer</span> </td> <td class="description last">Length of the packet or the remaining length of input at position</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line95">line 95</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> object representation </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="literal.html">module:packet/literal</a></span> </dd> </dl> </dd> <dt> <h4 class="name" id="setBytes"><span class="type-signature"></span>setBytes<span class="signature">(bytes, format)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Set the packet data to value represented by the provided string of bytes. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>bytes</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The string of bytes</td> </tr> <tr> <td class="name"><code>format</code></td> <td class="type"> <span class="param-type">utf8</span> | <span class="param-type">binary</span> | <span class="param-type">text</span> </td> <td class="description last">The format of the string of bytes</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line69">line 69</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="setText"><span class="type-signature"></span>setText<span class="signature">(text)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Set the packet data to a javascript native string, end of line will be normalized to \r\n and by default text is converted to UTF8 </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>text</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Any native javascript string</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line45">line 45</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">(data)</span><span class="type-signature"> → {String}</span></h4> </dt> <dd> <div class="description"> Creates a string representation of the packet </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The data to be inserted as body</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="literal.js.html">packet/literal.js</a>, <a href="literal.js.html#line116">line 116</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> string-representation of the packet </div> <dl> <dt> Type </dt> <dd> <span class="param-type">String</span> </dd> </dl> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-armor.html">armor</a></li><li><a href="module-cleartext.html">cleartext</a></li><li><a href="module-config.html">config</a></li><li><a href="config.html">config/config</a></li><li><a href="localStorage.html">config/localStorage</a></li><li><a href="module-crypto.html">crypto</a></li><li><a href="cfb.html">crypto/cfb</a></li><li><a href="cipher.html">crypto/cipher</a></li><li><a href="aes.html">crypto/cipher/aes</a></li><li><a href="blowfish.html">crypto/cipher/blowfish</a></li><li><a href="cast5.html">crypto/cipher/cast5</a></li><li><a href="des.html">crypto/cipher/des</a></li><li><a href="twofish.html">crypto/cipher/twofish</a></li><li><a href="crypto.html">crypto/crypto</a></li><li><a href="hash.html">crypto/hash</a></li><li><a href="md5.html">crypto/hash/md5</a></li><li><a href="ripe-md.html">crypto/hash/ripe-md</a></li><li><a href="sha.html">crypto/hash/sha</a></li><li><a href="pkcs1.html">crypto/pkcs1</a></li><li><a href="public_key.html">crypto/public_key</a></li><li><a href="dsa.html">crypto/public_key/dsa</a></li><li><a href="elgamal.html">crypto/public_key/elgamal</a></li><li><a href="jsbn.html">crypto/public_key/jsbn</a></li><li><a href="rsa.html">crypto/public_key/rsa</a></li><li><a href="random.html">crypto/random</a></li><li><a href="signature.html">crypto/signature</a></li><li><a href="armor.html">encoding/armor</a></li><li><a href="base64.html">encoding/base64</a></li><li><a href="module-enums.html">enums</a></li><li><a href="module-key.html">key</a></li><li><a href="module-keyid.html">keyid</a></li><li><a href="keyring.html">keyring/keyring</a></li><li><a href="localstore.html">keyring/localstore</a></li><li><a href="module-message.html">message</a></li><li><a href="module-mpi.html">mpi</a></li><li><a href="module-openpgp.html">openpgp</a></li><li><a href="module-packet.html">packet</a></li><li><a href="compressed.html">packet/compressed</a></li><li><a href="literal.html">packet/literal</a></li><li><a href="marker.html">packet/marker</a></li><li><a href="one_pass_signature.html">packet/one_pass_signature</a></li><li><a href="packet.html">packet/packet</a></li><li><a href="packetlist.html">packet/packetlist</a></li><li><a href="public_key_.html">packet/public_key</a></li><li><a href="public_key_encrypted_session_key.html">packet/public_key_encrypted_session_key</a></li><li><a href="public_subkey.html">packet/public_subkey</a></li><li><a href="secret_key.html">packet/secret_key</a></li><li><a href="secret_subkey.html">packet/secret_subkey</a></li><li><a href="signature_.html">packet/signature</a></li><li><a href="sym_encrypted_integrity_protected.html">packet/sym_encrypted_integrity_protected</a></li><li><a href="sym_encrypted_session_key.html">packet/sym_encrypted_session_key</a></li><li><a href="symmetrically_encrypted.html">packet/symmetrically_encrypted</a></li><li><a href="trust.html">packet/trust</a></li><li><a href="user_attribute.html">packet/user_attribute</a></li><li><a href="userid.html">packet/userid</a></li><li><a href="module-s2k.html">s2k</a></li><li><a href="keyid.html">type/keyid</a></li><li><a href="mpi.html">type/mpi</a></li><li><a href="s2k.html">type/s2k</a></li><li><a href="module-util.html">util</a></li><li><a href="util.html">util/util</a></li></ul><h3>Classes</h3><ul><li><a href="JXG.Util.html">Util</a></li><li><a href="module-cleartext-CleartextMessage.html">CleartextMessage</a></li><li><a href="module-key-Key.html">Key</a></li><li><a href="module-key-SubKey.html">SubKey</a></li><li><a href="module-key-User.html">User</a></li><li><a href="module-message-Message.html">Message</a></li></ul> </nav> <br clear="both"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Thu Jan 02 2014 13:02:43 GMT-0800 (PST) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>