Class (GI Class)

NM-1.0NMSettingWirelessSecurity

Wi-Fi Security Settings

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Accessors - Inherited from NM.Setting

Methods

Methods - Inherited from NM.Setting

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Accessors

  • get auth_alg(): string

    When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.

    Returns string

  • set auth_alg(val: string): void

    Parameters

    • val: string

    Returns void

  • get authAlg(): string

    When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.

    Returns string

  • set authAlg(val: string): void

    Parameters

    • val: string

    Returns void

  • get group(): string[]

    A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".

    Returns string[]

  • set group(val: string[]): void

    Parameters

    • val: string[]

    Returns void

  • get key_mgmt(): string

    Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).

    This property must be set for any Wi-Fi connection that uses security.

    Returns string

  • set key_mgmt(val: string): void

    Parameters

    • val: string

    Returns void

  • get keyMgmt(): string

    Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).

    This property must be set for any Wi-Fi connection that uses security.

    Returns string

  • set keyMgmt(val: string): void

    Parameters

    • val: string

    Returns void

  • get leap_password(): string

    The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

    Returns string

  • set leap_password(val: string): void

    Parameters

    • val: string

    Returns void

  • get leap_username(): string

    The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

    Returns string

  • set leap_username(val: string): void

    Parameters

    • val: string

    Returns void

  • get leapPassword(): string

    The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

    Returns string

  • set leapPassword(val: string): void

    Parameters

    • val: string

    Returns void

  • get leapUsername(): string

    The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

    Returns string

  • set leapUsername(val: string): void

    Parameters

    • val: string

    Returns void

  • get pairwise(): string[]

    A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".

    Returns string[]

  • set pairwise(val: string[]): void

    Parameters

    • val: string[]

    Returns void

  • get proto(): string[]

    List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.

    Returns string[]

  • set proto(val: string[]): void

    Parameters

    • val: string[]

    Returns void

  • get psk(): string

    Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.

    Returns string

  • set psk(val: string): void

    Parameters

    • val: string

    Returns void

  • get wep_key0(): string

    Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wep_key0(val: string): void

    Parameters

    • val: string

    Returns void

  • get wep_key1(): string

    Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wep_key1(val: string): void

    Parameters

    • val: string

    Returns void

  • get wep_key2(): string

    Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wep_key2(val: string): void

    Parameters

    • val: string

    Returns void

  • get wep_key3(): string

    Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wep_key3(val: string): void

    Parameters

    • val: string

    Returns void

  • get wep_tx_keyidx(): number

    When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.

    Returns number

  • set wep_tx_keyidx(val: number): void

    Parameters

    • val: number

    Returns void

  • get wepKey0(): string

    Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wepKey0(val: string): void

    Parameters

    • val: string

    Returns void

  • get wepKey1(): string

    Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wepKey1(val: string): void

    Parameters

    • val: string

    Returns void

  • get wepKey2(): string

    Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wepKey2(val: string): void

    Parameters

    • val: string

    Returns void

  • get wepKey3(): string

    Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

    Returns string

  • set wepKey3(val: string): void

    Parameters

    • val: string

    Returns void

  • get wepTxKeyidx(): number

    When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.

    Returns number

  • set wepTxKeyidx(val: number): void

    Parameters

    • val: number

    Returns void

  • get wps_method(): number

    Flags indicating which mode of WPS is to be used if any.

    There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.

    WPS can be disabled by setting this property to a value of 1.

    Returns number

    1.10

  • set wps_method(val: number): void

    Parameters

    • val: number

    Returns void

  • get wpsMethod(): number

    Flags indicating which mode of WPS is to be used if any.

    There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.

    WPS can be disabled by setting this property to a value of 1.

    Returns number

    1.10

  • set wpsMethod(val: number): void

    Parameters

    • val: number

    Returns void

Accessors - Inherited from NM.Setting

  • get 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".

    Returns string

