| <!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 - Guacamole.Blob</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/Guacamole.html">Guacamole</a></li> |
| |
| <li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li> |
| |
| <li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li> |
| |
| <li><a href="../symbols/Guacamole.Blob.html">Guacamole.Blob</a></li> |
| |
| <li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li> |
| |
| <li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li> |
| |
| <li><a href="../symbols/Guacamole.Client.LayerContainer.html">Guacamole.Client.LayerContainer</a></li> |
| |
| <li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li> |
| |
| <li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li> |
| |
| <li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li> |
| |
| <li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li> |
| |
| <li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li> |
| |
| <li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li> |
| |
| <li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li> |
| |
| <li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li> |
| |
| <li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li> |
| |
| <li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li> |
| |
| <li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li> |
| |
| <li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li> |
| |
| <li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li> |
| |
| <li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li> |
| |
| </ul> |
| <hr /> |
| <!-- end publish.classesIndex --> |
| </div> |
| |
| <div id="content"> |
| <!-- ============================== class title ============================ --> |
| <h1 class="classTitle"> |
| |
| Class Guacamole.Blob |
| </h1> |
| |
| <!-- ============================== class summary ========================== --> |
| <p class="description"> |
| |
| |
| |
| |
| |
| |
| <br /><i>Defined in: </i> <a href="../symbols/src/src_main_resources_guacamole.js.html">guacamole.js</a>. |
| |
| </p> |
| |
| <!-- ============================== constructor summary ==================== --> |
| |
| <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole.Blob."> |
| <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/Guacamole.Blob.html#constructor">Guacamole.Blob</a></b>(mimetype, name) |
| </div> |
| <div class="description">A blob abstraction used by the Guacamole client to facilitate transfer of |
| files or other binary data.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <!-- ============================== properties summary ===================== --> |
| |
| |
| |
| <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Guacamole.Blob."> |
| <caption>Field Summary</caption> |
| <thead> |
| <tr> |
| <th scope="col">Field Attributes</th> |
| <th scope="col">Field Name and Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Guacamole.Blob.html#mimetype">mimetype</a></b> |
| </div> |
| <div class="description">The mimetype of the data contained within this blob.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Guacamole.Blob.html#name">name</a></b> |
| </div> |
| <div class="description">The name of this blob.</div> |
| </td> |
| </tr> |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| <!-- ============================== methods summary ======================== --> |
| |
| |
| |
| <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Guacamole.Blob."> |
| <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>append</b>(data) |
| </div> |
| <div class="description"></div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Guacamole.Blob.html#close">close</a></b>() |
| </div> |
| <div class="description">Closes this Guacamole.Blob such that no further data will be written.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b>getBlob</b>() |
| </div> |
| <div class="description"></div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Guacamole.Blob.html#getLength">getLength</a></b>() |
| </div> |
| <div class="description">Returns the current length of this Guacamole.Blob, in bytes.</div> |
| </td> |
| </tr> |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <!-- ============================== events summary ======================== --> |
| |
| |
| |
| <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class Guacamole.Blob."> |
| <caption>Event Summary</caption> |
| <thead> |
| <tr> |
| <th scope="col">Event Attributes</th> |
| <th scope="col">Event Name and Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Guacamole.Blob.html#event:oncomplete">oncomplete</a></b>() |
| </div> |
| <div class="description">Fired once this blob is finished and no further data will be written.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Guacamole.Blob.html#event:ondata">ondata</a></b>(length) |
| </div> |
| <div class="description">Fired once for every blob of data received.</div> |
| </td> |
| </tr> |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| <!-- ============================== constructor details ==================== --> |
| |
| <div class="details"><a name="constructor"> </a> |
| <div class="sectionTitle"> |
| Class Detail |
| </div> |
| |
| <div class="fixedFont"> |
| <b>Guacamole.Blob</b>(mimetype, name) |
| </div> |
| |
| <div class="description"> |
| A blob abstraction used by the Guacamole client to facilitate transfer of |
| files or other binary data. |
| |
| </div> |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <span class="light fixedFont">{String}</span> <b>mimetype</b> |
| |
| </dt> |
| <dd>The mimetype of the data this blob will contain.</dd> |
| |
| <dt> |
| <span class="light fixedFont">{String}</span> <b>name</b> |
| |
| </dt> |
| <dd>An arbitrary name for this blob.</dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| <!-- ============================== field details ========================== --> |
| |
| <div class="sectionTitle"> |
| Field Detail |
| </div> |
| |
| <a name="mimetype"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>mimetype</b> |
| |
| </div> |
| <div class="description"> |
| The mimetype of the data contained within this blob. |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="name"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>name</b> |
| |
| </div> |
| <div class="description"> |
| The name of this blob. In general, this should be an appropriate |
| filename. |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <!-- ============================== method details ========================= --> |
| |
| <div class="sectionTitle"> |
| Method Detail |
| </div> |
| |
| <a name="append"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>append</b>(data) |
| |
| </div> |
| <div class="description"> |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <b>data</b> |
| |
| </dt> |
| <dd></dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="close"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>close</b>() |
| |
| </div> |
| <div class="description"> |
| Closes this Guacamole.Blob such that no further data will be written. |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="getBlob"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>getBlob</b>() |
| |
| </div> |
| <div class="description"> |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="getLength"> </a> |
| <div class="fixedFont"> |
| |
| <span class="light">{Number}</span> |
| <b>getLength</b>() |
| |
| </div> |
| <div class="description"> |
| Returns the current length of this Guacamole.Blob, in bytes. |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Returns:</dt> |
| |
| <dd><span class="light fixedFont">{Number}</span> The current length of this Guacamole.Blob.</dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <!-- ============================== event details ========================= --> |
| |
| <div class="sectionTitle"> |
| Event Detail |
| </div> |
| |
| <a name="event:oncomplete"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>oncomplete</b>() |
| |
| </div> |
| <div class="description"> |
| Fired once this blob is finished and no further data will be written. |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="event:ondata"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>ondata</b>(length) |
| |
| </div> |
| <div class="description"> |
| Fired once for every blob of data received. |
| |
| |
| </div> |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <span class="light fixedFont">{Number}</span> <b>length</b> |
| |
| </dt> |
| <dd>The number of bytes received.</dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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 Fri May 23 2014 12:15:22 GMT-0700 (PDT) |
| </div> |
| |
| <!-- Google Analytics --> |
| <script type="text/javascript"> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-75289145-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script> |
| <!-- End Google Analytics --> |
| </body> |
| </html> |
