doc/smartmessaging-api.txt

   1 Smart Messaging hierarchy
   2 ===============
   3
   4 Service         org.ofono
   5 Interface       org.ofono.SmartMessaging
   6 Object path     [variable prefix]/{modem0,modem1,...}
   7
   8 Methods         object SendAppointment(string to, array{bytes} appointment)
   9
  10                         Sends a vCalendar object in appointment to the number
  11                         in to.  The object in appointment is not interpreted
  12                         by oFono in any way.  If the object is too large to
  13                         fit into a single SMS, it is fragmented as appropriate.
  14                         This method call returns the object path of the queued
  15                         SMS.
  16
  17                 object SendBusinessCard(string to, array{bytes} card)
  18
  19                         Sends a vCard object in card to the number in to. The
  20                         object in card is not interpreted by oFono in any way.
  21                         If the object is too large to fit into a single SMS,
  22                         it is fragmented as appropriate.  This method call
  23                         returns the object path of the queued SMS.
  24
  25                 void RegisterAgent(object path)
  26
  27                         Registers an agent which will be called whenever a
  28                         new Smart Messaging based SMS arrives.
  29
  30                 void UnregisterAgent(object path)
  31
  32                         Unregisters an agent.
  33
  34 SmartMessagingAgent Hierarchy [experimental]
  35 ===============
  36
  37 Service         unique name
  38 Interface       org.ofono.SmartMessagingAgent
  39 Object path     freely definable
  40
  41 Methods         void ReceiveAppointment(array{byte} appointment, dict info)
  42
  43                         Requests the agent to process a new SMS that has
  44                         arrived containing a vCalendar object.  The info
  45                         dictionary contains 'Sender', 'LocalSentTime' and
  46                         'SentTime' properties.
  47
  48                         Possible Errors: None
  49
  50                 void ReceiveBusinessCard(array{byte} card, dict info)
  51
  52                         Requests the agent to process a new SMS that has
  53                         arrived containing a vCard object.  The info
  54                         dictionary contains 'Sender', 'LocalSentTime' and
  55                         'SentTime' properties.
  56
  57                         Possible Errors: None
  58
  59                 void Release() [noreply]
  60
  61                         Agent is being released, possibly because of oFono
  62                         terminating, SMS interface is being torn down or modem
  63                         off.  No UnregisterAgent call is needed.