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.InProgress
  14                                          [service].Error.NotImplemented
  15
  16                 array{object,dict} GetMessages()
  17
  18                         Get an array of message object paths and properties
  19                         that represents the currently pending messages.
  20
  21                         This method call should only be used once when an
  22                         application starts up.  Further message additions
  23                         and removal shall be monitored via MessageAdded and
  24                         MessageRemoved signals.
  25
  26                 void SetProperty(string name, variant value)
  27
  28                         Changes the value of the specified property. Only
  29                         properties that are listed as readwrite are
  30                         changeable. On success a PropertyChanged signal
  31                         will be emitted.
  32
  33                         Possible Errors: [service].Error.InProgress
  34                                          [service].Error.NotImplemented
  35                                          [service].Error.InvalidArguments
  36                                          [service].Error.InvalidFormat
  37                                          [service].Error.Failed
  38
  39                 object SendMessage(string to, string text)
  40
  41                         Send the message in text to the number in to.  If the
  42                         message could be queued successfully, this method
  43                         returns an object path to the created Message object.
  44
  45                         Possible Errors: [service].Error.InvalidArguments
  46                                          [service].Error.InvalidFormat
  47                                          [service].Error.Failed
  48
  49 Signals         PropertyChanged(string name, variant value)
  50
  51                         This signal indicates a changed value of the given
  52                         property.
  53
  54                 ImmediateMessage(string message, dict info)
  55
  56                         New immediate (class 0) SMS received. Info has Sender,
  57                         LocalSentTime, and SentTime information.  Sender
  58                         address is given in string format.  LocalSentTime and
  59                         SentTime are given in string form using ISO8601 format.
  60
  61                 IncomingMessage(string message, dict info)
  62
  63                         New incoming text SMS received. Info has Sender,
  64                         LocalSentTime, and SentTime information.
  65
  66                 MessageAdded(object path, dict properties)
  67
  68                         This signal is emitted whenever a new Message object
  69                         has been created.
  70
  71                 MessageRemoved(object path)
  72
  73                         This signal is emitted whenever a Message object
  74                         has been removed, e.g. when it reaches a final state.
  75
  76 Properties      string ServiceCenterAddress
  77
  78                         Contains the number of the SMS service center.
  79
  80                 boolean UseDeliveryReports
  81
  82                         This property controls whether SMS Status Reports,
  83                         sometimes better known as Delivery Reports are to be
  84                         used.  If enabled, all outgoing SMS messages will be
  85                         flagged to request a status report from the SMSC.
  86
  87                 string Bearer
  88
  89                         Contains the bearer to use for SMS messages.  Possible
  90                         values are:
  91                                 "cs-only" - Circuit Switched only
  92                                 "ps-only" - Packet Domain only
  93                                 "cs-preferred" - Use PS if CS is unavailable
  94                                 "ps-preferred" - Use CS if PS is unavailable
  95
  96                         By default oFono uses "cs-preferred" setting.
  97
  98                 string Alphabet
  99
 100                         Contains the alphabet setting for outgoing SMSs.
 101                         Possible values are:
 102
 103                                 "default" - Default GSM alphabet
 104                                 "turkish" - Turkish alphabet
 105                                 "spanish" - Spanish alphabet
 106                                 "portuguese" - Portuguese alphabet
 107
 108                         The standard, language-specific alphabets are defined
 109                         in 3GPP TS23.038, Annex A.  By default, oFono uses
 110                         the "default" setting.