# netctl-gui DBus API desription

# netctl-gui DBus API description

### Project version : 1.3.1

1. DBus API
2. Helper API
3. Helper ctrl API
4. Helper netctl API
5. GUI API
6. GUI netctlgui API
7. External links

## DBus API

method | responce | run as root
--- | --- | ---
`org.netctlgui.helper` service (system bus)
`/ctrl` path
bool Active() | `true` if the helper is active | no
QString ApiDocs() | returns path to this API documentation | no
bool Close() | `true` and closes the helper | no
QStringList FindSettings() | scans system and suggests the recommended configuration which will be used by the library | no
QString LibraryDocs() | returns path to the library documentation | no
QString Pony() | prints Pinkie Pie to stdout. Really, just try | no
QString SecurityDocs() | returns path to the security documentation | no
QStringList Settings() | current helper settings `KEY==VALUE` | no
QStringList UIDs() | returns the helper process UIDs `[UID, EUID]` | no
bool Update() | calls update the helper configuration. Returns `true` | no
bool Enable(QString profile) | enables or disables the profile. Returns `true` if action has been performed successfully | yes
bool forceStart(QString profile) | force starts the profile. Returns `true` if action has been performed successfully | yes
bool forceStop(QString profile) | force stops the profile. Returns `true` if action has been performed successfully | yes
bool Reenable(QString profile) | reenables the profile. Returns `true` if action has been performed successfully | yes
bool Restart(QString profile) | restarts the profile. Returns `true` if action has been performed successfully | yes
bool Start(QString profile) | starts or stops the profile. Returns `true` if action has been performed successfully | yes
bool StopAll() | stops all active profiles. Returns `true` if action has been performed successfully | yes
bool SwitchTo(QString profile) | switchs to the profile. Returns `true` if action has been performed successfully | yes
bool Create(QString profile, QStringList settingsList) | creates the profile with specified settings. Settings should be given in the format `KEY==VALUE`. Returns `true` if action has been performed successfully | yes
bool Remove(QString profile) | removes the profile. Returns `true` if action has been performed successfully | yes
bool autoDisableAll() | disables all profiles (netctl-auto). Returns `true` if action has been performed successfully | no?
bool autoEnable(QString profile) | enables or disables the profile (netctl-auto). Returns `true` if action has been performed successfully | no?
bool autoEnableAll() | enables all profiles (netctl-auto). Returns `true` if action has been performed successfully | no?
bool autoStart(QString profile) | switchs to the profile (netctl-auto). Returns `true` if action has been performed successfully | no?
bool autoServiceEnable() | enables or disables netctl-auto systemd service. Returns `true` if action has been performed successfully | yes
bool autoServiceRestart() | restarts netctl-auto systemd service. Returns `true` if action has been performed successfully | yes
bool autoServiceStart() | starts or stops netctl-auto systemd service. Returns `true` if action has been performed successfully | yes
QStringList WiFi() | returns available WiFi points in format `NAME|SECURITY|SIGNAL|ACTIVE|EXISTS` | yes
`/netctl` path
QString ActiveProfile() | returns active profile from netctl or netctl-auto | no
QString ActiveProfileStatus() | returns active profile status from netctl or netctl-auto. May be `netctl-auto`, `active (enabled)`, `active (static)`, `inactive (enabled)`, `inactive (static)` | no
QStringList Information() | returns general information in format `[ActiveProfile, ActiveProfileStatus]` | no
QStringList ProfileList() | returns available profiles in format `NAME|DESCRIPTION|ACTIVE|ENABLED` | no
QStringList WirelessInterface() | returns wireless interfaces | no
bool isProfileActive(QString profile) | returns `true` if the profile is active | no
bool isProfileEnabled(QString profile) | returns `true` if the profile is enabled | no
bool autoIsProfileActive(QString profile) | returns `true` if the profile is active (netctl-auto) | no
bool autoIsProfileEnabled(QString profile) | returns `true` if the profile is enabled (netctl-auto) | no
bool isNetctlAutoActive() | returns `true` if netctl-auto is active | no
bool isNetctlAutoEnabled() | returns `true` if netctl-auto is enabled | no
QStringList Profile(QString profile) | returns the profile settings in format `KEY==VALUE` | no
QString ProfileByEssid(QString essid) | returns the profile name by the given ESSID or empty line | no
QString ProfileValue(QString profile, QString key) | returns value of the key by the given profile or empty line | no
`org.netctlgui.netctlgui` service (session bus)
`/netctlgui` path
bool Active() | `true` if the application is active | no
void ApiDocs() | opens this API documentation | no
bool Close() | `true` and closes the application | no
QString Information() | returns general information in format `[ActiveProfile, ActiveProfileStatus]` | no
void LibraryDocs() | opens the library documentation | no
QString Pony() | prints Pinkie Pie to stdout. Really, just try | no
bool Restore() | `true` and restores the application | no
void SecurityDocs() | opens the security documentation | no
QStringList Settings() | current application settings `KEY==VALUE` | no
bool ShowAbout() | `true` and shows about window | no
bool ShowMain() | `true` and shows main window | no
bool ShowNetctlAuto() | `true` and shows netctl-auto window | no
bool ShowSettings() | `true` and shows settings window | no
QStringList UIDs() | returns the application process UIDs `[UID, EUID]` | no
QStringList VerboseInformation() | returns information in format `[isNetctlAutoActive, ProfileList, ActiveProfile, isProfileEnabled/autoIsProfileEnabled]` | no

## External links

- Homepage
- Repository
- Bugtracker

© 2014-2014 Evgeniy Alekseev
This software is licensed under GPLv3