ModemManager::ModemMessaging Class
class ModemManager::ModemMessagingThe ModemMessaging class. More...
| Header: | #include <ModemManagerQt/ModemMessaging> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS ModemManagerQt)target_link_libraries(mytarget PRIVATE KF6::ModemManagerQt) |
| Inherits: | ModemManager::Interface |
Public Types
Public Functions
| ModemMessaging(const QString &path, QObject *parent = nullptr) | |
| QDBusPendingReply<QDBusObjectPath> | createMessage(const ModemManager::ModemMessaging::Message &message) |
| QDBusPendingReply<QDBusObjectPath> | createMessage(const QVariantMap &message) |
| MMSmsStorage | defaultStorage() const |
| QDBusPendingReply<void> | deleteMessage(const QString &uni) |
| ModemManager::Sms::Ptr | findMessage(const QString &uni) |
| ModemManager::Sms::List | messages() const |
| void | setTimeout(int timeout) |
| QList<MMSmsStorage> | supportedStorages() const |
| int | timeout() const |
Signals
| void | messageAdded(const QString &uni, bool received) |
| void | messageDeleted(const QString &uni) |
Detailed Description
The Messaging interface handles sending SMS messages and notification of new incoming messages.
Member Type Documentation
ModemMessaging::List
ModemMessaging::Ptr
Member Function Documentation
[explicit] ModemMessaging::ModemMessaging(const QString &path, QObject *parent = nullptr)
QDBusPendingReply<QDBusObjectPath> ModemMessaging::createMessage(const ModemManager::ModemMessaging::Message &message)
Creates a new message object.
message Message structure with the 'number' and either 'text' or 'data' properties
QDBusPendingReply<QDBusObjectPath> ModemMessaging::createMessage(const QVariantMap &message)
Creates a new message object.
message QVariantMap containing message properties
The 'number' and either 'text' or 'data' properties are mandatory, others are optional.
MMSmsStorage ModemMessaging::defaultStorage() const
Returns A MMSmsStorage value, specifying the storage to be used when receiving or storing SMS.
QDBusPendingReply<void> ModemMessaging::deleteMessage(const QString &uni)
Delete an SMS message.
uni path to the Sms object
ModemManager::Sms::Ptr ModemMessaging::findMessage(const QString &uni)
uni path to the Sms object
Returns pointer to the found Sms (may be null if not found)
[signal] void ModemMessaging::messageAdded(const QString &uni, bool received)
Emitted when any part of a new SMS has been received or added (but not for subsequent parts, if any). For messages received from the network, not all parts may have been received and the message may not be complete.
Check the 'State' property to determine if the message is complete.
uni path to the Sms object
received true if the message was received from the network, as opposed to being added locally.
[signal] void ModemMessaging::messageDeleted(const QString &uni)
Emitted when a message has been deleted.
uni path to the Sms object
ModemManager::Sms::List ModemMessaging::messages() const
Retrieve all SMS messages.
This method should only be used once and subsequent information retrieved either by listening for the messageAdded() signal, or by querying the specific SMS object of interest using findMessage()
void ModemMessaging::setTimeout(int timeout)
Sets the timeout in milliseconds for all async method DBus calls.
-1 means the default DBus timeout (usually 25 seconds).
See also timeout().
QList<MMSmsStorage> ModemMessaging::supportedStorages() const
Returns A list of MMSmsStorage values, specifying the storages supported by this modem for storing and receiving SMS.
int ModemMessaging::timeout() const
Returns the current value of the DBus timeout in milliseconds.
-1 means the default DBus timeout (usually 25 seconds).
See also setTimeout().