doc/cdma-messagemanager-api.txt

   1 CDMA Message Manager hierarchy [experimental]
   2 ==============================
   3
   4 Service         org.ofono
   5 Interface       org.ofono.cdma.MessageManager
   6 Object path     [variable prefix]/{modem0,modem1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the manager object. See
  11                         the properties section for available properties.
  12
  13                         Possible Errors: [service].Error.InvalidArguments
  14
  15                 array{object,dict} GetMessages()
  16
  17                         Get an array of message object paths and properties
  18                         that represents the currently pending messages.
  19
  20                         This method call should only be used once when an
  21                         application starts up.  Further message additions
  22                         and removal shall be monitored via MessageAdded and
  23                         MessageRemoved signals.
  24
  25                 void SetProperty(string name, variant value)
  26
  27                         Changes the value of the specified property. Only
  28                         properties that are listed as readwrite are
  29                         changeable. On success a PropertyChanged signal
  30                         will be emitted.
  31
  32                         Possible Errors: [service].Error.InvalidArguments
  33                                          [service].Error.DoesNotExist
  34
  35                 object SendMessage(dict message_info)
  36
  37                         The dictionary can contain the following keys:
  38
  39                         string "To" - Address of the receiver
  40
  41                         string "Text" - The text to send
  42
  43                         string "Priority" - The value can be one of:
  44                                 "normal",
  45                                 "interactive",
  46                                 "urgent",
  47                                 "emergency",
  48
  49                         TODO: Figure out where this is really needed
  50
  51                         string "Privacy" - The value can be one of:
  52                                 "not restricted",
  53                                 "restricted",
  54                                 "confidential",
  55                                 "secret"
  56
  57                         TODO: Figure out where this is really needed
  58
  59                         If the message could be queued successfully, this
  60                         method returns an object path to the created Message
  61                         object.
  62
  63 Signals         PropertyChanged(string name, variant value)
  64
  65                         This signal indicates a changed value of the given
  66                         property.
  67
  68                 ImmediateMessage(string message, dict info)
  69
  70                         New immediate SMS received. Info has Sender,
  71                         LocalSentTime, SentTime, Priority, Privacy and
  72                         CallbackNumber information.  Sender address is given
  73                         in string format.  LocalSentTime and SentTime are
  74                         given in string form using ISO8601 format.
  75
  76                 IncomingMessage(string message, dict info)
  77
  78                         New incoming text SMS received. Info has Sender,
  79                         LocalSentTime, SentTime, Priority, Privacy, and
  80                         CallbackNumber.
  81
  82                 MessageAdded(object path, dict properties)
  83
  84                         This signal is emitted whenever a new Message object
  85                         has been created.
  86
  87                 MessageRemoved(object path)
  88
  89                         This signal is emitted whenever a Message object
  90                         has been removed, e.g. when it reaches a final state.
  91
  92 Properties      boolean UseDeliveryAcknowledgement
  93
  94                         Request to be notified when the SMSC has delivered
  95                         the message to the receiving user.  In effect this
  96                         is the same as the GSM Status Report.
  97
  98                 boolean UseUserAcknowledgement
  99
 100                         Request to be notified when the receiving user has
 101                         acknowledged the message.
 102
 103                 boolean UseReadAcknowledgement
 104
 105                         Request to be notified when the receiving User has
 106                         read the message.
 107
 108                 string CallbackNumber
 109
 110                         The call back number for the user.  If the number is
 111                         empty, then the optional field is not included
 112                         in the encoded PDU.