kdeconnect-kde/plugins
Simon Redman 64062b3cc9 [Desktop] SMS plugin no longer creates desktop notifications -- Old functionality still supported by notifications plugin
Summary:
Drop support for creating notifications from the SMS plugin. The old usecase is better handled by the notifications plugin reply box anyway

Rename packets defined in SMS plugin from PACKET_TYPE_TELEPHONY_* to PACKET_TYPE_SMS_*

Update TELEPHONY plugin packet description to point to SMS plugin

Define TELEPHONY_REQUEST_MUTE packet to replace old TELEPHONY_REQUEST with mute event field

Please see Android-side patch here: D15544

Test Plan:
I see four test cases, based on the version of the app being used, where "old" means any version built with sources not containing this revision and "new" means any version built with sources using this revision:
 - New Android vs. New Desktop
   - Supported and works for me
 - New Android vs. Old Desktop
   - Supported and works for me
 - Old Android vs. New Desktop
   - Not supported - Download a new app from the Play store or F-Droid
 - Old Android vs. Old Desktop
   - If this is broken, it is not my fault :)

In the supported use cases:
 - Test SMS reply
   - Receive SMS (or MMS!) message
   - Verify that the //notification// plugin forwards a replyable notification and that replying works
 - Test incoming call ringer mute
   - Enable ringer volume (not vibrate)
   - Receive phone call
   - Verify a desktop notification with a Mute button appears
   - Verify that clicking the mute button causes the phone to stop making the ringer noise (vibration not affected)

Reviewers: #kde_connect, albertvaka, nicolasfella

Reviewed By: #kde_connect, albertvaka, nicolasfella

Subscribers: nicolasfella, kdeconnect

Tags: #kde_connect

Differential Revision: https://phabricator.kde.org/D15543
2018-09-16 16:06:53 -06:00
..
battery Build kdeconnect on sailfish and port some simple plugins 2018-08-02 20:10:59 +01:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-18 05:27:46 +02:00
contacts Use better icon for contactsplugin 2018-09-10 17:30:49 +02:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-21 05:33:36 +02:00
findthisdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2018-08-18 05:41:47 +02:00
lockdevice Show icons in plugin list 2018-08-03 02:25:39 +02:00
mousepad Fix crashing devicetest 2018-07-12 16:14:44 +02:00
mpriscontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-21 05:33:36 +02:00
mprisremote SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-18 05:27:46 +02:00
notifications SVN_SILENT made messages (.desktop file) - always resolve ours 2018-08-27 05:46:19 +02:00
pausemusic SVN_SILENT made messages (.desktop file) - always resolve ours 2018-08-04 05:41:07 +02:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-18 05:27:46 +02:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2018-07-19 05:21:27 +02:00
remotecontrol Show icons in plugin list 2018-08-03 02:25:39 +02:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2018-08-18 05:41:47 +02:00
runcommand Remove characters from UUID that aren't legal in URLs 2018-08-01 11:10:14 +02:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-21 05:33:36 +02:00
sendnotifications SVN_SILENT made messages (.desktop file) - always resolve ours 2018-08-27 05:46:19 +02:00
sftp Spelling corrections in kde-connect sftp plugin 2018-09-13 16:56:00 +02:00
share SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-21 05:33:36 +02:00
sms [Desktop] SMS plugin no longer creates desktop notifications -- Old functionality still supported by notifications plugin 2018-09-16 16:06:53 -06:00
systemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2018-09-03 05:46:27 +02:00
telephony [Desktop] SMS plugin no longer creates desktop notifications -- Old functionality still supported by notifications plugin 2018-09-16 16:06:53 -06:00
CMakeLists.txt Split SMS and Telephony plugin on desktop 2018-09-10 11:31:05 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2018-08-27 05:46:19 +02:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2018-06-18 05:27:46 +02:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Fix typos 2018-07-27 15:00:23 +02:00

Writing 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-SupportedPacketType and X-KDEConnect-OutgoingPacketType to the packet 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 PACKET_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/NetworkPacket.java. Copy a "public final static String PACKET_TYPE_PING = …" line
   replacing "PING" with the packet type you will be using (should match the desktop client).
9. Now you have an empty skeleton to implement your new plugin logic.