Methods

  • Adds an encryption algorithm to the list of allowed groupwise encryption algorithms. If the list is not empty, then only access points that support one or more of the encryption algorithms in the list will be considered compatible with this connection.

    Parameters

    • group: string

      the encryption algorithm to add, one of "wep40", "wep104", "tkip", or "ccmp"

    Returns boolean

    true if the algorithm was added to the list, false if it was already in the list

  • Adds an encryption algorithm to the list of allowed pairwise encryption algorithms. If the list is not empty, then only access points that support one or more of the encryption algorithms in the list will be considered compatible with this connection.

    Parameters

    • pairwise: string

      the encryption algorithm to add, one of "tkip" or "ccmp"

    Returns boolean

    true if the algorithm was added to the list, false if it was already in the list

  • Adds a Wi-Fi security protocol (one of "wpa" or "rsn") to the allowed list; only protocols in this list will be used when finding and connecting to the Wi-Fi network specified by this connection. For example, if the protocol list contains only "wpa" but the access point for the SSID specified by this connection only supports WPA2/RSN, the connection cannot be used with the access point.

    Parameters

    • proto: string

      the protocol to add, one of "wpa" or "rsn"

    Returns boolean

    true if the protocol was new and was added to the allowed protocol list, or false if it was already in the list

  • Removes all algorithms from the allowed list. If there are no algorithms specified then all groupwise encryption algorithms are allowed.

    Returns void

  • Removes all algorithms from the allowed list. If there are no algorithms specified then all pairwise encryption algorithms are allowed.

    Returns void

  • Removes all protocols from the allowed list. If there are no protocols specified then all protocols are allowed.

    Returns void

  • Returns the allowed groupwise encryption algorithm from allowed algorithm list.

    Parameters

    • i: number

      index of an item in the allowed groupwise encryption algorithm list

    Returns string

    the groupwise encryption algorithm at index i

  • Returns number

    the number of groupwise encryption algorithms in the allowed list

  • Returns number

    the number of pairwise encryption algorithms in the allowed list

  • Returns number

    the number of security protocols this connection allows when connecting to secure Wi-Fi networks

  • Returns the allowed pairwise encryption algorithm from allowed algorithm list.

    Parameters

    • i: number

      index of an item in the allowed pairwise encryption algorithm list

    Returns string

    the pairwise encryption algorithm at index i

  • Parameters

    • i: number

      an index into the protocol list

    Returns string

    the protocol at index i

  • Parameters

    • idx: number

      the WEP key index (0..3 inclusive)

    Returns string

    the WEP key at the given index

  • Removes an encryption algorithm from the allowed groupwise encryption algorithm list.

    Parameters

    • i: number

      the index of an item in the allowed groupwise encryption algorithm list

    Returns void

  • Removes an encryption algorithm from the allowed groupwise encryption algorithm list.

    Parameters

    • group: string

      the encryption algorithm to remove, one of "wep40", "wep104", "tkip", or "ccmp"

    Returns boolean

    true if the algorithm was found and removed; false if it was not.

  • Removes an encryption algorithm from the allowed pairwise encryption algorithm list.

    Parameters

    • i: number

      the index of an item in the allowed pairwise encryption algorithm list

    Returns void

  • Removes an encryption algorithm from the allowed pairwise encryption algorithm list.

    Parameters

    • pairwise: string

      the encryption algorithm to remove, one of "tkip" or "ccmp"

    Returns boolean

    true if the encryption algorithm was found and removed; false if it was not.

  • Removes a protocol from the allowed protocol list.

    Parameters

    • i: number

      index of the protocol to remove

    Returns void

  • Removes a protocol from the allowed protocol list.

    Parameters

    • proto: string

      the protocol to remove, one of "wpa" or "rsn"

    Returns boolean

    true if the protocol was found and removed; false if it was not.

  • Sets a WEP key in the given index.

    Parameters

    • idx: number

      the index of the key (0..3 inclusive)

    • key: string

      the WEP key as a string, in either hexadecimal, ASCII, or passphrase form as determined by the value of the NM.SettingWirelessSecurity.wep_key_type property.

    Returns void

Methods - Inherited from NM.Setting

  • 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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.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 GObject.Binding 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.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    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.

    If flags contains GObject.BindingFlags.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 transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • 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

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Compares two NM.Setting objects for similarity, with comparison behavior modified by a set of flags. See the documentation for NM.SettingCompareFlags 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 NM.SettingDiffResult values.

    Parameters

    • b: NM.Setting

      a second NM.Setting to compare with the first

    • flags: NM.SettingCompareFlags

      compare flags, e.g. NM.SettingCompareFlags.EXACT

    • invert_results: boolean

      this parameter is used internally by libnm and should be set to false. If true inverts the meaning of the NM.SettingDiffResult.

    • results: GLib.HashTable<string, number> | { [key: string]: any }

      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, GLib.HashTable<string, number>]

    true if the settings contain the same values, false if they do not

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object 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

  • 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.Object::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

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value 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 GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • 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

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

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    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

    Returns void

  • Gives the name of all set options.

    Returns string[]

    A null terminated array of key names. If no names are present, this returns null. The returned array and the names are owned by %NMSetting and might be invalidated by the next operation.

  • Parameters

    • opt_name: string

      the option to get

    Returns [boolean, boolean]

    true if opt_name is set to a boolean variant.

  • Parameters

    • opt_name: string

      the option to get

    Returns [boolean, number]

    true if opt_name is set to a uint32 variant.

  • 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 NM.SettingEthtool supports it.

    Parameters

    • opt_name: string

      the option name to set

    • Optionalvariant: GLib.Variant<any>

      the variant to set.

    Returns void

  • Like nm_setting_option_set() to set a boolean GVariant.

    Parameters

    • opt_name: string
    • value: boolean

      the value to set.

    Returns void

  • Like nm_setting_option_set() to set a uint32 GVariant.

    Parameters

    • opt_name: string
    • value: number

      the value to set.

    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

    the same 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

    object

  • 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

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns 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 GLib.Quark 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 GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • 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 GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns 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.Object::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

  • 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

    an allocated string containing a textual representation of the setting's properties and values, which the caller should free with g_free()

  • 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.Object 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.Object 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 GLib.Error contains information about which property of the setting failed validation, and in what way that property failed validation.

    Parameters

    • Optionalconnection: NM.Connection

      the NM.Connection that setting came from, or null if setting is being verified in isolation.

    Returns boolean

    true if the setting is valid, false if it is not

  • Verifies the secrets in the setting. The returned GLib.Error 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

    • Optionalconnection: NM.Connection

      the NM.Connection that setting came from, or null if setting is being verified in isolation.

    Returns boolean

    true if the setting secrets are valid, false if they are not

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns 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

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns 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

    Returns void

  • Get the type of the enum that defines the values that the property accepts. It is only useful for properties configured to accept values from certain enum type, otherwise it will return G_TYPE_INVALID. Note that flags (children of G_TYPE_FLAGS) are also considered enums.

    Note that the GObject property might be implemented as an integer, actually, and not as enum. Find out what underlying type is used, checking the GObject.ParamSpec, before setting the GObject property.

    Parameters

    • setting_type: GType

      the GType of the NMSetting instance

    • property_name: string

      the name of the property

    Returns GType

  • 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 GObject.ParamSpec, 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 GObject.TypeInfo.) 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

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures