Class (GI Class)

NM-1.0NMRemoteConnection

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Accessors - Inherited from NM.Object

Methods

_init add_setting bind_property bind_property_full block_signal_handler clear_secrets clear_secrets_with_flags clear_settings commit_changes commit_changes_async commit_changes_finish compare connect connect_after delete delete_async delete_finish disconnect dump emit for_each_setting_value force_floating freeze_notify get_connection_type get_data get_filename get_flags get_id get_interface_name get_path get_property get_qdata get_secrets get_secrets_async get_secrets_finish get_setting get_setting_802_1x get_setting_adsl get_setting_bluetooth get_setting_bond get_setting_bridge get_setting_bridge_port get_setting_by_name get_setting_cdma get_setting_connection get_setting_dcb get_setting_dummy get_setting_generic get_setting_gsm get_setting_infiniband get_setting_ip_tunnel get_setting_ip4_config get_setting_ip6_config get_setting_macsec get_setting_macvlan get_setting_olpc_mesh get_setting_ovs_bridge get_setting_ovs_interface get_setting_ovs_patch get_setting_ovs_port get_setting_ppp get_setting_pppoe get_setting_proxy get_setting_serial get_setting_tc_config get_setting_team get_setting_team_port get_setting_tun get_setting_vlan get_setting_vpn get_setting_vxlan get_setting_wimax get_setting_wired get_setting_wireless get_setting_wireless_security get_settings get_unsaved get_uuid get_version_id get_virtual_device_description get_visible getv is_floating is_type is_virtual need_secrets normalize notify notify_by_pspec ref ref_sink remove_setting replace_settings replace_settings_from_connection run_dispose save save_async save_finish set set_data set_path set_property steal_data steal_qdata stop_emission_by_name thaw_notify to_dbus unblock_signal_handler unref update_secrets update2 update2_finish verify verify_secrets vfunc_changed vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_property vfunc_notify vfunc_secrets_cleared vfunc_secrets_updated vfunc_set_property watch_closure

