SettingVpn
Object Hierarchy:
Description:
VPN Settings
Namespace: NM
Package: libnm
Content:
Constants:
- public const string DATA
- public const string PERSISTENT
- public const string SECRETS
- public const string SERVICE_TYPE
- public const string SETTING_NAME
- public const string TIMEOUT
- public const string USER_NAME
Properties:
- public HashTable<string,string> data { owned get; set; }
Dictionary of key/value pairs of VPN plugin specific data.
- public bool persistent { get; set; }
If the VPN service supports persistence, and this property is true, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.
- public HashTable<string,string> secrets { owned get; set; }
Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys.
- public string service_type { owned get; set; }
D-Bus service name of the VPN plugin that this setting uses to connect to its network.
- public uint timeout { get; set; }
Timeout for the VPN service to establish the connection.
- public string user_name { owned get; set; }
If the VPN connection requires a user name for authentication, that name should be provided here.
Creation methods:
- public SettingVpn ()
Creates a new SettingVpn object with default values.
Methods:
- public void add_data_item (string key, string? item)
Establishes a relationship between
key
anditem
internally in the setting which may be retrieved later. - public void add_secret (string key, string? secret)
Establishes a relationship between
key
andsecret
internally in the setting which may be retrieved later. - public void foreach_data_item (VpnIterFunc func)
Iterates all data items stored in this setting.
- public void foreach_secret (VpnIterFunc func)
Iterates all secrets stored in this setting.
- public unowned string get_data_item (string key)
Retrieves the data item of a key/value relationship previously established by add_data_item.
- public (unowned string)[]? get_data_keys ()
Retrieves every data key inside this, as an array.
- public uint32 get_num_data_items ()
Gets number of key/value pairs of VPN configuration data.
- public uint32 get_num_secrets ()
Gets number of VPN plugin specific secrets in the setting.
- public bool get_persistent ()
- public unowned string get_secret (string key)
Retrieves the secret of a key/value relationship previously established by add_secret.
- public (unowned string)[]? get_secret_keys ()
Retrieves every secret key inside this, as an array.
- public unowned string get_service_type ()
Returns the service name of the VPN, which identifies the specific VPN plugin that should be used to connect to this VPN.
- public uint32 get_timeout ()
- public unowned string get_user_name ()
- public bool remove_data_item (string key)
Deletes a key/value relationship previously established by add_data_item.
- public bool remove_secret (string key)
Deletes a key/value relationship previously established by add_secret.
Inherited Members:
All known members inherited from class NM.Setting
All known members inherited from class GLib.Object