guacamole-client-typedefs/lib/OutputStream.d.ts

Work in progress typescript definitions based on http://guacamole.apache.org/doc/guacamole-common-js/

/// <reference path="./Status.d.ts" />

declare module 'guacamole-client' {
  /**
   * Abstract stream which can receive data.
   * 
   * @param client The client owning this stream.
   * @param index The index of this stream.
   */
  export class OutputStream {
    constructor(client: Client, index: number);

    /**
     * The index of this stream.
     */
    readonly index: number;

    /**
     * Writes the given base64-encoded data to this stream as a blob.
     * @param data The base64-encoded data to send.
     */
    sendBlob(data64: string): void;

    /**
     * Closes this stream.
     */
    sendEnd(): void;

    /**
     * Fired whenever an acknowledgement is received from the server, indicating
     * that a stream operation has completed, or an error has occurred.
     * @event
     * @param status The status of the operation.
     */
    onack: null | ((status: Status) => void);
  }
}