Differential D11854 Diff 35899 plugins/telephony/telephonyplugin.h

Changeset View

Standalone View

View Options

plugins/telephony/telephonyplugin.h

1/** 1​/**
2 * Copyright 2013 Albert Vaca <albertvaka@gmail.com> 2​ * Copyright 2013 Albert Vaca <albertvaka@gmail.com>
3​ * Copyright 2018 Simon Redman <simon@ergotech.com>
3 * 4​ *
4 * This program is free software; you can redistribute it and/or 5​ * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as 6​ * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 of 7​ * published by the Free Software Foundation; either version 2 of
7 * the License or (at your option) version 3 or any later version 8​ * the License or (at your option) version 3 or any later version
8 * accepted by the membership of KDE e.V. (or its successor approved 9​ * accepted by the membership of KDE e.V. (or its successor approved
9 * by the membership of KDE e.V.), which shall act as a proxy 10​ * by the membership of KDE e.V.), which shall act as a proxy
10 * defined in Section 14 of version 3 of the license. 11​ * defined in Section 14 of version 3 of the license.
11 * 12​ *
12 * This program is distributed in the hope that it will be useful, 13​ * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details. 16​ * GNU General Public License for more details.
16 * 17​ *
17 * You should have received a copy of the GNU General Public License 18​ * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>. 19​ * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */ 20​ */
20 21​
21#ifndef TELEPHONYPLUGIN_H 22​#ifndef TELEPHONYPLUGIN_H
22#define TELEPHONYPLUGIN_H 23​#define TELEPHONYPLUGIN_H
23 24​
25​#include "conversationsdbusinterface.h"
26​#include "interfaces/conversationmessage.h"
27​
24#include <QLoggingCategory> 28​#include <QLoggingCategory>
25#include <QDBusInterface> 29​#include <QDBusInterface>
26 30​
27#include <KNotification> 31​#include <KNotification>
28 32​
29#include <core/kdeconnectplugin.h> 33​#include <core/kdeconnectplugin.h>
30 34​
35​/**
36​ * Packet used to indicate a batch of messages has been pushed from the remote device
37​ *
38​ * The body should contain the key "messages" mapping to an array of messages
39​ *
40​ * For example:
41​ * { "messages" : [
42​ * { "event" : "sms",
43​ * "messageBody" : "Hello",
44​ * "phoneNumber" : "2021234567",
45​ * "messageDate" : "1518846484880",
46​ * "messageType" : "2",
47​ * "threadID" : "132"
48​ * },
49​ * { ... },
50​ * ...
51​ * ]
52​ * }
53​ */
54​#define PACKET_TYPE_TELEPHONY_MESSAGE QStringLiteral("kdeconnect.telephony.message")
55​
56​/**
57​ * Packet used for simple telephony events
58​ *
59​ * It contains the key "event" which maps to a string indicating the type of event:
60​ * - "ringing" - A phone call is incoming
61​ * - "missedCall" - An incoming call was not answered
62​ * - "sms" - An incoming SMS message
63​ * - Note: As of this writing (15 May 2018) the SMS interface is being improved and this type of event
64​ * is no longer the preferred way of retrieving SMS. Use PACKET_TYPE_TELEPHONY_MESSAGE instead.
65​ *
66​ * Depending on the event, other fields may be defined
67​ */
68​#define PACKET_TYPE_TELEPHONY QStringLiteral("kdeconnect.telephony")
69​
31#define PACKET_TYPE_TELEPHONY_REQUEST QStringLiteral("kdeconnect.telephony.request") 70​#define PACKET_TYPE_TELEPHONY_REQUEST QStringLiteral("kdeconnect.telephony.request")
32#define PACKET_TYPE_SMS_REQUEST QStringLiteral("kdeconnect.sms.request") 71​#define PACKET_TYPE_SMS_REQUEST QStringLiteral("kdeconnect.sms.request")
33 72​
73​/**
74​ * Packet sent to request all the most-recent messages in all conversations on the device
75​ *
76​ * The request packet shall contain no body
77​ */
78​#define PACKET_TYPE_TELEPHONY_REQUEST_CONVERSATIONS QStringLiteral("kdeconnect.telephony.request_conversations")
79​
80​/**
81​ * Packet sent to request all the messages in a particular conversation
82​ *
83​ * The body should contain the key "threadID" mapping to the threadID (as a string) being requested
84​ * For example:
85​ * { "threadID": 203 }
86​ */
87​#define PACKET_TYPE_TELEPHONY_REQUEST_CONVERSATION QStringLiteral("kdeconnect.telephony.request_conversation")
88​
34Q_DECLARE_LOGGING_CATEGORY(KDECONNECT_PLUGIN_TELEPHONY) 89​Q_DECLARE_LOGGING_CATEGORY(KDECONNECT_PLUGIN_TELEPHONY)
35 90​
36class TelephonyPlugin 91​class TelephonyPlugin
37 : public KdeConnectPlugin 92​ : public KdeConnectPlugin
38{ 93​{
39 Q_OBJECT 94​ Q_OBJECT
40 Q_CLASSINFO("D-Bus Interface", "org.kde.kdeconnect.device.telephony") 95​ Q_CLASSINFO("D-Bus Interface", "org.kde.kdeconnect.device.telephony")
41 96​
42public: 97​public:
43 explicit TelephonyPlugin(QObject* parent, const QVariantList& args); 98​ explicit TelephonyPlugin(QObject* parent, const QVariantList& args);
99​ ~TelephonyPlugin() override;
44 100​
45 bool receivePacket(const NetworkPacket& np) override; 101​ bool receivePacket(const NetworkPacket& np) override;
46 void connected() override {} 102​ void connected() override {}
47 QString dbusPath() const override; 103​ QString dbusPath() const override;
48 104​
49public Q_SLOTS: 105​public Q_SLOTS:
50 Q_SCRIPTABLE void sendSms(const QString& phoneNumber, const QString& messageBody); 106​ Q_SCRIPTABLE void sendSms(const QString& phoneNumber, const QString& messageBody);
51 107​
108​ /**
109​ * Send a request to the remote for all of its conversations
110​ */
apolUnsubmitted
Done

requestAllConversations()?

apol: requestAllConversations()?
111​ Q_SCRIPTABLE void requestAllConversations();
112​
113​ /**
114​ * Send a request to the remote for a particular conversation
115​ */
116​ Q_SCRIPTABLE void requestConversation(const QString& conversationID) const;
117​
118​public:
119​Q_SIGNALS:
120​
52private Q_SLOTS: 121​private Q_SLOTS:
53 void sendMutePacket(); 122​ void sendMutePacket();
54 void showSendSmsDialog(); 123​ void showSendSmsDialog();
55 124​
125​protected:
126​ /**
127​ * Send to the telepathy plugin if it is available
128​ */
129​ void forwardToTelepathy(const ConversationMessage& message);
130​
131​ /**
132​ * Handle a packet which contains many messages, such as PACKET_TYPE_TELEPHONY_MESSAGE
133​ */
134​ bool handleBatchMessages(const NetworkPacket& np);
135​
56private: 136​private:
137​ /**
138​ * Create a notification for:
139​ * - Incoming call (with the option to mute the ringing)
140​ * - Missed call
141​ * - Incoming SMS (with the option to reply)
142​ * - This comment is being written while SMS handling is in the process of being improved.
143​ * As such, any code in createNotification which deals with SMS is legacy support
144​ */
57 KNotification* createNotification(const NetworkPacket& np); 145​ KNotification* createNotification(const NetworkPacket& np);
58 146​
59 QDBusInterface m_telepathyInterface; 147​ QDBusInterface m_telepathyInterface;
148​ ConversationsDbusInterface* m_conversationInterface;
60}; 149​};
61 150​
62#endif 151​#endif