doc/0.9.8/guacamole-common-js/symbols/Guacamole.Client.html (1,087 lines of code) (raw):
<!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.Client</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.ArrayBufferReader.html">Guacamole.ArrayBufferReader</a></li>
<li><a href="../symbols/Guacamole.ArrayBufferWriter.html">Guacamole.ArrayBufferWriter</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.BlobReader.html">Guacamole.BlobReader</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.DataURIReader.html">Guacamole.DataURIReader</a></li>
<li><a href="../symbols/Guacamole.Display.html">Guacamole.Display</a></li>
<li><a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a></li>
<li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li>
<li><a href="../symbols/Guacamole.InputStream.html">Guacamole.InputStream</a></li>
<li><a href="../symbols/Guacamole.IntegerPool.html">Guacamole.IntegerPool</a></li>
<li><a href="../symbols/Guacamole.JSONReader.html">Guacamole.JSONReader</a></li>
<li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li>
<li><a href="../symbols/Guacamole.Keyboard.ModifierState.html">Guacamole.Keyboard.ModifierState</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.Object.html">Guacamole.Object</a></li>
<li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li>
<li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li>
<li><a href="../symbols/Guacamole.OnScreenKeyboard.Layout.html">Guacamole.OnScreenKeyboard.Layout</a></li>
<li><a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a></li>
<li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li>
<li><a href="../symbols/Guacamole.StringReader.html">Guacamole.StringReader</a></li>
<li><a href="../symbols/Guacamole.StringWriter.html">Guacamole.StringWriter</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.Client
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br /><i>Defined in: </i> <a href="../symbols/src/src_main_webapp_modules_Client.js.html">Client.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole.Client.">
<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.Client.html#constructor">Guacamole.Client</a></b>(tunnel)
</div>
<div class="description">Guacamole protocol client.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Guacamole.Client.">
<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"><inner> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Client.html#-audioChannels">audioChannels</a></b>
</div>
<div class="description">All audio channels currentl in use by the client.</div>
</td>
</tr>
<tr>
<td class="attributes"><inner> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Client.html#-display">display</a></b>
</div>
<div class="description">The underlying Guacamole display.</div>
</td>
</tr>
<tr>
<td class="attributes"><inner> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Client.html#-layers">layers</a></b>
</div>
<div class="description">All available layers and buffers</div>
</td>
</tr>
<tr>
<td class="attributes"><inner> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Client.html#-objects">objects</a></b>
</div>
<div class="description">All current objects.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Guacamole.Client.">
<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/Guacamole.Client.html#connect">connect</a></b>(data)
</div>
<div class="description">Connects the underlying tunnel of this Guacamole.Client, passing the
given arbitrary data to the tunnel during the connection process.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#createClipboardStream">createClipboardStream</a></b>(mimetype, name)
</div>
<div class="description">Opens a new clipboard object for writing, having the given mimetype.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#createFileStream">createFileStream</a></b>(mimetype, filename)
</div>
<div class="description">Opens a new file for writing, having the given index, mimetype and
filename.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#createObjectOutputStream">createObjectOutputStream</a></b>(index, mimetype, name)
</div>
<div class="description">Creates a new output stream associated with the given object and having
the given mimetype and name.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#createPipeStream">createPipeStream</a></b>(mimetype, name)
</div>
<div class="description">Opens a new pipe for writing, having the given name and mimetype.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#disconnect">disconnect</a></b>()
</div>
<div class="description">Sends a disconnect instruction to the server and closes the tunnel.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#endStream">endStream</a></b>(index)
</div>
<div class="description">Marks a currently-open stream as complete.</div>
</td>
</tr>
<tr>
<td class="attributes"><inner> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#-getAudioChannel">getAudioChannel</a></b>(index)
</div>
<div class="description">Returns the audio channel having the given index, creating a new channel
if necessary.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#getDisplay">getDisplay</a></b>()
</div>
<div class="description">Returns the underlying display of this Guacamole.Client.</div>
</td>
</tr>
<tr>
<td class="attributes"><inner> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#-getLayer">getLayer</a></b>(index)
</div>
<div class="description">Returns the layer with the given index, creating it if necessary.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#requestObjectInputStream">requestObjectInputStream</a></b>(index, name)
</div>
<div class="description">Requests read access to the input stream having the given name.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#sendAck">sendAck</a></b>(index, message, code)
</div>
<div class="description">Acknowledge receipt of a blob on the stream with the given index.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#sendBlob">sendBlob</a></b>(index, data)
</div>
<div class="description">Given the index of a file, writes a blob of data to that file.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#sendKeyEvent">sendKeyEvent</a></b>(pressed, keysym)
</div>
<div class="description">Sends a key event having the given properties as if the user
pressed or released a key.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#sendMouseState">sendMouseState</a></b>(mouseState)
</div>
<div class="description">Sends a mouse event having the properties provided by the given mouse
state.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#sendSize">sendSize</a></b>(width, height)
</div>
<div class="description">Sends the current size of the screen.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#setClipboard">setClipboard</a></b>(data)
</div>
<div class="description">Sets the clipboard of the remote client to the given text data.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class Guacamole.Client.">
<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.Client.html#event:onclipboard">onclipboard</a></b>(stream, mimetype)
</div>
<div class="description">Fired when the clipboard of the remote client is changing.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#event:onerror">onerror</a></b>(status)
</div>
<div class="description">Fired when an error is reported by the remote client, and the connection
is being closed.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#event:onfile">onfile</a></b>(stream, mimetype, filename)
</div>
<div class="description">Fired when a file stream is created.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#event:onfilesystem">onfilesystem</a></b>(object, name)
</div>
<div class="description">Fired when a filesystem object is created.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#event:onname">onname</a></b>(name)
</div>
<div class="description">Fired when the remote client sends a name update.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#event:onpipe">onpipe</a></b>(stream, mimetype, name)
</div>
<div class="description">Fired when a pipe stream is created.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#event:onstatechange">onstatechange</a></b>(state)
</div>
<div class="description">Fired whenever the state of this Guacamole.Client changes.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Client.html#event:onsync">onsync</a></b>(timestamp)
</div>
<div class="description">Fired whenever a sync instruction is received from the server, indicating
that the server is finished processing any input from the client and
has sent any results.</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.Client</b>(tunnel)
</div>
<div class="description">
Guacamole protocol client. Given a <a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a>,
automatically handles incoming and outgoing Guacamole instructions via the
provided tunnel, updating its display using one or more canvas elements.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a>}</span> <b>tunnel</b>
</dt>
<dd>The tunnel to use to send and receive
Guacamole instructions.</dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<div class="sectionTitle">
Field Detail
</div>
<a name="-audioChannels"> </a>
<div class="fixedFont"><inner>
<span class="light">{Object.<Number, Guacamole.AudioChannel>}</span>
<b>audioChannels</b>
</div>
<div class="description">
All audio channels currentl in use by the client. Initially, this will
be empty, but channels may be allocated by the server upon request.
</div>
<hr />
<a name="-display"> </a>
<div class="fixedFont"><inner>
<b>display</b>
</div>
<div class="description">
The underlying Guacamole display.
</div>
<hr />
<a name="-layers"> </a>
<div class="fixedFont"><inner>
<b>layers</b>
</div>
<div class="description">
All available layers and buffers
</div>
<hr />
<a name="-objects"> </a>
<div class="fixedFont"><inner>
<span class="light">{<a href="../symbols/Guacamole.Object.html">Guacamole.Object</a>[]}</span>
<b>objects</b>
</div>
<div class="description">
All current objects. The index of each object is dictated by the
Guacamole server.
</div>
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="connect"> </a>
<div class="fixedFont">
<b>connect</b>(data)
</div>
<div class="description">
Connects the underlying tunnel of this Guacamole.Client, passing the
given arbitrary data to the tunnel during the connection process.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>data</b>
</dt>
<dd>Arbitrary connection data to be sent to the underlying
tunnel during the connection process.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Throws:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.html#.Status">Guacamole.Status</a>}</span> <b></b>
</dt>
<dd>If an error occurs during connection.</dd>
</dl>
<hr />
<a name="createClipboardStream"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span>
<b>createClipboardStream</b>(mimetype, name)
</div>
<div class="description">
Opens a new clipboard object for writing, having the given mimetype.
</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 being sent.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the pipe.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span> The created file stream.</dd>
</dl>
<hr />
<a name="createFileStream"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span>
<b>createFileStream</b>(mimetype, filename)
</div>
<div class="description">
Opens a new file for writing, having the given index, mimetype and
filename.
</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 file being sent.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>filename</b>
</dt>
<dd>The filename of the file being sent.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span> The created file stream.</dd>
</dl>
<hr />
<a name="createObjectOutputStream"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span>
<b>createObjectOutputStream</b>(index, mimetype, name)
</div>
<div class="description">
Creates a new output stream associated with the given object and having
the given mimetype and name. The legality of a mimetype and name is
dictated by the object itself.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>index</b>
</dt>
<dd>The index of the object for which the output stream is being
created.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>mimetype</b>
</dt>
<dd>The mimetype of the data which will be sent to the output stream.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The defined name of an output stream within the given object.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span> An output stream which will write blobs to the named output stream
of the given object.</dd>
</dl>
<hr />
<a name="createPipeStream"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span>
<b>createPipeStream</b>(mimetype, name)
</div>
<div class="description">
Opens a new pipe for writing, having the given name and mimetype.
</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 being sent.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the pipe.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span> The created file stream.</dd>
</dl>
<hr />
<a name="disconnect"> </a>
<div class="fixedFont">
<b>disconnect</b>()
</div>
<div class="description">
Sends a disconnect instruction to the server and closes the tunnel.
</div>
<hr />
<a name="endStream"> </a>
<div class="fixedFont">
<b>endStream</b>(index)
</div>
<div class="description">
Marks a currently-open stream as complete.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>index</b>
</dt>
<dd>The index of the stream to end.</dd>
</dl>
<hr />
<a name="-getAudioChannel"> </a>
<div class="fixedFont"><inner>
<span class="light">{<a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a>}</span>
<b>getAudioChannel</b>(index)
</div>
<div class="description">
Returns the audio channel having the given index, creating a new channel
if necessary.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>index</b>
</dt>
<dd>The index of the audio channel to retrieve.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a>}</span> The audio channel having the given index.</dd>
</dl>
<hr />
<a name="getDisplay"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.Display.html">Guacamole.Display</a>}</span>
<b>getDisplay</b>()
</div>
<div class="description">
Returns the underlying display of this Guacamole.Client. The display
contains an Element which can be added to the DOM, causing the
display to become visible.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.Display.html">Guacamole.Display</a>}</span> The underlying display of this
Guacamole.Client.</dd>
</dl>
<hr />
<a name="-getLayer"> </a>
<div class="fixedFont"><inner>
<span class="light">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>|<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span>
<b>getLayer</b>(index)
</div>
<div class="description">
Returns the layer with the given index, creating it if necessary.
Positive indices refer to visible layers, an index of zero refers to
the default layer, and negative indices refer to buffers.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>index</b>
</dt>
<dd>The index of the layer to retrieve.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>|<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> The layer having the given index.</dd>
</dl>
<hr />
<a name="requestObjectInputStream"> </a>
<div class="fixedFont">
<b>requestObjectInputStream</b>(index, name)
</div>
<div class="description">
Requests read access to the input stream having the given name. If
successful, a new input stream will be created.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>index</b>
</dt>
<dd>The index of the object from which the input stream is being
requested.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the input stream to request.</dd>
</dl>
<hr />
<a name="sendAck"> </a>
<div class="fixedFont">
<b>sendAck</b>(index, message, code)
</div>
<div class="description">
Acknowledge receipt of a blob on the stream with the given index.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>index</b>
</dt>
<dd>The index of the stream associated with the
received blob.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>message</b>
</dt>
<dd>A human-readable message describing the error
or status.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>code</b>
</dt>
<dd>The error code, if any, or 0 for success.</dd>
</dl>
<hr />
<a name="sendBlob"> </a>
<div class="fixedFont">
<b>sendBlob</b>(index, data)
</div>
<div class="description">
Given the index of a file, writes a blob of data to that file.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>index</b>
</dt>
<dd>The index of the file to write to.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>data</b>
</dt>
<dd>Base64-encoded data to write to the file.</dd>
</dl>
<hr />
<a name="sendKeyEvent"> </a>
<div class="fixedFont">
<b>sendKeyEvent</b>(pressed, keysym)
</div>
<div class="description">
Sends a key event having the given properties as if the user
pressed or released a key.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Boolean}</span> <b>pressed</b>
</dt>
<dd>Whether the key is pressed (true) or released
(false).</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>keysym</b>
</dt>
<dd>The keysym of the key being pressed or released.</dd>
</dl>
<hr />
<a name="sendMouseState"> </a>
<div class="fixedFont">
<b>sendMouseState</b>(mouseState)
</div>
<div class="description">
Sends a mouse event having the properties provided by the given mouse
state.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a>}</span> <b>mouseState</b>
</dt>
<dd>The state of the mouse to send
in the mouse event.</dd>
</dl>
<hr />
<a name="sendSize"> </a>
<div class="fixedFont">
<b>sendSize</b>(width, height)
</div>
<div class="description">
Sends the current size of the screen.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>width</b>
</dt>
<dd>The width of the screen.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>height</b>
</dt>
<dd>The height of the screen.</dd>
</dl>
<hr />
<a name="setClipboard"> </a>
<div class="fixedFont">
<b>setClipboard</b>(data)
</div>
<div class="description">
Sets the clipboard of the remote client to the given text data.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>data</b>
</dt>
<dd>The data to send as the clipboard contents.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Deprecated:</dt>
<dt>
Use createClipboardStream() instead.
</dt>
</dl>
<!-- ============================== event details ========================= -->
<div class="sectionTitle">
Event Detail
</div>
<a name="event:onclipboard"> </a>
<div class="fixedFont">
<b>onclipboard</b>(stream, mimetype)
</div>
<div class="description">
Fired when the clipboard of the remote client is changing.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.InputStream.html">Guacamole.InputStream</a>}</span> <b>stream</b>
</dt>
<dd>The stream that will receive
clipboard data from the server.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>mimetype</b>
</dt>
<dd>The mimetype of the data which will be received.</dd>
</dl>
<hr />
<a name="event:onerror"> </a>
<div class="fixedFont">
<b>onerror</b>(status)
</div>
<div class="description">
Fired when an error is reported by the remote client, and the connection
is being closed.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.html#.Status">Guacamole.Status</a>}</span> <b>status</b>
</dt>
<dd>A status object which describes the
error.</dd>
</dl>
<hr />
<a name="event:onfile"> </a>
<div class="fixedFont">
<b>onfile</b>(stream, mimetype, filename)
</div>
<div class="description">
Fired when a file stream is created. The stream provided to this event
handler will contain its own event handlers for received data.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.InputStream.html">Guacamole.InputStream</a>}</span> <b>stream</b>
</dt>
<dd>The stream that will receive data
from the server.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>mimetype</b>
</dt>
<dd>The mimetype of the file received.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>filename</b>
</dt>
<dd>The name of the file received.</dd>
</dl>
<hr />
<a name="event:onfilesystem"> </a>
<div class="fixedFont">
<b>onfilesystem</b>(object, name)
</div>
<div class="description">
Fired when a filesystem object is created. The object provided to this
event handler will contain its own event handlers and functions for
requesting and handling data.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Object.html">Guacamole.Object</a>}</span> <b>object</b>
</dt>
<dd>The created filesystem object.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the filesystem.</dd>
</dl>
<hr />
<a name="event:onname"> </a>
<div class="fixedFont">
<b>onname</b>(name)
</div>
<div class="description">
Fired when the remote client sends a name update.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The new name of this client.</dd>
</dl>
<hr />
<a name="event:onpipe"> </a>
<div class="fixedFont">
<b>onpipe</b>(stream, mimetype, name)
</div>
<div class="description">
Fired when a pipe stream is created. The stream provided to this event
handler will contain its own event handlers for received data;
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.InputStream.html">Guacamole.InputStream</a>}</span> <b>stream</b>
</dt>
<dd>The stream that will receive data
from the server.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>mimetype</b>
</dt>
<dd>The mimetype of the data which will be received.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the pipe.</dd>
</dl>
<hr />
<a name="event:onstatechange"> </a>
<div class="fixedFont">
<b>onstatechange</b>(state)
</div>
<div class="description">
Fired whenever the state of this Guacamole.Client changes.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>state</b>
</dt>
<dd>The new state of the client.</dd>
</dl>
<hr />
<a name="event:onsync"> </a>
<div class="fixedFont">
<b>onsync</b>(timestamp)
</div>
<div class="description">
Fired whenever a sync instruction is received from the server, indicating
that the server is finished processing any input from the client and
has sent any results.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>timestamp</b>
</dt>
<dd>The timestamp associated with the sync
instruction.</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 Tue Sep 08 2015 22:31:29 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>