doc/messagemanager-api.txt

   1 Message Manager hierarchy
   2 ===============
   3
   4 Service         org.ofono
   5 Interface       org.ofono.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(string to, string text)
  36
  37                         Send the message in text to the number in to.  If the
  38                         message could be queued successfully, this method
  39                         returns an object path to the created Message object.
  40
  41 Signals         PropertyChanged(string name, variant value)
  42
  43                         This signal indicates a changed value of the given
  44                         property.
  45
  46                 ImmediateMessage(string message, dict info)
  47
  48                         New immediate (class 0) SMS received. Info has Sender,
  49                         LocalSentTime, and SentTime information.  Sender
  50                         address is given in string format.  LocalSentTime and
  51                         SentTime are given in string form using ISO8601 format.
  52
  53                 IncomingMessage(string message, dict info)
  54
  55                         New incoming text SMS received. Info has Sender,
  56                         LocalSentTime, and SentTime information.
  57
  58                 MessageAdded(object path, dict properties)
  59
  60                         This signal is emitted whenever a new Message object
  61                         has been created.
  62
  63                 MessageRemoved(object path)
  64
  65                         This signal is emitted whenever a Message object
  66                         has been removed, e.g. when it reaches a final state.
  67
  68 Properties      string ServiceCenterAddress
  69
  70                         Contains the number of the SMS service center.
  71
  72                 boolean UseDeliveryReports
  73
  74                         This property controls whether SMS Status Reports,
  75                         sometimes better known as Delivery Reports are to be
  76                         used.  If enabled, all outgoing SMS messages will be
  77                         flagged to request a status report from the SMSC.
  78
  79                 string Bearer
  80
  81                         Contains the bearer to use for SMS messages.  Possible
  82                         values are:
  83                                 "cs-only" - Circuit Switched only
  84                                 "ps-only" - Packet Domain only
  85                                 "cs-preferred" - Use PS if CS is unavailable
  86                                 "ps-preferred" - Use CS if PS is unavailable
  87
  88                         By default oFono uses "cs-preferred" setting.
  89
  90                 string Alphabet
  91
  92                         Contains the alphabet setting for outgoing SMSs.
  93                         Possible values are:
  94
  95                                 "default" - Default GSM alphabet
  96                                 "turkish" - Turkish alphabet
  97                                 "spanish" - Spanish alphabet
  98                                 "portuguese" - Portuguese alphabet
  99
 100                         The standard, language-specific alphabets are defined
 101                         in 3GPP TS23.038, Annex A.  By default, oFono uses
 102                         the "default" setting.