search

almostearthling / when-command

When is an automation tool that aims at being flexible and cross platform
http://almostearthling.github.io/when-command/
BSD 3-Clause "New" or "Revised" License
68 stars 2 forks source link

Better DBus interface #75

Closed almostearthling closed 8 years ago

almostearthling commented 8 years ago

The DBus API should be improved as follows:

  1. the method names should be more compliant with common paradigms, in other words accessible DBus interface components should use CamelCase for naming
  2. some more functionality should be exposed to the DBus interface: most operations that can be performed via the CLI should be accessible in a solid and documented way through DBus
  3. DBus exposed functionality should make the least possible use of Variant data
  4. possibly, follow the API Design Guidelines and describe When's DBus API using XML files for interfaces.

Documentation for the When API should only be provided in the Contributor's Manual. API compatibility break is NOT of any concern, since the DBus interface was only supposed to be used by the CLI command to communicate with a running applet until now. It will be a concern though, when the API will be made public.

This should allow a tighter integration with external tools, such as the upcoming Wizard UI.

almostearthling commented 8 years ago

Commit 508e62fb41a096783fb4b8089aba24eeadf251b2 starts by renaming current methods.

almostearthling commented 8 years ago

Commit 5786aeaf8fd17d96633be3f256752a1d8fd34a76 closes this issue: the DBus API is now complete and can be documented in the developer guide. As a bonus, this allowed for removal of the ShowIcon specific API, which is now replaced by a ConfigSet call with reload.