From b0a2c769079d4c28e55ec8fbc72244e386f2c6ac Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Wed, 27 Jul 2011 21:37:35 -0500 Subject: [PATCH] api: update proposed new SMS API Finish most of the stuff here. --- ...freedesktop.ModemManager.Modem.Gsm.SMS.xml | 120 ---------------- ...edesktop.ModemManager1.Modem.Messaging.xml | 133 ++++++++++++++++++ ...rg.freedesktop.ModemManager1.Modem.SMS.xml | 110 +++++++++++++++ 3 files changed, 243 insertions(+), 120 deletions(-) delete mode 100644 new/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml create mode 100644 new/org.freedesktop.ModemManager1.Modem.Messaging.xml create mode 100644 new/org.freedesktop.ModemManager1.Modem.SMS.xml diff --git a/new/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml b/new/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml deleted file mode 100644 index 9645462a..00000000 --- a/new/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - - - Delete an SMS message. - - - - - - The index of the SMS. - - - - - - - Retrieve an SMS from the SIM card. - - - - - - The index of the SMS. - - - - - A dictionary containing SMS properties of the SMS specified by the given index. This dictionary may contain the following key/value pairs: - - number : string - Phone number (mandatory) - text : string - SMS text (mandatory) - smsc : string - SMS service center number (optional) - validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) - class : uint (0..3) - Message importance and location (optional) - completed: boolean - Whether all message parts have been received or not (optional) - index : uint - Index of message (for Get and Delete) (optional) - - - - - - - Retrieve all SMS messages. - - - - - - An array of dictionaries, each dictionary representing an SMS message. - Each dictionary contains key/value pairs as described by the Get - method. - - - - - - - - - - SMS properties to save with the following key values: - - number : string - Phone number (mandatory) - text : string - SMS text (mandatory) - smsc : string - SMS service center number (optional) - validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) - class : uint (0..3) - Message importance and location (optional) - - - - - - - - - - Emitted when any part of a new SMS has been received (but not for - subsequent parts, if any). Not all parts may have been received and the - message may not be complete; if it is, the 'complete' argument will be - TRUE. - - - - Index of the new SMS. - - - - - TRUE if all message parts have been received, otherwise FALSE. - - - - - - - Emitted when the complete-ness status of an SMS message changes. An SMS - may not necessarily be complete when the first part is received; this - signal will be emitted when all parts have been received, even for - single-part messages. - - - - The index of the SMS. - - - - - TRUE if all message parts have been received, otherwise FALSE. - - - - - - diff --git a/new/org.freedesktop.ModemManager1.Modem.Messaging.xml b/new/org.freedesktop.ModemManager1.Modem.Messaging.xml new file mode 100644 index 00000000..165cedff --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.Messaging.xml @@ -0,0 +1,133 @@ + + + + + + + This interface handles sending SMS messages and notification of new + incoming messages. + + + + + + + Retrieve all SMS messages. + + + + + + A dict of message object paths mapped to a dictionary containing that + message's properties as specified in the + org.freedesktop.ModemManager1.Modem.SMS D-Bus interface. This method + should only be used once and subsequent information retreived either + by listening for the Received and Completed signals, or by querying + the specific SMS object of interest. + + + + + + + Delete an SMS message. Alternatively you may use the Delete() method + on the message object itself. + + + + + + The object path of the SMS to delete. + + + + + + + Creates a new message object and optionally queues it for delivery. + + + + + + Message properties from the org.freedesktop.ModemManager1.Modem.SMS + D-Bus interface. The 'Number' and 'Text' properties are mandatory, + others are optional. If the SMSC is not specified and one is + required, the default SMSC is used. + + + + + If TRUE, queue the message for immediate delivery. + + + + + The object path of the new message object. + + + + + + + + + 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. The Completed signal will be emitted when the message is + complete. + + + + Object path of the new SMS. + + + + + TRUE if the message was received from the network, as opposed to being + added locally. + + + + + Message properties from the org.freedesktop.ModemManager1.Modem.SMS + D-Bus interface. Check the 'State' property to determine if the + message is complete. + + + + + + + Emitted when the complete-ness status of an SMS message changes. An SMS + may not necessarily be complete when the first part is received; this + signal will be emitted when all parts have been received, even for + single-part messages. + + + + Object path of the new SMS. + + + + + Message properties from the org.freedesktop.ModemManager1.Modem.SMS + D-Bus interface. + + + + + + + Emitted when a message has been deleted. + + + + Object path of the now deleted SMS. + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.SMS.xml b/new/org.freedesktop.ModemManager1.Modem.SMS.xml new file mode 100644 index 00000000..17f9ddac --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.SMS.xml @@ -0,0 +1,110 @@ + + + + + + + Defines operations and properties of a single SMS message. + + + + + + + Deletes the message. + + + + + + + + If the message has not yet been sent, queue it for delivery. + + + + + + + + + + Describes the state of the message. + + + + + + Indicates the number to which the message is addressed. + + + + + + Message text. When sending, if the text is larger than the limit of + the technology or modem, the message will be broken into multiple + parts or messages. + + + + + + Indicates the SMS service center number. Always empty for 3GPP2/CDMA. + + + + + + Specifies when the SMS expires in the SMSC. Always 0 for 3GPP2/CDMA. + + + + + + 3GPP message class (0..3). Always 0 for 3GPP2/CDMA. + + + + + + Time message was received or was sent in ISO8601 format. + + + + + + + + + State unknown or not reportable. + + + + + The message has been neither received nor yet sent. + + + + + The message is being received but is not yet complete. + + + + + The message received and is complete. + + + + + The message is queued for delivery. + + + + + The message was successfully sent. + + + + + +