Methods - Inherited from NM.Object

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 filename(): string

    File that stores the connection in case the connection is file-backed.

    Returns string

    1.12

  • get unsaved(): boolean

    true if the remote connection contains changes that have not been saved to disk, false if the connection is the same as its on-disk representation.

    Returns boolean

  • get version_id(): number

    The version ID of the profile that is incremented when the profile gets modified. This can be used to track concurrent modifications of the profile.

    Returns number

    1.44

  • get versionId(): number

    The version ID of the profile that is incremented when the profile gets modified. This can be used to track concurrent modifications of the profile.

    Returns number

    1.44

  • get visible(): boolean

    true if the remote connection is visible to the current user, false if not. If the connection is not visible then it is essentially useless; it will not contain any settings, and operations such as nm_remote_connection_save() and nm_remote_connection_delete() will always fail. (NMRemoteSettings will not normally return non-visible connections to callers, but it is possible for a connection's visibility to change after you already have a reference to it.)

    Returns boolean

Accessors - Inherited from NM.Object

  • get client(): NM.Client

    The NMClient instance as returned by nm_object_get_client().

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

    Returns NM.Client

    1.34

  • get path(): string

    The D-Bus object path.

    The D-Bus path of an object instance never changes, even if the object gets removed from the cache. To see whether the object is still in the cache, check NMObject:client.

    Returns string

Methods

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

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

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

    Will result in the "sensitive" property of the widget GObject.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

    • ...args: never[]

      the property on source to bind

    Returns any

    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.

  • Send any local changes to the settings and properties of connection to NetworkManager. If save_to_disk is true, the updated connection will be saved to disk; if false, then only the in-memory representation will be changed.

    Parameters

    Returns boolean

    true on success, false on error, in which case error will be set.

  • Asynchronously sends any local changes to the settings and properties of connection to NetworkManager. If save is true, the updated connection will be saved to disk; if false, then only the in-memory representation will be changed.

    Parameters

    Returns Promise<boolean>

  • Asynchronously sends any local changes to the settings and properties of connection to NetworkManager. If save is true, the updated connection will be saved to disk; if false, then only the in-memory representation will be changed.

    Parameters

    Returns void

  • Asynchronously sends any local changes to the settings and properties of connection to NetworkManager. If save is true, the updated connection will be saved to disk; if false, then only the in-memory representation will be changed.

    Parameters

    Returns void | Promise<boolean>

  • 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

  • Print the connection (including secrets!) to stdout. 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 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.

  • Returns string

    file that stores the connection in case the connection is file-backed.

  • Returns the interface name as stored in NMSettingConnection:interface_name. If the connection contains no NMSettingConnection, it will return null.

    For hardware devices and software devices created outside of NetworkManager, this name is used to match the device. for software devices created by NetworkManager, this is the name of the created interface.

    Returns string

    Name of the kernel interface or null

  • 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

  • Request the connection's secrets. Note that this is a blocking D-Bus call, not a simple property accessor.

    Parameters

    Returns GLib.Variant

    a GLib.Variant of type NM_VARIANT_TYPE_CONNECTION containing connection's secrets, or null on error. Warning: NMClient contains a cache of objects on D-Bus. This cache gets updated with D-Bus signals when iterating the GMainContext. This function performs a (pseudo) blocking D-Bus call. Aside blocking, the result will not be in sync and not be ordered with the content of the NMClient cache. This function used to be deprecated between 1.22 and 1.38 releases.

  • Returns boolean

    true if the remote connection contains changes that have not been saved to disk, false if the connection is the same as its on-disk representation.

  • Returns number

    the version-id of the profile. This ID is incremented whenever the profile is modified.

  • Returns the name that nm_device_disambiguate_names() would return for the virtual device that would be created for connection. Eg, "VLAN (eth1.1)".

    Returns string

    the name of connection's device, or null if connection is not a virtual connection type

  • Checks if the connection is visible to the current user. If the connection is not visible then it is essentially useless; it will not contain any settings, and operations such as nm_remote_connection_save() and nm_remote_connection_delete() will always fail. (NMRemoteSettings will not normally return non-visible connections to callers, but it is possible for a connection's visibility to change after you already have a reference to it.)

    Returns boolean

    true if the remote connection is visible to the current user, false if not.

  • 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

  • A convenience function to check if the given connection is a particular type (ie wired, Wi-Fi, ppp, etc). Checks the NM.SettingConnection.type property of the connection and matches that against type.

    Parameters

    • type: string

      a setting name to check the connection's type against (like NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)

    Returns boolean

    true if the connection is of the given type, false if not

  • Checks if connection refers to a virtual device (and thus can potentially be activated even if the device it refers to doesn't exist).

    Returns boolean

    whether connection refers to a virtual device

  • Returns the name of the first setting object in the connection which would need secrets to make a successful connection. The returned hints are only intended as a guide to what secrets may be required, because in some circumstances, there is no way to conclusively determine exactly which secrets are needed.

    Returns [string, string[]]

    the setting name of the NM.Setting object which has invalid or missing secrets

  • Does some basic normalization and fixup of well known inconsistencies and deprecated fields. If the connection was modified in any way, the output parameter modified is set true.

    Finally the connection will be verified and true returns if the connection is valid. As this function only performs some specific normalization steps it cannot repair all connections. If the connection has errors that cannot be normalized, the connection will not be modified.

    Parameters

    • parameters: GLib.HashTable<string, any>

      a GLib.HashTable with normalization parameters to allow customization of the normalization by providing specific arguments. Unknown arguments will be ignored and the default will be used. The keys must be strings compared with g_str_equal() function. The values are opaque and depend on the parameter name.

    Returns [boolean, boolean]

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

  • 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

  • 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

  • Replaces connection's settings with new_settings (which must be syntactically valid, and describe a known type of connection, but does not need to result in a connection that passes nm_connection_verify()).

    Parameters

    Returns boolean

    true if connection was updated, false if new_settings could not be deserialized (in which case connection will be unchanged).

  • Saves the connection to disk if the connection has changes that have not yet been written to disk, or if the connection has never been saved.

    Parameters

    Returns boolean

    true on success, false on error, in which case error will be set.

  • 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 the D-Bus path of the connection. This property is not serialized, and is only for the reference of the caller. Sets the NM.Connection.path property.

    Parameters

    • path: string

      the D-Bus path of the connection as given by the settings service which provides the connection

    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

  • 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

  • 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

  • Update the specified setting's secrets, given a dictionary of secrets intended for that setting (deserialized from D-Bus for example). Will also extract the given setting's secrets hash if given a connection dictionary. If setting_name is null, expects a fully serialized NM.Connection as returned by nm_connection_to_dbus() and will update all secrets from all settings contained in secrets.

    Parameters

    • setting_name: string

      the setting object name to which the secrets apply

    • secrets: GLib.Variant

      a GLib.Variant of secrets, of type NM_VARIANT_TYPE_CONNECTION or NM_VARIANT_TYPE_SETTING

    Returns boolean

    true if the secrets were successfully updated, false if the update failed (tried to update secrets for a setting that doesn't exist, etc)

  • Validates the connection and all its settings. Each setting's properties have allowed values, and some values are dependent on other values. For example, if a Wi-Fi connection is security enabled, the NM.SettingWireless setting object's 'security' property must contain the setting name of the NM.SettingWirelessSecurity object, which must also be present in the connection for the connection to be valid. As another example, the NM.SettingWired object's 'mac-address' property must be a validly formatted MAC address. The returned GLib.Error contains information about which setting and which property failed validation, and how it failed validation.

    Returns boolean

    true if the connection is valid, false if it is 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

Methods - Inherited from NM.Object

  • Returns the NM.Client instance in which object is cached. Also, if the object got removed from the client cached, this returns null. So it can be used to check whether the object is still alive.

    Returns any

    the NM.Client cache in which the object can be found, or null if the object is no longer cached.

  • 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