| Index: doc/profile-api.txt
|
| diff --git a/doc/profile-api.txt b/doc/profile-api.txt
|
| index bb465a85716051a0d9de53d3dcdec799e2d57f14..dacd0d48a2f56249f2dd6517e472b3da1626e340 100644
|
| --- a/doc/profile-api.txt
|
| +++ b/doc/profile-api.txt
|
| @@ -12,6 +12,52 @@ Methods dict GetProperties()
|
|
|
| Possible Errors: [service].Error.InvalidArguments
|
|
|
| + void SetProperty(string name, variant value)
|
| +
|
| + Changes the value of the specified property. Only
|
| + properties that are listed as read-write are
|
| + changeable. On success a PropertyChanged signal
|
| + will be emitted.
|
| +
|
| + Possible Errors: [service].Error.InvalidArguments
|
| + [service].Error.InvalidProperty
|
| +
|
| + dict GetEntry(object path)
|
| +
|
| + Returns properties for the profile entry. The
|
| + following read-only properties are returned:
|
| +
|
| + string Name [readonly]
|
| + Name of this profile.
|
| +
|
| + boolean AutoConnect [readonly]
|
| + Auto-connection setting.
|
| +
|
| + string Failure [readonly]
|
| + Reason for last failure.
|
| +
|
| + string Modified [readonly]
|
| + Timestamp entry was last written.
|
| +
|
| + string Mode [readonly]
|
| + For WiFi services, the operating mode.
|
| +
|
| + string Security [readonly]
|
| + For WiFi services, the security type.
|
| +
|
| + Possible Errors: [service].Error.NotFound
|
| + [service].Error.InvalidArguments
|
| +
|
| + dict DeleteEntry(object path)
|
| +
|
| + Removes the entry from the profile. Any associated
|
| + service has its security credentials revoked but
|
| + is otherwise unaffected (i.e. it will remain connected).
|
| +
|
| + Possible Errors: [service].Error.PermissionDenied
|
| + [service].Error.InvalidArguments
|
| + [service].Error.NotFound
|
| +
|
| Signals PropertyChanged(string name, variant value)
|
|
|
| This signal indicates a changed value of the given
|
| @@ -25,8 +71,15 @@ Properties string Name [readonly]
|
|
|
| The offline mode indicates the setting for switching
|
| all radios on or off. Changing offline mode to true
|
| - results in powering down all devices.
|
| + results in powering down all devices. This setting
|
| + is recorded in the default profile so it affects all
|
| + users as well as pre-login.
|
|
|
| array{object} Services [readonly]
|
|
|
| List of service objects.
|
| +
|
| + array{object} Entries [readonly]
|
| +
|
| + List of profile Entry objects. Use the GetEntry
|
| + method to retrieve an Entry's contents.
|
|
|