doc/cell-broadcast-api.txt

   1 Cell broadcast hierarchy
   2 ========================
   3
   4 Service         org.ofono
   5 Interface       org.ofono.CellBroadcast
   6 Object path     [variable prefix]/{modem0,modem1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the cell broadcast object. See
  11                         the properties section for available properties.
  12
  13                 void SetProperty(string property, variant value)
  14
  15                         Changes the value of the specified property. Only
  16                         properties that are listed as readwrite are
  17                         changeable. On success a PropertyChanged signal
  18                         will be emitted.
  19
  20                         Possible Errors: [service].Error.InProgress
  21                                          [service].Error.InvalidArguments
  22                                          [service].Error.Failed
  23
  24 Signals         PropertyChanged(string name, variant value)
  25
  26                         This signal indicates a changed value of the given
  27                         property.
  28
  29                 IncomingBroadcast(string text, uint16 topic)
  30
  31                         This signal is emitted whenever a new cell broadcast
  32                         is received.  The string text contains contents of the
  33                         broadcast and topic contains the channel this
  34                         broadcast was received on.
  35
  36                         Please note that base station name broadcasts are
  37                         handled by the NetworkRegistration interface.
  38
  39                 EmergencyBroadcast(string text, dict properties)
  40
  41                         This signal is emitted whenever an ETWS cell broadcast
  42                         is received.  The string text contains contents of the
  43                         broadcast.  The dict is made up of the following
  44                         entries:
  45                                 EmergencyType - string value, possible values
  46                                                 include: "Earthquake",
  47                                                         "Tsunami",
  48                                                         "Earthquake+Tsunami",
  49                                                         "Other"
  50                                 EmergencyAlert - boolean value hinting whether
  51                                                 an extra emergency indicator
  52                                                 should be activated (e.g.
  53                                                 vibrate mode, emergency alert
  54                                                 mode.)
  55
  56                                 Popup - boolean value hinting whether the UI
  57                                         should popup a message box with the
  58                                         emergency information.
  59
  60 Properties      boolean Powered [readwrite]
  61
  62                         Boolean representing the power state of the cell
  63                         broadcast service.  If powered is False, then no
  64                         Cell Broadcast information is received.
  65
  66                 string Topics [readwrite]
  67
  68                         Returns a list of topics currently subscribed to by
  69                         this modem.  If the list is empty, then only emergency
  70                         broadcasts will ever be received.