Blame introspection/org.freedesktop.NetworkManager.Settings.Connection.xml

Packit Service b23acc
Packit Service b23acc
<node name="/">
Packit Service b23acc
Packit Service b23acc
  
Packit Service b23acc
      org.freedesktop.NetworkManager.Settings.Connection:
Packit Service b23acc
      @short_description: Connection Settings Profile
Packit Service b23acc
Packit Service b23acc
      Represents a single network connection configuration.
Packit Service b23acc
  -->
Packit Service b23acc
  <interface name="org.freedesktop.NetworkManager.Settings.Connection">
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Update:
Packit Service b23acc
        @properties: New connection settings, properties, and (optionally) secrets.
Packit Service b23acc
Packit Service b23acc
        Update the connection with new settings and properties (replacing all
Packit Service b23acc
        previous settings and properties) and save the connection to disk. Secrets
Packit Service b23acc
        may be part of the update request, and will be either stored in persistent
Packit Service b23acc
        storage or sent to a Secret Agent for storage, depending on the flags
Packit Service b23acc
        associated with each secret.
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="Update">
Packit Service b23acc
      <arg name="properties" type="a{sa{sv}}" direction="in"/>
Packit Service b23acc
    </method>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        UpdateUnsaved:
Packit Service b23acc
        @properties: New connection settings, properties, and (optionally) secrets.
Packit Service b23acc
Packit Service b23acc
        Update the connection with new settings and properties (replacing all
Packit Service b23acc
        previous settings and properties) but do not immediately save the
Packit Service b23acc
        connection to disk. Secrets may be part of the update request and may sent
Packit Service b23acc
        to a Secret Agent for storage, depending on the flags associated with each
Packit Service b23acc
        secret. Use the 'Save' method to save these changes to disk. Note that
Packit Service b23acc
        unsaved changes will be lost if the connection is reloaded from disk
Packit Service b23acc
        (either automatically on file change or due to an explicit
Packit Service b23acc
        ReloadConnections call).
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="UpdateUnsaved">
Packit Service b23acc
      <arg name="properties" type="a{sa{sv}}" direction="in"/>
Packit Service b23acc
    </method>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Delete:
Packit Service b23acc
Packit Service b23acc
        Delete the connection.
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="Delete"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        GetSettings:
Packit Service b23acc
        @settings: The nested settings maps describing this object.
Packit Service b23acc
Packit Service b23acc
        Get the settings maps describing this network configuration. This will
Packit Service b23acc
        never include any secrets required for connection to the network, as those
Packit Service b23acc
        are often protected. Secrets must be requested separately using the
Packit Service b23acc
        GetSecrets() call.
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="GetSettings">
Packit Service b23acc
      <arg name="settings" type="a{sa{sv}}" direction="out"/>
Packit Service b23acc
    </method>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        GetSecrets:
Packit Service b23acc
        @setting_name: Name of the setting to return secrets for. If empty, all all secrets will be returned.
Packit Service b23acc
        @secrets: Nested settings maps containing secrets.
Packit Service b23acc
Packit Service b23acc
        Get the secrets belonging to this network configuration. Only secrets from
Packit Service b23acc
        persistent storage or a Secret Agent running in the requestor's session
Packit Service b23acc
        will be returned. The user will never be prompted for secrets as a result
Packit Service b23acc
        of this request.
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="GetSecrets">
Packit Service b23acc
      <arg name="setting_name" type="s" direction="in"/>
Packit Service b23acc
Packit Service b23acc
      <arg name="secrets" type="a{sa{sv}}" direction="out"/>
Packit Service b23acc
    </method>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        ClearSecrets:
Packit Service b23acc
Packit Service b23acc
        Clear the secrets belonging to this network connection profile.
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="ClearSecrets"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Save:
Packit Service b23acc
Packit Service b23acc
        Saves a "dirty" connection (that had previously been updated with
Packit Service b23acc
        UpdateUnsaved) to persistent storage.
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="Save"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Updated:
Packit Service b23acc
Packit Service b23acc
        Emitted when any settings or permissions change. When handling this
Packit Service b23acc
        signal, clients should re-read the connection using the GetSettings method
Packit Service b23acc
        to get the changes and to ensure the client still has permission to access
Packit Service b23acc
        the connection.
Packit Service b23acc
    -->
Packit Service b23acc
    <signal name="Updated"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Update2:
Packit Service b23acc
        @settings: New connection settings, properties, and (optionally) secrets.
Packit Service b23acc
          Provide an empty array, to use the current settings.
Packit Service b23acc
        @flags: optional flags argument. Currently supported flags are:
Packit Service b23acc
          "0x1" (to-disk),
Packit Service b23acc
          "0x2" (in-memory),
Packit Service b23acc
          "0x4" (in-memory-detached),
Packit Service b23acc
          "0x8" (in-memory-only),
Packit Service b23acc
          "0x10" (volatile),
Packit Service b23acc
          "0x20" (block-autoconnect),
Packit Service b23acc
          "0x40" (no-reapply).
Packit Service b23acc
          Unknown flags cause the call to fail.
Packit Service b23acc
        @args: optional arguments dictionary, for extensibility. Currently no
Packit Service b23acc
          arguments are accepted. Specifying unknown keys causes the call
Packit Service b23acc
          to fail.
Packit Service b23acc
        @result: output argument, currently no results are returned.
Packit Service b23acc
Packit Service b23acc
        Update the connection with new settings and properties (replacing all
Packit Service b23acc
        previous settings and properties). If the flag 0x1 is present,
Packit Service b23acc
        the connection is persisted to disk. If the flag 0x2 is present,
Packit Service b23acc
        the change is only made in memory (without touching an eventual
Packit Service b23acc
        profile on disk). If neither 0x1 nor 0x2 is set, the change is made
Packit Service b23acc
        in memory only, if the connection is already in memory only.
Packit Service b23acc
        The flags 0x4 (in-memory-detached) and 0x8 (in-memory-only) are like
Packit Service b23acc
        "in-memory", but behave slightly different when migrating the profile
Packit Service b23acc
        from disk to in-memory.
Packit Service b23acc
        The flag 0x20 (block-autoconnect) blocks auto-connect on the updated
Packit Service b23acc
        profile, and 0x40 (no-reapply) prevents "connection.zone" and "connection.metered"
Packit Service b23acc
        properties to take effect on currently active devices.
Packit Service b23acc
        Secrets may be part of the update request, and will be either stored in persistent
Packit Service b23acc
        storage or sent to a Secret Agent for storage, depending on the flags
Packit Service b23acc
        associated with each secret.
Packit Service b23acc
Packit Service b23acc
        Update2 is a extensible alternative to Update, UpdateUnsaved and Save.
Packit Service b23acc
Packit Service b23acc
        Since: 1.12
Packit Service b23acc
    -->
Packit Service b23acc
    <method name="Update2">
Packit Service b23acc
      <arg name="settings" type="a{sa{sv}}" direction="in"/>
Packit Service b23acc
      <arg name="flags" type="u" direction="in"/>
Packit Service b23acc
      <arg name="args" type="a{sv}" direction="in"/>
Packit Service b23acc
      <arg name="result" type="a{sv}" direction="out"/>
Packit Service b23acc
    </method>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Removed:
Packit Service b23acc
Packit Service b23acc
        Emitted when this connection is no longer available. This happens when the
Packit Service b23acc
        connection is deleted or if it is no longer accessible by any of the
Packit Service b23acc
        system's logged-in users. After receipt of this signal, the object no
Packit Service b23acc
        longer exists. Also see the Settings.ConnectionRemoved signal.
Packit Service b23acc
    -->
Packit Service b23acc
    <signal name="Removed"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Unsaved:
Packit Service b23acc
Packit Service b23acc
        If set, indicates that the in-memory state of the connection does not
Packit Service b23acc
        match the on-disk state. This flag will be set when UpdateUnsaved() is
Packit Service b23acc
        called or when any connection details change, and cleared when the
Packit Service b23acc
        connection is saved to disk via Save() or from internal operations.
Packit Service b23acc
    -->
Packit Service b23acc
    <property name="Unsaved" type="b" access="read"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Flags:
Packit Service b23acc
Packit Service b23acc
        Additional flags of the connection profile.
Packit Service b23acc
Packit Service b23acc
        Returns: <link linkend="NMSettingsConnectionFlags">NMSettingsConnectionFlags</link>
Packit Service b23acc
Packit Service b23acc
        Since: 1.12
Packit Service b23acc
    -->
Packit Service b23acc
    <property name="Flags" type="u" access="read"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        Filename:
Packit Service b23acc
Packit Service b23acc
        File that stores the connection in case the connection is file-backed.
Packit Service b23acc
Packit Service b23acc
        Since: 1.12
Packit Service b23acc
    -->
Packit Service b23acc
    <property name="Filename" type="s" access="read"/>
Packit Service b23acc
Packit Service b23acc
    
Packit Service b23acc
        PropertiesChanged:
Packit Service b23acc
        @properties: A dictionary mapping property names to variant boxed values.
Packit Service b23acc
Packit Service b23acc
        DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
Packit Service b23acc
    -->
Packit Service b23acc
    <signal name="PropertiesChanged">
Packit Service b23acc
      <arg name="properties" type="a{sv}"/>
Packit Service b23acc
    </signal>
Packit Service b23acc
  </interface>
Packit Service b23acc
</node>