Gjsify LogoGjsify Logo

NMClient contains a cache of the objects of NetworkManager's D-Bus API. It uses #GMainContext and #GDBusConnection for that and registers to D-Bus signals. That means, when iterating the associated #GMainContext, D-Bus signals gets processed and the #NMClient instance updates and emits #GObject signals.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

  • Parameters

    Returns NM.Client

  • Creates a new #NMClient synchronously.

    Note that this will block until a NMClient instance is fully initialized. This does nothing beside calling g_initable_new(). You are free to call g_initable_new() or g_object_new()/g_initable_init() directly for more control, to set GObject properties or get access to the NMClient instance while it is still initializing.

    Using the synchronous initialization creates an #NMClient instance that uses an internal #GMainContext. This context is invisible to the user. This introduces an additional overhead that is payed not only during object initialization, but for the entire lifetime of this object. Also, due to this internal #GMainContext, the events are no longer in sync with other messages from #GDBusConnection (but all events of the NMClient will themselves still be ordered). For a serious program, you should therefore avoid these problems by using g_async_initable_init_async() or nm_client_new_async() instead. The sync initialization is still useful for simple scripts or interactive testing for example via pygobject.

    Creating an #NMClient instance can only fail for two reasons. First, if you didn't provide a %NM_CLIENT_DBUS_CONNECTION and the call to g_bus_get() fails. You can avoid that by using g_initable_new() directly and set a D-Bus connection. Second, if you cancelled the creation. If you do that, then note that after the failure there might still be idle actions pending which keep nm_client_get_main_context() alive. That means, in that case you must continue iterating the context to avoid leaks. See nm_client_get_context_busy_watcher().

    Creating an #NMClient instance when NetworkManager is not running does not cause a failure.

    Parameters

    Returns NM.Client

Properties

activating_connection: NM.ActiveConnection

The #NMActiveConnection of the activating connection that is likely to become the new #NMClient:primary-connection.

active_connections: NM.ActiveConnection[]

The active connections.

all_devices: NM.Device[]

List of both real devices and device placeholders.

can_modify: boolean

If %TRUE, adding and modifying connections is supported.

capabilities: number[]

The list of capabilities numbers as guint32 or %NULL if there are no capabilities. The numeric value correspond to %NMCapability enum.

checkpoints: Checkpoint[]

The list of active checkpoints.

connections: NM.RemoteConnection[]

The list of configured connections that are available to the user. (Note that this differs from the underlying D-Bus property, which may also contain the object paths of connections that the user does not have permission to read the details of.)

connectivity: NM.ConnectivityState

The network connectivity state.

connectivity_check_available: boolean
connectivity_check_enabled: boolean
connectivity_check_uri: string

The used URI for connectivity checking.

dbus_connection: DBusConnection

The #GDBusConnection to use.

If this is not set during object construction, the D-Bus connection will automatically be chosen during async/sync initalization via g_bus_get().

dbus_name_owner: string

The name owner of the NetworkManager D-Bus service.

devices: NM.Device[]

List of real network devices. Does not include placeholder devices.

dns_configuration: DnsEntry[]

The current DNS configuration, represented as an array of #NMDnsEntry objects.

dns_mode: string

The current DNS processing mode.

dns_rc_manager: string

The current resolv.conf management mode.

g_type_instance: TypeInstance
hostname: string

The machine hostname stored in persistent configuration. This can be modified by calling nm_client_save_hostname().

instance_flags: number

#NMClientInstanceFlags for the instance. These affect behavior of #NMClient. This is a construct property and you may only set most flags only during construction.

The flag %NM_CLIENT_INSTANCE_FLAGS_NO_AUTO_FETCH_PERMISSIONS can be toggled any time, even after constructing the instance. Note that you may want to watch NMClient:permissions-state property to know whether permissions are ready. Note that permissions are only fetched when NMClient has a D-Bus name owner.

metered: number

Whether the connectivity is metered.

networking_enabled: boolean

Whether networking is enabled.

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

nm_running: boolean

Whether the daemon is running.

permissions_state: Ternary

The state of the cached permissions. The value %NM_TERNARY_DEFAULT means that no permissions are yet received (or not yet requested). %NM_TERNARY_TRUE means that permissions are received, cached and up to date. %NM_TERNARY_FALSE means that permissions were received and are cached, but in the meantime a "CheckPermissions" signal was received that invalidated the cached permissions. Note that NMClient will always emit a notify::permissions-state signal when a "CheckPermissions" signal got received or after new permissions got received (that is regardless whether the value of the permission state actually changed). With this you can watch the permissions-state property to know whether the permissions are ready. Note that while NMClient has no D-Bus name owner, no permissions are fetched (and this property won't change).

primary_connection: NM.ActiveConnection

The #NMActiveConnection of the device with the default route; see nm_client_get_primary_connection() for more details.

startup: boolean

Whether the daemon is still starting up.

state: NM.State

The current daemon state.

version: string

The NetworkManager version.

wimax_enabled: boolean

Whether WiMAX functionality is enabled.

wimax_hardware_enabled: boolean

Whether the WiMAX hardware is enabled.

wireless_enabled: boolean

Whether wireless is enabled.

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

wireless_hardware_enabled: boolean

Whether the wireless hardware is enabled.

wwan_enabled: boolean

Whether WWAN functionality is enabled.

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

wwan_hardware_enabled: boolean

Whether the WWAN hardware is enabled.

$gtype: GType<NM.Client>
name: string

Methods

  • Asynchronously starts a connection to a particular network using the configuration settings from connection and the network device device. Certain connection types also take a "specific object" which is the object path of a connection- specific object, like an #NMAccessPoint for Wi-Fi connections, or an #NMWimaxNsp for WiMAX connections, to which you wish to connect. If the specific object is not given, NetworkManager can, in some cases, automatically determine which network to connect to given the settings in connection.

    If connection is not given for a device-based activation, NetworkManager picks the best available connection for the device and activates it.

    Note that the callback is invoked when NetworkManager has started activating the new connection, not when it finishes. You can use the returned #NMActiveConnection object (in particular, #NMActiveConnection:state) to track the activation to its completion.

    Parameters

    • connection: NM.Connection

      an #NMConnection

    • device: NM.Device

      the #NMDevice

    • specific_object: string

      the object path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of %NULL should be used (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object path of a #NMAccessPoint or #NMWimaxNsp owned by device, which you can get using nm_object_get_path(), and which will be used to complete the details of the newly added connection.

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the activation has started

    Returns void

  • Adds a new connection using the given details (if any) as a template, automatically filling in missing settings with the capabilities of the given device and specific object. The new connection is then asynchronously activated as with nm_client_activate_connection_async(). Cannot be used for VPN connections at this time.

    Note that the callback is invoked when NetworkManager has started activating the new connection, not when it finishes. You can used the returned #NMActiveConnection object (in particular, #NMActiveConnection:state) to track the activation to its completion.

    This is identical to nm_client_add_and_activate_connection_async() but takes a further options parameter. Currently, the following options are supported by the daemon:

    • "persist": A string describing how the connection should be stored. The default is "disk", but it can be modified to "memory" (until the daemon quits) or "volatile" (will be deleted on disconnect).
    • "bind-activation": Bind the connection lifetime to something. The default is "none", meaning an explicit disconnect is needed. The value "dbus-client" means the connection will automatically be deactivated when the calling D-Bus client disappears from the system bus.

    Parameters

    • partial: NM.Connection

      an #NMConnection to add; the connection may be partially filled (or even %NULL) and will be completed by NetworkManager using the given device and specific_object before being added

    • device: NM.Device

      the #NMDevice

    • specific_object: string

      the object path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of %NULL should be used (i.e., no specific object). For Wi-Fi or WiMAX connections, pass the object path of a #NMAccessPoint or #NMWimaxNsp owned by device, which you can get using nm_object_get_path(), and which will be used to complete the details of the newly added connection.

    • options: GLib.Variant

      a #GVariant containing a dictionary with options, or %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the activation has started

    Returns void

  • Gets the result of a call to nm_client_add_and_activate_connection2().

    You can call nm_active_connection_get_connection() on the returned #NMActiveConnection to find the path of the created #NMConnection.

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns [NM.ActiveConnection, GLib.Variant]

  • Adds a new connection using the given details (if any) as a template, automatically filling in missing settings with the capabilities of the given device and specific object. The new connection is then asynchronously activated as with nm_client_activate_connection_async(). Cannot be used for VPN connections at this time.

    Note that the callback is invoked when NetworkManager has started activating the new connection, not when it finishes. You can used the returned #NMActiveConnection object (in particular, #NMActiveConnection:state) to track the activation to its completion.

    Parameters

    • partial: NM.Connection

      an #NMConnection to add; the connection may be partially filled (or even %NULL) and will be completed by NetworkManager using the given device and specific_object before being added

    • device: NM.Device

      the #NMDevice

    • specific_object: string

      the object path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of %NULL should be used (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object path of a #NMAccessPoint or #NMWimaxNsp owned by device, which you can get using nm_object_get_path(), and which will be used to complete the details of the newly added connection. If the variant is floating, it will be consumed.

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the activation has started

    Returns void

  • Gets the result of a call to nm_client_add_and_activate_connection_async().

    You can call nm_active_connection_get_connection() on the returned #NMActiveConnection to find the path of the created #NMConnection.

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns NM.ActiveConnection

  • Call AddConnection2() D-Bus API asynchronously.

    Parameters

    • settings: GLib.Variant

      the "a{sa{sv}}" #GVariant with the content of the setting.

    • flags: SettingsAddConnection2Flags

      the %NMSettingsAddConnection2Flags argument.

    • args: GLib.Variant

      the "a{sv}" #GVariant with extra argument or %NULL for no extra arguments.

    • ignore_out_result: boolean

      this function wraps AddConnection2(), which has an additional result "a{sv}" output parameter. By setting this to %TRUE, you signal that you are not interested in that output parameter. This allows the function to fall back to AddConnection() and AddConnectionUnsaved(), which is interesting if you run against an older server version that does not yet provide AddConnection2(). By setting this to %FALSE, the function under the hood always calls AddConnection2().

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the add operation completes

    Returns void

  • Requests that the remote settings service add the given settings to a new connection. If save_to_disk is %TRUE, the connection is immediately written to disk; otherwise it is initially only stored in memory, but may be saved later by calling the connection's nm_remote_connection_commit_changes() method.

    connection is untouched by this function and only serves as a template of the settings to add. The #NMRemoteConnection object that represents what NetworkManager actually added is returned to callback when the addition operation is complete.

    Note that the #NMRemoteConnection returned in callback may not contain identical settings to connection as NetworkManager may perform automatic completion and/or normalization of connection properties.

    Parameters

    • connection: NM.Connection

      the connection to add. Note that this object's settings will be added, not the object itself

    • save_to_disk: boolean

      whether to immediately save the connection to disk

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the add operation completes

    Returns void

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

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

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

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

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

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

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

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

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

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

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • Updates the network connectivity state and returns the (new) current state. Contrast nm_client_get_connectivity(), which returns the most recent known state without re-checking.

    This is a blocking call; use nm_client_check_connectivity_async() if you do not want to block.

    Parameters

    Returns NM.ConnectivityState

  • Asynchronously updates the network connectivity state and invokes callback when complete. Contrast nm_client_get_connectivity(), which (immediately) returns the most recent known state without re-checking, and nm_client_check_connectivity(), which blocks.

    Parameters

    Returns void

  • Resets the timeout for the checkpoint with path checkpoint_path to timeout_add.

    Parameters

    • checkpoint_path: string

      a D-Bus path to a checkpoint

    • add_timeout: number

      the timeout in seconds counting from now. Set to zero, to disable the timeout.

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the add operation completes

    Returns void

  • checkpoint_adjust_rollback_timeout_finish(result: AsyncResult): boolean
  • Gets the result of a call to nm_client_checkpoint_adjust_rollback_timeout().

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns boolean

  • Creates a checkpoint of the current networking configuration for given interfaces. An empty devices argument means all devices. If rollback_timeout is not zero, a rollback is automatically performed after the given timeout.

    Parameters

    • devices: NM.Device[]

      a list of devices for which a checkpoint should be created.

    • rollback_timeout: number

      the rollback timeout in seconds

    • flags: CheckpointCreateFlags

      creation flags

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the add operation completes

    Returns void

  • Destroys an existing checkpoint without performing a rollback.

    Parameters

    • checkpoint_path: string

      the D-Bus path for the checkpoint

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the add operation completes

    Returns void

  • checkpoint_destroy_finish(result: AsyncResult): boolean
  • Gets the result of a call to nm_client_checkpoint_destroy().

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns boolean

  • Performs the rollback of a checkpoint before the timeout is reached.

    Parameters

    • checkpoint_path: string

      the D-Bus path to the checkpoint

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the add operation completes

    Returns void

  • checkpoint_rollback_finish(result: AsyncResult): HashTable<string | number | symbol, string | number | boolean>
  • Gets the result of a call to nm_client_checkpoint_rollback().

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

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

  • connect_after(sigName: "active-connection-added", callback: Client_ActiveConnectionAddedSignalCallback): number
  • connect_after(sigName: "active-connection-removed", callback: Client_ActiveConnectionRemovedSignalCallback): number
  • connect_after(sigName: "any-device-added", callback: NM.Client_AnyDeviceAddedSignalCallback): number
  • connect_after(sigName: "any-device-removed", callback: NM.Client_AnyDeviceRemovedSignalCallback): number
  • connect_after(sigName: "connection-added", callback: Client_ConnectionAddedSignalCallback): number
  • connect_after(sigName: "connection-removed", callback: Client_ConnectionRemovedSignalCallback): number
  • connect_after(sigName: "device-added", callback: NM.Client_DeviceAddedSignalCallback): number
  • connect_after(sigName: "device-removed", callback: NM.Client_DeviceRemovedSignalCallback): number
  • connect_after(sigName: "permission-changed", callback: NM.Client_PermissionChangedSignalCallback): number
  • connect_after(sigName: "notify::activating-connection", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::active-connections", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::all-devices", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::can-modify", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::capabilities", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::checkpoints", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::connections", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::connectivity", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::connectivity-check-available", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::connectivity-check-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::connectivity-check-uri", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::dbus-connection", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::dbus-name-owner", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::devices", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::dns-configuration", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::dns-mode", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::dns-rc-manager", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::hostname", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::instance-flags", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::metered", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::networking-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::nm-running", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::permissions-state", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::primary-connection", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::startup", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::state", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::version", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wimax-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wimax-hardware-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wireless-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wireless-hardware-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wwan-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wwan-hardware-enabled", callback: (($obj: NM.Client, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • connectivity_check_get_available(): boolean
  • Determine whether connectivity checking is available. This requires that the URI of a connectivity service has been set in the configuration file.

    Returns boolean

  • connectivity_check_get_enabled(): boolean
  • connectivity_check_get_uri(): string
  • connectivity_check_set_enabled(enabled: boolean): void
  • Enable or disable connectivity checking. Note that if a connectivity checking URI has not been configured, this will not have any effect.

    Parameters

    • enabled: boolean

      %TRUE to enable connectivity checking

    Returns void

  • Call g_dbus_connection_call() on the current name owner with the specified arguments. Most importantly, this invokes g_dbus_connection_call() with the client's #GMainContext, so that the response is always in order with other events D-Bus events. Of course, the call uses #GTask and will invoke the callback on the current g_main_context_get_thread_default().

    This API is merely a convenient wrapper for g_dbus_connection_call(). You can also use g_dbus_connection_call() directly, with the same effect.

    Parameters

    • object_path: string

      path of remote object

    • interface_name: string

      D-Bus interface to invoke method on

    • method_name: string

      the name of the method to invoke

    • parameters: GLib.Variant

      a #GVariant tuple with parameters for the method or %NULL if not passing parameters

    • reply_type: VariantType

      the expected type of the reply (which will be a tuple), or %NULL

    • timeout_msec: number

      the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation

    Returns void

  • Like nm_client_dbus_call() but calls "Set" on the standard "org.freedesktop.DBus.Properties" D-Bus interface.

    Parameters

    • object_path: string

      path of remote object

    • interface_name: string

      D-Bus interface for the property to set.

    • property_name: string

      the name of the property to set

    • value: GLib.Variant

      a #GVariant with the value to set.

    • timeout_msec: number

      the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout

    • cancellable: Gio.Cancellable

      a #GCancellable or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation

    Returns void

  • Gets the result of a call to nm_client_dbus_set_property().

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns boolean

  • deactivate_connection_finish(result: AsyncResult): boolean
  • Gets the result of a call to nm_client_deactivate_connection_async().

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns boolean

  • disconnect(id: number): void
  • emit(sigName: "active-connection-added", active_connection: NM.ActiveConnection, ...args: any[]): void
  • emit(sigName: "active-connection-removed", active_connection: NM.ActiveConnection, ...args: any[]): void
  • emit(sigName: "any-device-added", device: NM.Device, ...args: any[]): void
  • emit(sigName: "any-device-removed", device: NM.Device, ...args: any[]): void
  • emit(sigName: "connection-added", connection: NM.RemoteConnection, ...args: any[]): void
  • emit(sigName: "connection-removed", connection: NM.RemoteConnection, ...args: any[]): void
  • emit(sigName: "device-added", device: NM.Device, ...args: any[]): void
  • emit(sigName: "device-removed", device: NM.Device, ...args: any[]): void
  • emit(sigName: "permission-changed", permission: number, result: number, ...args: any[]): void
  • emit(sigName: "notify::activating-connection", ...args: any[]): void
  • emit(sigName: "notify::active-connections", ...args: any[]): void
  • emit(sigName: "notify::all-devices", ...args: any[]): void
  • emit(sigName: "notify::can-modify", ...args: any[]): void
  • emit(sigName: "notify::capabilities", ...args: any[]): void
  • emit(sigName: "notify::checkpoints", ...args: any[]): void
  • emit(sigName: "notify::connections", ...args: any[]): void
  • emit(sigName: "notify::connectivity", ...args: any[]): void
  • emit(sigName: "notify::connectivity-check-available", ...args: any[]): void
  • emit(sigName: "notify::connectivity-check-enabled", ...args: any[]): void
  • emit(sigName: "notify::connectivity-check-uri", ...args: any[]): void
  • emit(sigName: "notify::dbus-connection", ...args: any[]): void
  • emit(sigName: "notify::dbus-name-owner", ...args: any[]): void
  • emit(sigName: "notify::devices", ...args: any[]): void
  • emit(sigName: "notify::dns-configuration", ...args: any[]): void
  • emit(sigName: "notify::dns-mode", ...args: any[]): void
  • emit(sigName: "notify::dns-rc-manager", ...args: any[]): void
  • emit(sigName: "notify::hostname", ...args: any[]): void
  • emit(sigName: "notify::instance-flags", ...args: any[]): void
  • emit(sigName: "notify::metered", ...args: any[]): void
  • emit(sigName: "notify::networking-enabled", ...args: any[]): void
  • emit(sigName: "notify::nm-running", ...args: any[]): void
  • emit(sigName: "notify::permissions-state", ...args: any[]): void
  • emit(sigName: "notify::primary-connection", ...args: any[]): void
  • emit(sigName: "notify::startup", ...args: any[]): void
  • emit(sigName: "notify::state", ...args: any[]): void
  • emit(sigName: "notify::version", ...args: any[]): void
  • emit(sigName: "notify::wimax-enabled", ...args: any[]): void
  • emit(sigName: "notify::wimax-hardware-enabled", ...args: any[]): void
  • emit(sigName: "notify::wireless-enabled", ...args: any[]): void
  • emit(sigName: "notify::wireless-hardware-enabled", ...args: any[]): void
  • emit(sigName: "notify::wwan-enabled", ...args: any[]): void
  • emit(sigName: "notify::wwan-hardware-enabled", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

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

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

    Returns void

  • Gets the #NMActiveConnection corresponding to a currently-activating connection that is expected to become the new #NMClient:primary-connection upon successful activation.

    Returns NM.ActiveConnection

  • Gets both real devices and device placeholders (eg, software devices which do not currently exist, but could be created automatically by NetworkManager if one of their NMDevice::ActivatableConnections was activated). Use nm_device_is_real() to determine whether each device is a real device or a placeholder.

    Use nm_device_get_type() or the NM_IS_DEVICE_XXXX() functions to determine what kind of device each member of the returned array is, and then you may use device-specific methods such as nm_device_ethernet_get_hw_address().

    Returns NM.Device[]

  • get_capabilities(): number[]
  • Gets the current network connectivity state. Contrast nm_client_check_connectivity() and nm_client_check_connectivity_async(), which re-check the connectivity state first before returning any information.

    Returns NM.ConnectivityState

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

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • Gets the %GDBusConnection of the instance. This can be either passed when constructing the instance (as "dbus-connection" property), or it will be automatically initialized during async/sync init.

    Returns DBusConnection

  • get_dbus_name_owner(): string
  • get_device_by_iface(iface: string): NM.Device
  • get_device_by_path(object_path: string): NM.Device
  • Gets all the known network devices. Use nm_device_get_type() or the NM_IS_DEVICE_XXXX functions to determine what kind of device member of the returned array is, and then you may use device-specific methods such as nm_device_ethernet_get_hw_address().

    Returns NM.Device[]

  • get_dns_mode(): string
  • get_dns_rc_manager(): string
  • get_logging(level: string, domains: string): boolean
  • Gets NetworkManager current logging level and domains.

    Parameters

    • level: string

      return location for logging level string

    • domains: string

      return location for log domains string. The string is a list of domains separated by ","

    Returns boolean

  • The #NMClient instance is permanently associated with the current thread default #GMainContext, referenced the time when the instance was created. To receive events, the user must iterate this context and can use it to synchronize access to the client.

    Note that even after #NMClient instance got destroyed, there might still be pending sources registered in the context. That means, to fully clean up, the user must continue iterating the context as long as the nm_client_get_context_busy_watcher() object is alive.

    Returns MainContext

  • get_nm_running(): boolean
  • get_object_by_path(dbus_path: string): NM.Object
  • Gets the #NMActiveConnection corresponding to the primary active network device.

    In particular, when there is no VPN active, or the VPN does not have the default route, this returns the active connection that has the default route. If there is a VPN active with the default route, then this function returns the active connection that contains the route to the VPN endpoint.

    If there is no default route, or the default route is over a non-NetworkManager-recognized device, this will return %NULL.

    Returns NM.ActiveConnection

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

    The value can be:

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

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

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

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_startup(): boolean
  • Tests whether the daemon is still in the process of activating connections at startup.

    Returns boolean

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

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

    This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

    When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

    Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

    For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

    Parameters

    • io_priority: number

      the [I/O priority][io-priority] of the operation

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • is_floating(): boolean
  • load_connections(filenames: string[], cancellable: Gio.Cancellable): [boolean, string]
  • Requests that the remote settings service load or reload the given files, adding or updating the connections described within.

    The changes to the indicated files will not yet be reflected in client's connections array when the function returns.

    If all of the indicated files were successfully loaded, the function will return %TRUE, and failures will be set to %NULL. If NetworkManager tried to load the files, but some (or all) failed, then failures will be set to a %NULL-terminated array of the filenames that failed to load.

    Parameters

    • filenames: string[]

      %NULL-terminated array of filenames to load

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns [boolean, string]

  • Requests that the remote settings service asynchronously load or reload the given files, adding or updating the connections described within.

    See nm_client_load_connections() for more details.

    Parameters

    • filenames: string[]

      %NULL-terminated array of filenames to load

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the operation completes

    Returns void

  • load_connections_finish(result: AsyncResult): [boolean, string[]]
  • Gets the result of an nm_client_load_connections_async() call.

    See nm_client_load_connections() for more details.

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns [boolean, string[]]

  • networking_get_enabled(): boolean
  • networking_set_enabled(enabled: boolean): boolean
  • Enables or disables networking. When networking is disabled, all controlled interfaces are disconnected and deactivated. When networking is enabled, all controlled interfaces are available for activation.

    Parameters

    • enabled: boolean

      %TRUE to set networking enabled, %FALSE to set networking disabled

    Returns boolean

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

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

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

    Parameters

    • property_name: string

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

    Returns void

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

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

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

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

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

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

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

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

    Returns void

  • 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

  • Reload NetworkManager's configuration and perform certain updates, like flushing caches or rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it allows for more fine-grained control over what to reload (see flags). It also allows non-root access via PolicyKit and contrary to signals it is synchronous.

    Parameters

    Returns void

  • Requests that the remote settings service reload all connection files from disk, adding, updating, and removing connections until the in-memory state matches the on-disk state.

    Parameters

    Returns boolean

  • Requests that the remote settings service begin reloading all connection files from disk, adding, updating, and removing connections until the in-memory state matches the on-disk state.

    Parameters

    Returns void

  • reload_connections_finish(result: AsyncResult): boolean
  • Gets the result of an nm_client_reload_connections_async() call.

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns boolean

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

    This function should only be called from object system implementations.

    Returns void

  • save_hostname(hostname: string, cancellable: Gio.Cancellable): boolean
  • Requests that the machine's persistent hostname be set to the specified value or cleared.

    Parameters

    • hostname: string

      the new persistent hostname to set, or %NULL to clear any existing persistent hostname

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns boolean

  • Requests that the machine's persistent hostname be set to the specified value or cleared.

    Parameters

    • hostname: string

      the new persistent hostname to set, or %NULL to clear any existing persistent hostname

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      callback to be called when the operation completes

    Returns void

  • Gets the result of an nm_client_save_hostname_async() call.

    Parameters

    • result: AsyncResult

      the result passed to the #GAsyncReadyCallback

    Returns boolean

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

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

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

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_logging(level: string, domains: string): boolean
  • Sets NetworkManager logging level and/or domains.

    Parameters

    • level: string

      logging level to set (%NULL or an empty string for no change)

    • domains: string

      logging domains to set. The string should be a list of log domains separated by ",". (%NULL or an empty string for no change)

    Returns boolean

  • set_property(property_name: string, value?: any): void
  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

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

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

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

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

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

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

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

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

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

    Returns void

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

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

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    virtual

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

    This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

    When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

    Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

    For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

    virtual

    Parameters

    • io_priority: number

      the [I/O priority][io-priority] of the operation

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    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.

    virtual

    Parameters

    Returns void

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

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • wimax_get_enabled(): boolean
  • wimax_hardware_get_enabled(): boolean
  • wimax_set_enabled(enabled: boolean): void
  • Enables or disables WiMAX devices.

    Parameters

    • enabled: boolean

      %TRUE to enable WiMAX

    Returns void

  • wireless_get_enabled(): boolean
  • wireless_hardware_get_enabled(): boolean
  • wireless_set_enabled(enabled: boolean): void
  • Enables or disables wireless devices.

    Parameters

    • enabled: boolean

      %TRUE to enable wireless

    Returns void

  • wwan_get_enabled(): boolean
  • wwan_hardware_get_enabled(): boolean
  • wwan_set_enabled(enabled: boolean): void
  • compat_control(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

    • g_iface: TypeInterface

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

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

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

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

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

    Parameters

    • g_iface: TypeInterface

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

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

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

    Parameters

    • g_iface: TypeInterface

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

    Returns ParamSpec[]

  • Creates a new #NMClient synchronously.

    Note that this will block until a NMClient instance is fully initialized. This does nothing beside calling g_initable_new(). You are free to call g_initable_new() or g_object_new()/g_initable_init() directly for more control, to set GObject properties or get access to the NMClient instance while it is still initializing.

    Using the synchronous initialization creates an #NMClient instance that uses an internal #GMainContext. This context is invisible to the user. This introduces an additional overhead that is payed not only during object initialization, but for the entire lifetime of this object. Also, due to this internal #GMainContext, the events are no longer in sync with other messages from #GDBusConnection (but all events of the NMClient will themselves still be ordered). For a serious program, you should therefore avoid these problems by using g_async_initable_init_async() or nm_client_new_async() instead. The sync initialization is still useful for simple scripts or interactive testing for example via pygobject.

    Creating an #NMClient instance can only fail for two reasons. First, if you didn't provide a %NM_CLIENT_DBUS_CONNECTION and the call to g_bus_get() fails. You can avoid that by using g_initable_new() directly and set a D-Bus connection. Second, if you cancelled the creation. If you do that, then note that after the failure there might still be idle actions pending which keep nm_client_get_main_context() alive. That means, in that case you must continue iterating the context to avoid leaks. See nm_client_get_context_busy_watcher().

    Creating an #NMClient instance when NetworkManager is not running does not cause a failure.

    Parameters

    Returns NM.Client

  • Creates a new #NMClient asynchronously. callback will be called when it is done. Use nm_client_new_finish() to get the result.

    This does nothing beside calling g_async_initable_new_async(). You are free to call g_async_initable_new_async() or g_object_new()/g_async_initable_init_async() directly for more control, to set GObject properties or get access to the NMClient instance while it is still initializing.

    Creating an #NMClient instance can only fail for two reasons. First, if you didn't provide a %NM_CLIENT_DBUS_CONNECTION and the call to g_bus_get() fails. You can avoid that by using g_async_initable_new_async() directly and set a D-Bus connection. Second, if you cancelled the creation. If you do that, then note that after the failure there might still be idle actions pending which keep nm_client_get_main_context() alive. That means, in that case you must continue iterating the context to avoid leaks. See nm_client_get_context_busy_watcher().

    Creating an #NMClient instance when NetworkManager is not running does not cause a failure.

    Parameters

    Returns void

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

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

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

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