Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

active_connection: NM.ActiveConnection

The #NMActiveConnection object that "owns" this device during activation.

autoconnect: boolean

Whether the device can auto-activate a connection.

The property setter is a synchronous D-Bus call. This is deprecated since 1.22.

available_connections: NM.RemoteConnection[]

The available connections of the device

capabilities: NM.DeviceCapabilities

The capabilities of the device.

client: NM.Client

The NMClient instance as returned by nm_object_get_client().

When an NMObject gets removed from the NMClient cache, the NMObject:path property stays unchanged, but this client instance gets reset to %NULL. You can use this property to track removal of the object from the cache.

device_type: NM.DeviceType

The numeric type of the device.

dhcp4_config: DhcpConfig

The IPv4 #NMDhcpConfig of the device.

dhcp6_config: DhcpConfig

The IPv6 #NMDhcpConfig of the device.

driver: string

The driver of the device.

driver_version: string

The version of the device driver.

firmware_missing: boolean

When %TRUE indicates the device is likely missing firmware required for its operation.

firmware_version: string

The firmware version of the device.

g_type_instance: TypeInstance
hw_address: string

The hardware address of the device.

interface: string

The interface of the device.

interface_flags: number

The interface flags.

ip4_config: IPConfig

The #NMIP4Config of the device.

ip4_connectivity: NM.ConnectivityState

The IPv4 connectivity state of the device.

ip6_config: IPConfig

The IPv6 #NMIPConfig of the device.

ip6_connectivity: NM.ConnectivityState

The IPv6 connectivity state of the device.

ip_interface: string

The IP interface of the device which should be used for all IP-related operations like addressing and routing.

lldp_neighbors: object[]

The LLDP neighbors.

managed: boolean

Whether the device is managed by NetworkManager.

metered: number

Whether the device is metered.

mtu: number

The MTU of the device.

nm_plugin_missing: boolean

When %TRUE indicates that the NetworkManager plugin for the device is not installed.

path: string

The device path as exposed by the udev property ID_PATH.

The string is backslash escaped (C escaping) for invalid characters. The escaping can be reverted with g_strcompress(), however the result may not be valid UTF-8.

physical_port_id: string

The physical port ID of the device. (See nm_device_get_physical_port_id().)

ports: object[]

The port devices of the controller device. For devices that cannot be controllers this is likely to be always empty.

product: string

The product string of the device.

real: boolean

Whether the device is real or is a placeholder device that could be created automatically by NetworkManager if one of its #NMDevice:available-connections was activated.

The state of the device.

state_reason: number

The reason for the device state.

udi: string

An operating-system specific device hardware identifier; this is not unique to a specific hardware device across reboots or hotplugs. It is an opaque string which for some device types (Bluetooth, Modem) contains an identifier provided by the underlying hardware service daemon such as Bluez or ModemManager, and clients can use this property to request more information about the device from those services.

vendor: string

The vendor string of the device.

$gtype: GType<NM.Device>
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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: 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: "state-changed", callback: NM.Device_StateChangedSignalCallback): number
  • connect(sigName: "notify::active-connection", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::autoconnect", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::available-connections", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::capabilities", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::device-type", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::dhcp4-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::dhcp6-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::driver", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::driver-version", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::firmware-missing", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::firmware-version", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::hw-address", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::interface", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::interface-flags", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ip-interface", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ip4-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ip4-connectivity", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ip6-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ip6-connectivity", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::lldp-neighbors", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::managed", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::metered", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::mtu", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::nm-plugin-missing", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::path", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::physical-port-id", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ports", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::product", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::real", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::state", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::state-reason", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::udi", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::vendor", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::client", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "state-changed", callback: NM.Device_StateChangedSignalCallback): number
  • connect_after(sigName: "notify::active-connection", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::autoconnect", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::available-connections", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::capabilities", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::device-type", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::dhcp4-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::dhcp6-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::driver", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::driver-version", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::firmware-missing", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::firmware-version", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::hw-address", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::interface", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::interface-flags", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ip-interface", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ip4-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ip4-connectivity", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ip6-config", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ip6-connectivity", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::lldp-neighbors", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::managed", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::metered", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::mtu", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::nm-plugin-missing", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::path", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::physical-port-id", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ports", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::product", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::real", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::state", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::state-reason", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::udi", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::vendor", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::client", callback: (($obj: NM.Device, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • Validates a given connection for a given #NMDevice object and returns whether the connection may be activated with the device. For example if device is a Wi-Fi device that supports only WEP encryption, the connection will only be valid if it is a Wi-Fi connection which describes a WEP or open network, and will not be valid if it describes a WPA network, or if it is an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the device.

    This function does the same as nm_device_connection_valid(), i.e. checking compatibility of the given device and connection. But, in addition, it sets GError when FALSE is returned.

    Parameters

    • connection: NM.Connection

      an #NMConnection to validate against device

    Returns boolean

  • Validates a given connection for a given #NMDevice object and returns whether the connection may be activated with the device. For example if device is a Wi-Fi device that supports only WEP encryption, the connection will only be valid if it is a Wi-Fi connection which describes a WEP or open network, and will not be valid if it describes a WPA network, or if it is an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the device.

    Parameters

    • connection: NM.Connection

      an #NMConnection to validate against device

    Returns boolean

  • disconnect(id: number): void
  • Asynchronously begins disconnecting the device if currently connected, and prevents the device from automatically connecting to networks until the next manual network connection request.

    Parameters

    Returns void

  • emit(sigName: "state-changed", new_state: number, old_state: number, reason: number, ...args: any[]): void
  • emit(sigName: "notify::active-connection", ...args: any[]): void
  • emit(sigName: "notify::autoconnect", ...args: any[]): void
  • emit(sigName: "notify::available-connections", ...args: any[]): void
  • emit(sigName: "notify::capabilities", ...args: any[]): void
  • emit(sigName: "notify::device-type", ...args: any[]): void
  • emit(sigName: "notify::dhcp4-config", ...args: any[]): void
  • emit(sigName: "notify::dhcp6-config", ...args: any[]): void
  • emit(sigName: "notify::driver", ...args: any[]): void
  • emit(sigName: "notify::driver-version", ...args: any[]): void
  • emit(sigName: "notify::firmware-missing", ...args: any[]): void
  • emit(sigName: "notify::firmware-version", ...args: any[]): void
  • emit(sigName: "notify::hw-address", ...args: any[]): void
  • emit(sigName: "notify::interface", ...args: any[]): void
  • emit(sigName: "notify::interface-flags", ...args: any[]): void
  • emit(sigName: "notify::ip-interface", ...args: any[]): void
  • emit(sigName: "notify::ip4-config", ...args: any[]): void
  • emit(sigName: "notify::ip4-connectivity", ...args: any[]): void
  • emit(sigName: "notify::ip6-config", ...args: any[]): void
  • emit(sigName: "notify::ip6-connectivity", ...args: any[]): void
  • emit(sigName: "notify::lldp-neighbors", ...args: any[]): void
  • emit(sigName: "notify::managed", ...args: any[]): void
  • emit(sigName: "notify::metered", ...args: any[]): void
  • emit(sigName: "notify::mtu", ...args: any[]): void
  • emit(sigName: "notify::nm-plugin-missing", ...args: any[]): void
  • emit(sigName: "notify::path", ...args: any[]): void
  • emit(sigName: "notify::physical-port-id", ...args: any[]): void
  • emit(sigName: "notify::ports", ...args: any[]): void
  • emit(sigName: "notify::product", ...args: any[]): void
  • emit(sigName: "notify::real", ...args: any[]): void
  • emit(sigName: "notify::state", ...args: any[]): void
  • emit(sigName: "notify::state-reason", ...args: any[]): void
  • emit(sigName: "notify::udi", ...args: any[]): void
  • emit(sigName: "notify::vendor", ...args: any[]): void
  • emit(sigName: "notify::client", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Filters a given array of connections for a given #NMDevice object and returns connections which may be activated with the device. For example if device is a Wi-Fi device that supports only WEP encryption, the returned array will contain any Wi-Fi connections in connections that allow connection to unencrypted or WEP-enabled SSIDs. The returned array will not contain Ethernet, Bluetooth, Wi-Fi WPA connections, or any other connection that is incompatible with the device. To get the full list of connections see nm_client_get_connections().

    Parameters

    • connections: NM.Connection[]

      an array of #NMConnections to filter

    Returns NM.Connection[]

  • force_floating(): 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

  • freeze_notify(): 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

  • Fetch the currently applied connection on the device.

    Parameters

    • flags: number

      the flags argument. Currently, this value must always be zero.

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns [NM.Connection, number]

  • Asynchronously begins and gets the currently applied connection.

    Parameters

    • flags: number

      the flags argument. Currently, this value must always be zero.

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the reapply operation completes

    Returns void

  • get_autoconnect(): boolean
  • Returns the #NMClient instance in which object is cached. Also, if the object got removed from the client cached, this returns %NULL. So it can be used to check whether the object is still alive.

    Returns NM.Client

  • The connectivity state of the device for given address family. Supported address families are %AF_INET for IPv4, %AF_INET6 for IPv6 or %AF_UNSPEC for any.

    Parameters

    • addr_family: number

      network address family

    Returns NM.ConnectivityState

  • get_data(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

  • get_description(): string
  • Gets the current IPv4 #NMDhcpConfig associated with the #NMDevice.

    You can alternatively use nm_active_connection_get_dhcp4_config(), which also works with VPN connections.

    Returns DhcpConfig

  • Gets the current IPv6 #NMDhcpConfig associated with the #NMDevice.

    You can alternatively use nm_active_connection_get_dhcp6_config(), which also works with VPN connections.

    Returns DhcpConfig

  • get_driver(): string
  • get_driver_version(): string
  • get_firmware_missing(): boolean
  • Indicates that firmware required for the device's operation is likely to be missing.

    Returns boolean

  • get_firmware_version(): string
  • get_hw_address(): string
  • get_iface(): string
  • Gets the current IPv4 #NMIPConfig associated with the #NMDevice.

    You can alternatively use nm_active_connection_get_ip4_config(), which also works with VPN connections.

    Returns IPConfig

  • Gets the current IPv6 #NMIPConfig associated with the #NMDevice.

    You can alternatively use nm_active_connection_get_ip6_config(), which also works with VPN connections.

    Returns IPConfig

  • get_ip_iface(): string
  • Gets the IP interface name of the #NMDevice over which IP traffic flows when the device is in the ACTIVATED state.

    Returns string

  • get_managed(): boolean
  • get_mtu(): number
  • get_nm_plugin_missing(): boolean
  • get_path(): string
  • get_physical_port_id(): string
  • Gets the physical port ID of the #NMDevice. If non-%NULL, this is an opaque string that can be used to recognize when seemingly-unrelated #NMDevices are actually just different virtual ports on a single physical port. (Eg, NPAR / SR-IOV.)

    Returns string

  • get_product(): string
  • get_property(property_name?: 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 property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_setting_type(): GType<unknown>
  • get_type_description(): string
  • get_udi(): string
  • get_vendor(): string
  • 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

  • is_floating(): boolean
  • is_real(): boolean
  • is_software(): boolean
  • notify(property_name: 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

    • property_name: 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

  • Attempts to update device with changes to the currently active connection made since it was last applied.

    Parameters

    • connection: NM.Connection

      the #NMConnection to replace the applied settings with or %NULL to reuse existing

    • version_id: number

      zero or the expected version id of the applied connection. If specified and the version id mismatches, the call fails without modification. This allows to catch concurrent accesses.

    • flags: number

      always set this to zero

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns boolean

  • Asynchronously begins an attempt to update device with changes to the currently active connection made since it was last applied.

    Parameters

    • connection: NM.Connection

      the #NMConnection to replace the applied settings with or %NULL to reuse existing

    • version_id: number

      zero or the expected version id of the applied connection. If specified and the version id mismatches, the call fails without modification. This allows to catch concurrent accesses.

    • flags: number

      always set this to zero

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the reapply operation completes

    Returns void

  • 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

  • run_dispose(): 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

  • set_autoconnect(autoconnect: boolean): void
  • Enables or disables automatic activation of the #NMDevice.

    Parameters

    • autoconnect: boolean

      %TRUE to enable autoconnecting

    Returns void

  • set_data(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

  • set_managed(managed: boolean): void
  • Enables or disables management of #NMDevice by NetworkManager.

    Parameters

    • managed: boolean

      %TRUE to make the device managed by NetworkManager.

    Returns void

  • set_property(property_name: string, value?: any): void
  • steal_data(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

  • steal_qdata(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

  • thaw_notify(): 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

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(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

  • compat_control(what: number, data: object): number
  • disambiguate_names(devices: NM.Device[]): string[]
  • Generates a list of short-ish unique presentation names for the devices in devices.

    Parameters

    • devices: NM.Device[]

      an array of #NMDevice

    Returns string[]

  • 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

    • g_iface: TypeInterface

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

    • property_name: 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

    • g_iface: 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

    • g_iface: 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

    • object_type: 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