Gjsify LogoGjsify Logo

The #SpiceSession struct is opaque and should not be accessed directly.

Hierarchy

Index

Constructors

Properties

ca: Uint8Array

CA certificates in PEM format. The text data can contain several CA certificates identified by:

-----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE-----

caFile: string

File holding the CA certificates for the host the client is connecting to

cacheSize: number

Images cache size. If 0, don't set.

certSubject: string
ciphers: string
clientSockets: boolean
colorDepth: number

Display color depth to set on new display channels. If 0, don't set.

disableEffects: string[]

A string array of effects to disable. The settings will be applied on new display channels. The following effets can be disabled "wallpaper", "font-smooth", "animation", and "all", which will disable all the effects. If NULL, don't apply changes.

enableAudio: boolean

If set to TRUE, the audio channels will be enabled for playback and recording.

enableSmartcard: boolean

If set to TRUE, the smartcard channel will be enabled and smartcard events will be forwarded to the guest

enableUsbredir: boolean

If set to TRUE, the usbredir channel will be enabled and USB devices can be redirected to the guest

gTypeInstance: TypeInstance
glScanout: boolean

Whether to enable gl-scanout (Unix only). Set to TRUE by default on EGL-enabled host, unless SPICE_DISABLE_GL_SCANOUT environment variable is set.

glzWindowSize: number

Glz window size. If 0, don't set.

host: string

URL of the SPICE host to connect to

inhibitKeyboardGrab: boolean
migrationState: SessionMigration

#SpiceSessionMigration bit field indicating if a migration is in progress

name: string

Spice server name.

parent: GObject.Object
password: string

TLS password to use

port: string

Port to connect to for unencrypted sessions

protocol: number

Version of the SPICE protocol to use

proxy: string

URI to the proxy server to use when doing network connection. of the form [:port] ]]>

pubkey: Uint8Array
readOnly: boolean

Whether this connection is read-only mode.

secureChannels: string[]

A string array of channel types to be secured.

shareDirRo: boolean

Whether to share the directory read-only.

sharedDir: string

Location of the shared directory

smartcardCertificates: string[]

This property is used when one wants to simulate a smartcard with no hardware smartcard reader. If it's set to a NULL-terminated string array containing the names of 3 valid certificates, these will be used to simulate a smartcard in the guest See also spice_smartcard_manager_insert_card()

smartcardDb: string

Path to the NSS certificate database containing the certificates to use to simulate a software smartcard

tlsPort: string

Port to connect to for TLS sessions

unixPath: string

Path of the Unix socket to connect to

uri: string

URI of the SPICE host to connect to. The URI is of the form spice://hostname?port=XXX or spice://hostname?tls_port=XXX

username: string

Username to use

uuid: object

Spice server uuid.

#SpiceSessionVerify bit field indicating which parts of the peer certificate should be checked

name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • connect(sigName: "channel-destroy", callback: Session_ChannelDestroySignalCallback): number
  • connect(sigName: "channel-new", callback: Session_ChannelNewSignalCallback): number
  • connect(sigName: "disconnected", callback: Session_DisconnectedSignalCallback): number
  • connect(sigName: "mm-time-reset", callback: Session_MmTimeResetSignalCallback): number
  • connect(sigName: "notify::ca", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::ca-file", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::cache-size", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::cert-subject", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::ciphers", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::client-sockets", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::color-depth", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::disable-effects", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::enable-audio", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::enable-smartcard", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::enable-usbredir", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::gl-scanout", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::glz-window-size", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::host", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::inhibit-keyboard-grab", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::migration-state", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::name", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::password", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::port", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::protocol", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::proxy", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::pubkey", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::read-only", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::secure-channels", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::share-dir-ro", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::shared-dir", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::smartcard-certificates", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::smartcard-db", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::tls-port", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::unix-path", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::uri", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::username", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::uuid", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::verify", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    • sigName: "notify::ca"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::ca-file"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::cache-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::cert-subject"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::ciphers"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::client-sockets"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::color-depth"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::disable-effects"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::enable-audio"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::enable-smartcard"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::enable-usbredir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::gl-scanout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::glz-window-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::host"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::inhibit-keyboard-grab"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::migration-state"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::password"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::pubkey"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::read-only"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::secure-channels"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::share-dir-ro"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::shared-dir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::smartcard-certificates"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::smartcard-db"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::tls-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::unix-path"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::uri"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::username"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::uuid"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::verify"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • disconnect(): void
  • emit(sigName: "channel-destroy", ...args: any[]): void
  • emit(sigName: "channel-new", ...args: any[]): void
  • emit(sigName: "disconnected", ...args: any[]): void
  • emit(sigName: "mm-time-reset", ...args: any[]): void
  • emit(sigName: "notify::ca", ...args: any[]): void
  • emit(sigName: "notify::ca-file", ...args: any[]): void
  • emit(sigName: "notify::cache-size", ...args: any[]): void
  • emit(sigName: "notify::cert-subject", ...args: any[]): void
  • emit(sigName: "notify::ciphers", ...args: any[]): void
  • emit(sigName: "notify::client-sockets", ...args: any[]): void
  • emit(sigName: "notify::color-depth", ...args: any[]): void
  • emit(sigName: "notify::disable-effects", ...args: any[]): void
  • emit(sigName: "notify::enable-audio", ...args: any[]): void
  • emit(sigName: "notify::enable-smartcard", ...args: any[]): void
  • emit(sigName: "notify::enable-usbredir", ...args: any[]): void
  • emit(sigName: "notify::gl-scanout", ...args: any[]): void
  • emit(sigName: "notify::glz-window-size", ...args: any[]): void
  • emit(sigName: "notify::host", ...args: any[]): void
  • emit(sigName: "notify::inhibit-keyboard-grab", ...args: any[]): void
  • emit(sigName: "notify::migration-state", ...args: any[]): void
  • emit(sigName: "notify::name", ...args: any[]): void
  • emit(sigName: "notify::password", ...args: any[]): void
  • emit(sigName: "notify::port", ...args: any[]): void
  • emit(sigName: "notify::protocol", ...args: any[]): void
  • emit(sigName: "notify::proxy", ...args: any[]): void
  • emit(sigName: "notify::pubkey", ...args: any[]): void
  • emit(sigName: "notify::read-only", ...args: any[]): void
  • emit(sigName: "notify::secure-channels", ...args: any[]): void
  • emit(sigName: "notify::share-dir-ro", ...args: any[]): void
  • emit(sigName: "notify::shared-dir", ...args: any[]): void
  • emit(sigName: "notify::smartcard-certificates", ...args: any[]): void
  • emit(sigName: "notify::smartcard-db", ...args: any[]): void
  • emit(sigName: "notify::tls-port", ...args: any[]): void
  • emit(sigName: "notify::unix-path", ...args: any[]): void
  • emit(sigName: "notify::uri", ...args: any[]): void
  • emit(sigName: "notify::username", ...args: any[]): void
  • emit(sigName: "notify::uuid", ...args: any[]): void
  • emit(sigName: "notify::verify", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getReadOnly(): boolean
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • hasChannelType(type: number): boolean
  • See if there is a type channel in the channels associated with this session.

    Parameters

    • type: number

      a #SpiceChannel:channel-type

    Returns boolean

  • isFloating(): boolean
  • isForMigration(): boolean
  • During seamless migration, channels may be created to establish a connection with the target, but they are temporary and should only handle migration steps. In order to avoid other interactions with the client, channels should check this value.

    Returns boolean

  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "channel-destroy", callback: Session_ChannelDestroySignalCallback): EventEmitter
  • off(sigName: "channel-new", callback: Session_ChannelNewSignalCallback): EventEmitter
  • off(sigName: "disconnected", callback: Session_DisconnectedSignalCallback): EventEmitter
  • off(sigName: "mm-time-reset", callback: Session_MmTimeResetSignalCallback): EventEmitter
  • off(sigName: "notify::ca", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::ca-file", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::cache-size", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::cert-subject", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::ciphers", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::client-sockets", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::color-depth", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::disable-effects", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::enable-audio", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::enable-smartcard", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::enable-usbredir", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::gl-scanout", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::glz-window-size", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::host", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::inhibit-keyboard-grab", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::migration-state", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::name", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::password", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::port", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::protocol", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::proxy", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::pubkey", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::read-only", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::secure-channels", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::share-dir-ro", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::shared-dir", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::smartcard-certificates", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::smartcard-db", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::tls-port", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::unix-path", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::uri", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::username", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::uuid", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::verify", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ca"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ca-file"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cache-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cert-subject"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ciphers"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::client-sockets"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::color-depth"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::disable-effects"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-audio"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-smartcard"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-usbredir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::gl-scanout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::glz-window-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inhibit-keyboard-grab"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::migration-state"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::password"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::pubkey"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::read-only"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::secure-channels"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::share-dir-ro"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::shared-dir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::smartcard-certificates"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::smartcard-db"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::tls-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::unix-path"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uri"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::username"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uuid"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::verify"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "channel-destroy", callback: Session_ChannelDestroySignalCallback, after?: boolean): EventEmitter
  • on(sigName: "channel-new", callback: Session_ChannelNewSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "disconnected", callback: Session_DisconnectedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "mm-time-reset", callback: Session_MmTimeResetSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::ca", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::ca-file", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::cache-size", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::cert-subject", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::ciphers", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::client-sockets", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::color-depth", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::disable-effects", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::enable-audio", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::enable-smartcard", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::enable-usbredir", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::gl-scanout", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::glz-window-size", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::host", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::inhibit-keyboard-grab", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::migration-state", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::password", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::protocol", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::proxy", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::pubkey", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::read-only", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::secure-channels", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::share-dir-ro", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::shared-dir", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::smartcard-certificates", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::smartcard-db", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::tls-port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::unix-path", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::uri", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::username", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::uuid", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::verify", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ca"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ca-file"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cache-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cert-subject"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ciphers"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::client-sockets"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::color-depth"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::disable-effects"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-audio"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-smartcard"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-usbredir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::gl-scanout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::glz-window-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inhibit-keyboard-grab"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::migration-state"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::password"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::pubkey"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::read-only"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::secure-channels"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::share-dir-ro"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::shared-dir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::smartcard-certificates"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::smartcard-db"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::tls-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::unix-path"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uri"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::username"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uuid"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::verify"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "channel-destroy", callback: Session_ChannelDestroySignalCallback, after?: boolean): EventEmitter
  • once(sigName: "channel-new", callback: Session_ChannelNewSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "disconnected", callback: Session_DisconnectedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "mm-time-reset", callback: Session_MmTimeResetSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::ca", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::ca-file", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::cache-size", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::cert-subject", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::ciphers", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::client-sockets", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::color-depth", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::disable-effects", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::enable-audio", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::enable-smartcard", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::enable-usbredir", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::gl-scanout", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::glz-window-size", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::host", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::inhibit-keyboard-grab", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::migration-state", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::password", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::protocol", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::proxy", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::pubkey", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::read-only", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::secure-channels", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::share-dir-ro", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::shared-dir", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::smartcard-certificates", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::smartcard-db", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::tls-port", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::unix-path", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::uri", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::username", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::uuid", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::verify", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ca"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ca-file"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cache-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cert-subject"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ciphers"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::client-sockets"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::color-depth"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::disable-effects"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-audio"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-smartcard"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::enable-usbredir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::gl-scanout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::glz-window-size"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::host"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inhibit-keyboard-grab"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::migration-state"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::password"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::pubkey"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::read-only"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::secure-channels"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::share-dir-ro"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::shared-dir"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::smartcard-certificates"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::smartcard-db"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::tls-port"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::unix-path"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uri"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::username"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::uuid"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::verify"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • openFd(fd: number): boolean
  • Open the session using the provided fd socket file descriptor. This is useful if you create the fd yourself, for example to setup a SSH tunnel.

    Note however that additional sockets will be needed by all the channels created for session so users of this API should hook into SpiceChannel::open-fd signal for each channel they are interested in, and create and pass a new socket to the channel using #spice_channel_open_fd, in the signal callback.

    If fd is -1, a valid fd will be requested later via the SpiceChannel::open-fd signal. Typically, you would want to just pass -1 as fd this call since you will have to hook to SpiceChannel::open-fd signal anyway.

    Parameters

    • fd: number

      a file descriptor (socket) or -1

    Returns boolean

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method