kdeconnect-kde/plugins
Albert Vaca 30f00fb3fa Fix a crash where unmount was called again after m_proc had been destroyed
This happened because of scheduling m_proc->kill() from unmount 5 seconds
after the destructor was called (which was who called unmount first).

Simplified unmount logic a bit as well. Known bug: we might end with a fuse
mountpoint still mounted after killing the sshfs process.

BUG: 352861
2015-10-17 17:31:17 -07:00
..
battery run Clang Modernize 2015-09-08 10:47:37 +02:00
clipboard run Clang Modernize 2015-09-08 10:47:37 +02:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2015-09-01 12:31:29 +00:00
mousepad run Clang Modernize 2015-09-08 10:47:37 +02:00
mpriscontrol Were connecting to the wrong slot 2015-09-11 03:06:26 -07:00
mprisremote SVN_SILENT made messages (.desktop file) - always resolve ours 2015-09-01 12:31:29 +00:00
notifications Use id instead of a pointer in the dismissRequested signal and slot. 2015-10-17 15:32:13 -07:00
pausemusic run Clang Modernize 2015-09-08 10:47:37 +02:00
ping run Clang Modernize 2015-09-08 10:47:37 +02:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2015-09-01 12:31:29 +00:00
screensaver-inhibit run Clang Modernize 2015-09-08 10:47:37 +02:00
sftp Fix a crash where unmount was called again after m_proc had been destroyed 2015-10-17 17:31:17 -07:00
share Make the origin also contain the file name, not only the device name 2015-10-17 13:32:57 -07:00
telephony Fixed notification flags being overwritten 2015-09-09 01:17:44 -07:00
CMakeLists.txt Make it possible to lock the screen from KDE Connect 2015-07-22 03:37:34 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2015-05-26 13:51:37 +00:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2015-04-06 09:54:12 +00:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Added a README about how to create a plugin. 2014-12-21 19:37:41 -08:00

Writting a plugin for KDE Connect
=================================

For the desktop client (this project):
--------------------------------------

1. Enter the "plugins" directory.
2. Copy the "ping" under a different name ("findmyphone" in this example).
3. Add "add_subdirectory(findmyphone)" to CMakeLists.txt after the others "add_subdirectory".
1. Enter the new "findmyphone" directory.
5. Edit CMakeLists.txt by replacing "ping" with "findmyphone".
6. Rename other files in this directory by replacing "ping" with "findmyphone"
7. Write a description of your plugin into "README"
8. Edit findmyphoneplugin.cpp and findmyphoneplugin.h.
  A. Change license header.
  B. Replace (case sensitive) "ping" with "findmyphone", "PingPlugin" with "FindMyPhonePlugin" and "PING" with "FINDMYPHONE".
9. Edit kdeconnect_findmyphone.desktop file:
  A. Replace "ping" with "findmyphone".
  B. Change name, description, icon, author, email, version, website, license info.
  C. Remove all the translations
  D. Set X-KDEConnect-SupportedPackageType and X-KDEConnect-OutgoingPackageType to the package type your plugin will receive
     and send, respectively. In this example this is "kdeconnect.findmyphone". Make sure that this matches what is defined in
     the findmyplugin.h file (in the line "#define PACKAGE_TYPE_..."), and also in Android.
10. Now you have an empty skeleton to implement your new plugin logic.

For Android (project kdeconnect-android):
-----------------------------------------

1. Change directory to src/org/kde/kdeconnect/Plugins.
2. Copy "PingPlugin" under a different name ("FindMyPhonePlugin" in this example).
1. Enter the new "FindMyPhonePlugin" directory.
4. Rename "PingPlugin.java" to "FindMyPhonePlugin.java"
5. Edit it. Replace (case sensitive) "Ping" with "FindMyPhone", "ping" with "findmyphone", "PING" with "FINDMYPHONE"
   and "plugin_ping" with "plugin_findmyphone".
6. Open res/values/strings.xml. Find and copy the lines "pref_plugin_ping_desc" and "pref_plugin_ping" replacing "ping"
   with "findmyphone" and edit the plugin name and description between <string> </string>).
7. Open src/org/kde/kdeconnect/Plugins/PluginFactory.java.
  A. Copy "import … PingPlugin" line with replacing "PingPlugin" with "FindMyPhonePlugin".
  B. Copy "PluginFactory.registerPlugin(PingPlugin.class);" line with replacing "PingPlugin" with "FindMyPhonePlugin".
8. Open src/org/kde/kdeconnect/NetworkPackage.java. Copy a "public final static String PACKAGE_TYPE_PING = …" line
   replacing "PING" with the package type you will be using (should match the desktop client).
9. Now you have an empty skeleton to implement your new plugin logic.