Class: Object

Guacamole.Object

new Object(client, index)

An object used by the Guacamole client to house arbitrarily-many named input and output streams.
Parameters:
Name Type Description
client Guacamole.Client The client owning this object.
index Number The index of this object.
Source:

Members

(static, constant) ROOT_STREAM :String

The reserved name denoting the root stream of any object. The contents of the root stream MUST be a JSON map of stream name to mimetype.
Type:
  • String
Source:

(static, constant) STREAM_INDEX_MIMETYPE :String

The mimetype of a stream containing JSON which maps available stream names to their corresponding mimetype. The root stream of a Guacamole.Object MUST have this mimetype.
Type:
  • String
Source:

index :Number

The index of this object.
Type:
  • Number
Source:

Methods

createOutputStream(mimetype, name) → {Guacamole.OutputStream}

Creates a new output stream associated with this object and having the given mimetype and name. The legality of a mimetype and name is dictated by the object itself.
Parameters:
Name Type Description
mimetype String The mimetype of the data which will be sent to the output stream.
name String The defined name of an output stream within this object.
Source:
Returns:
An output stream which will write blobs to the named output stream of this object.
Type
Guacamole.OutputStream

requestInputStream(name, bodyCallbackopt)

Requests read access to the input stream having the given name. If successful, a new input stream will be created.
Parameters:
Name Type Attributes Description
name String The name of the input stream to request.
bodyCallback function <optional>
 The callback to invoke when the body of the requested input stream is received. This callback will be provided a Guacamole.InputStream and its mimetype as its two only arguments. If the onbody handler of this object is overridden, this callback will not be invoked.
Source:

Events

onbody

Called when this object receives the body of a requested input stream. By default, all objects will invoke the callbacks provided to their requestInputStream() functions based on the name of the stream requested. This behavior can be overridden by specifying a different handler here.
Parameters:
Name Type Description
inputStream Guacamole.InputStream The input stream of the received body.
mimetype String The mimetype of the data being received.
name String The name of the stream whose body has been received.
Source:

onundefine

Called when this object is being undefined. Once undefined, no further communication involving this object may occur.
Source: