Gjsify LogoGjsify Logo

Wi-Fi Settings

Hierarchy

Index

Constructors

Properties

apIsolation: Ternary

Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from %NM_TERNARY_DEFAULT only when the interface is configured in AP mode.

If set to %NM_TERNARY_TRUE, devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.

If set to %NM_TERNARY_FALSE, devices can talk to each other.

When set to %NM_TERNARY_DEFAULT, the global default is used; in case the global default is unspecified it is assumed to be %NM_TERNARY_FALSE.

band: string

802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.

bssid: string

If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.

channel: number

Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.

clonedMacAddress: string

If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.

Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.

If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).

On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

gTypeInstance: TypeInstance
generateMacAddressMask: string

With #NMSettingWireless:cloned-mac-address setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

If the property is %NULL, it is eligible to be overwritten by a default connection setting. If the value is still %NULL or an empty string, the default is to create a locally-administered, unicast MAC address.

If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.

If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

hidden: boolean

If %TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.

In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.

In AP mode, the created network does not broadcast its SSID.

Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.

macAddress: string

If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

macAddressBlacklist: string[]

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

macAddressRandomization: number

One of %NM_SETTING_MAC_RANDOMIZATION_DEFAULT (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), %NM_SETTING_MAC_RANDOMIZATION_NEVER (never randomize the MAC address), or %NM_SETTING_MAC_RANDOMIZATION_ALWAYS (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'.

mode: string

Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.

mtu: number

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

name: string

The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "802-11-wireless" or "802-3-ethernet".

powersave: number

One of %NM_SETTING_WIRELESS_POWERSAVE_DISABLE (disable Wi-Fi power saving), %NM_SETTING_WIRELESS_POWERSAVE_ENABLE (enable Wi-Fi power saving), %NM_SETTING_WIRELESS_POWERSAVE_IGNORE (don't touch currently configure setting) or %NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (use the globally configured value). All other values are reserved.

rate: number

If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.

seenBssids: string[]

A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.

ssid: any

SSID of the Wi-Fi network. Must be specified.

txPower: number

If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.

wakeOnWlan: number

The #NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of %NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY, %NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT, %NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC, %NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE, %NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST, %NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE, %NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE, %NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP or the special values %NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (to use global settings) and %NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (to disable management of Wake-on-LAN in NetworkManager).

name: string

Methods

  • addMacBlacklistItem(mac: string): boolean
  • Adds a new MAC address to the #NMSettingWireless:mac-address-blacklist property.

    Parameters

    • mac: string

      the MAC address string (hex-digits-and-colons notation) to blacklist

    Returns boolean

  • addSeenBssid(bssid: string): boolean
  • Adds a new Wi-Fi AP's BSSID to the previously seen BSSID list of the setting. NetworkManager now tracks previously seen BSSIDs internally so this function no longer has much use. Actually, changes you make using this function will not be preserved.

    Parameters

    • bssid: string

      the new BSSID to add to the list

    Returns boolean

  • Given a #NMSettingWireless and an optional #NMSettingWirelessSecurity, determine if the configuration given by the settings is compatible with the security of an access point using that access point's capability flags and mode. Useful for clients that wish to filter a set of connections against a set of access points and determine which connections are compatible with which access points.

    Parameters

    Returns boolean

  • 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

  • clearMacBlacklistItems(): void
  • Compares two #NMSetting objects for similarity, with comparison behavior modified by a set of flags. See the documentation for #NMSettingCompareFlags for a description of each flag's behavior.

    Parameters

    Returns boolean

  • connect(sigName: "notify::ap-isolation", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::band", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::bssid", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::channel", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::cloned-mac-address", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::generate-mac-address-mask", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::hidden", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::mac-address", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::mac-address-blacklist", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::mac-address-randomization", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::mode", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::mtu", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::powersave", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::rate", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::seen-bssids", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::ssid", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::tx-power", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::wake-on-wlan", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::name", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::cloned-mac-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::generate-mac-address-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::mac-address-blacklist"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::mac-address-randomization"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::wake-on-wlan"
    • 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: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Compares two #NMSetting objects for similarity, with comparison behavior modified by a set of flags. See the documentation for #NMSettingCompareFlags for a description of each flag's behavior. If the settings differ, the keys of each setting that differ from the other are added to results, mapped to one or more #NMSettingDiffResult values.

    Parameters

    • b: NM.Setting

      a second #NMSetting to compare with the first

    • flags: NM.SettingCompareFlags

      compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT

    • invertResults: boolean

      this parameter is used internally by libnm and should be set to %FALSE. If %TRUE inverts the meaning of the #NMSettingDiffResult.

    • results: HashTable<string | number | symbol, string | number | boolean>

      if the settings differ, on return a hash table mapping the differing keys to one or more %NMSettingDiffResult values OR-ed together. If the settings do not differ, any hash table passed in is unmodified. If no hash table is passed in and the settings differ, a new one is created and returned.

    Returns [boolean, HashTable<string | number | symbol, string | number | boolean>]

  • emit(sigName: "notify::ap-isolation", ...args: any[]): void
  • emit(sigName: "notify::band", ...args: any[]): void
  • emit(sigName: "notify::bssid", ...args: any[]): void
  • emit(sigName: "notify::channel", ...args: any[]): void
  • emit(sigName: "notify::cloned-mac-address", ...args: any[]): void
  • emit(sigName: "notify::generate-mac-address-mask", ...args: any[]): void
  • emit(sigName: "notify::hidden", ...args: any[]): void
  • emit(sigName: "notify::mac-address", ...args: any[]): void
  • emit(sigName: "notify::mac-address-blacklist", ...args: any[]): void
  • emit(sigName: "notify::mac-address-randomization", ...args: any[]): void
  • emit(sigName: "notify::mode", ...args: any[]): void
  • emit(sigName: "notify::mtu", ...args: any[]): void
  • emit(sigName: "notify::powersave", ...args: any[]): void
  • emit(sigName: "notify::rate", ...args: any[]): void
  • emit(sigName: "notify::seen-bssids", ...args: any[]): void
  • emit(sigName: "notify::ssid", ...args: any[]): void
  • emit(sigName: "notify::tx-power", ...args: any[]): void
  • emit(sigName: "notify::wake-on-wlan", ...args: any[]): void
  • emit(sigName: "notify::name", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "notify::ap-isolation"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::band"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::bssid"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::channel"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::cloned-mac-address"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::generate-mac-address-mask"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::hidden"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::mac-address"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::mac-address-blacklist"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::mac-address-randomization"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::mode"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::mtu"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::powersave"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::rate"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::seen-bssids"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::ssid"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::tx-power"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::wake-on-wlan"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::name"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns 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

  • getBand(): string
  • getBssid(): string
  • getChannel(): number
  • getClonedMacAddress(): string
  • 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

  • Gets the D-Bus marshalling type of a property. property_name is a D-Bus property name, which may not necessarily be a #GObject property.

    Parameters

    • propertyName: string

      the property of setting to get the type of

    Returns VariantType

  • getGenerateMacAddressMask(): string
  • getHidden(): boolean
  • getMacAddress(): string
  • getMacAddressBlacklist(): string[]
  • getMacBlacklistItem(idx: number): string
  • getMode(): string
  • getMtu(): number
  • getName(): string
  • getNumMacBlacklistItems(): number
  • getNumSeenBssids(): number
  • getPowersave(): number
  • 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

  • getRate(): number
  • For a given secret, retrieves the #NMSettingSecretFlags describing how to handle that secret.

    Parameters

    • secretName: string

      the secret key name to get flags for

    • outFlags: NM.SettingSecretFlags

      on success, the #NMSettingSecretFlags for the secret

    Returns boolean

  • getSeenBssid(i: number): string
  • getSsid(): any
  • getTxPower(): number
  • 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

  • isFloating(): 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: "notify::ap-isolation", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::band", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::bssid", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::channel", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::cloned-mac-address", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::generate-mac-address-mask", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::hidden", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::mac-address", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::mac-address-blacklist", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::mac-address-randomization", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::mode", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::mtu", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::powersave", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::rate", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::seen-bssids", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::ssid", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::tx-power", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::wake-on-wlan", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::name", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cloned-mac-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::generate-mac-address-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::mac-address-blacklist"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::mac-address-randomization"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::wake-on-wlan"
    • 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: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::ap-isolation", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::band", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::bssid", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::channel", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::cloned-mac-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::generate-mac-address-mask", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::hidden", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::mac-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::mac-address-blacklist", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::mac-address-randomization", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::mode", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::mtu", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::powersave", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::rate", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::seen-bssids", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::ssid", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::tx-power", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::wake-on-wlan", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cloned-mac-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::generate-mac-address-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::mac-address-blacklist"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::mac-address-randomization"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::wake-on-wlan"
    • 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: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::ap-isolation", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::band", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::bssid", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::channel", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::cloned-mac-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::generate-mac-address-mask", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::hidden", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::mac-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::mac-address-blacklist", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::mac-address-randomization", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::mode", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::mtu", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::powersave", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::rate", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::seen-bssids", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::ssid", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::tx-power", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::wake-on-wlan", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cloned-mac-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::generate-mac-address-mask"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::mac-address-blacklist"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::mac-address-randomization"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::wake-on-wlan"
    • 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: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • optionGetAllNames(): string[]
  • optionGetBoolean(optName: string): [boolean, boolean]
  • optionGetUint32(optName: string): [boolean, number]
  • optionSet(optName: string, variant: GLib.Variant): void
  • If variant is %NULL, this clears the option if it is set. Otherwise, variant is set as the option. If variant is a floating reference, it will be consumed.

    Note that not all setting types support options. It is a bug setting a variant to a setting that doesn't support it. Currently, only #NMSettingEthtool supports it.

    Parameters

    • optName: string

      the option name to set

    • variant: GLib.Variant

      the variant to set.

    Returns void

  • optionSetBoolean(optName: string, value: boolean): void
  • optionSetUint32(optName: string, value: number): 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

  • removeMacBlacklistItem(idx: number): void
  • Removes the MAC address at index idx from the blacklist.

    Parameters

    • idx: number

      index number of the MAC address

    Returns void

  • removeMacBlacklistItemByValue(mac: string): boolean
  • Removes the MAC address mac from the blacklist.

    Parameters

    • mac: string

      the MAC address string (hex-digits-and-colons notation) to remove from the blacklist

    Returns boolean

  • 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

  • For a given secret, stores the #NMSettingSecretFlags describing how to handle that secret.

    Parameters

    • secretName: string

      the secret key name to set flags for

    • flags: NM.SettingSecretFlags

      the #NMSettingSecretFlags for the secret

    Returns boolean

  • 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

  • toString(): string
  • Convert the setting (including secrets!) into a string. For debugging purposes ONLY, should NOT be used for serialization of the setting, or machine-parsed in any way. The output format is not guaranteed to be stable and may change at any time.

    Returns string

  • 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

  • Validates the setting. Each setting's properties have allowed values, and some are dependent on other values (hence the need for connection). The returned #GError contains information about which property of the setting failed validation, and in what way that property failed validation.

    Parameters

    • connection: NM.Connection

      the #NMConnection that setting came from, or %NULL if setting is being verified in isolation.

    Returns boolean

  • Verifies the secrets in the setting. The returned #GError contains information about which secret of the setting failed validation, and in what way that secret failed validation. The secret validation is done separately from main setting validation, because in some cases connection failure is not desired just for the secrets.

    Parameters

    • connection: NM.Connection

      the #NMConnection that setting came from, or %NULL if setting is being verified in isolation.

    Returns boolean

  • 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[]

  • lookupType(name: string): GType<unknown>
  • 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