doc/call-settings-api.txt

   1 Call Settings hierarchy
   2 ===============
   3 Service         org.ofono
   4 Interface       org.ofono.CallSettings
   5 Object path     [variable prefix]/{modem0,modem1,...}
   6
   7 Methods         dict GetProperties()
   8
   9                         Contains the properties for this object.
  10
  11                         Possible Errors: [service].Error.InProgress
  12
  13                 void SetProperty(string property, variant value)
  14
  15                         Sets the given property value to that specified in
  16                         call parameter.
  17
  18                         Possible Errors: [service].Error.InProgress
  19                                          [service].Error.NotImplemented
  20                                          [service].Error.InvalidArguments
  21                                          [service].Error.InvalidFormat
  22                                          [service].Error.Failed
  23
  24 Signals         PropertyChanged(string property, variant value)
  25
  26                         Signal is emitted whenever a property has changed.
  27                         The new value is passed as the signal argument.
  28
  29 Properties      string CallingLinePresentation [readonly]
  30
  31                         Contains the value of the calling line identification
  32                         presentation property.  The value indicates
  33                         the state of the CLIP supplementary service in the
  34                         network.  If enabled, the network will provide
  35                         the number of the calling party for incoming calls.
  36                         Possible values are:
  37                                 "disabled",
  38                                 "enabled",
  39                                 "unknown"
  40
  41                 string CalledLinePresentation [readonly]
  42
  43                         Contains the value of the called line identification
  44                         presentation property.  The value indicates the state
  45                         of the CDIP supplementary service in the network.  If
  46                         enabled, when receiving a call the network will provide
  47                         the subscriber's line dialed.  This is useful for
  48                         subscribers which have a multiple line service with
  49                         their network provider and would like to know what
  50                         line the call is coming in on.
  51
  52                         Possible values are:
  53                                 "disabled",
  54                                 "enabled",
  55                                 "unknown"
  56
  57                 string CallingNamePresentation [readonly]
  58
  59                         Contains the value of the calling name identification
  60                         presentation property.  The value indicates
  61                         the state of the CNAP supplementary service in the
  62                         network.  If enabled, the network will provide
  63                         the name of the calling party for incoming calls.
  64                         Possible values are:
  65                                 "disabled",
  66                                 "enabled",
  67                                 "unknown"
  68
  69                 string ConnectedLinePresentation [readonly]
  70
  71                         Contains the value of the connected line identification
  72                         presentation property.  The value indicates the state
  73                         of the COLP supplementary service in the network.  If
  74                         enabled, the network will attempt to provide the number
  75                         of the connected party for outgoing calls.  Possible
  76                         values are:
  77                                 "disabled",
  78                                 "enabled",
  79                                 "unknown"
  80
  81                 string ConnectedLineRestriction [readonly]
  82
  83                         Contains the value of the connected line identification
  84                         restriction property. The value indicates the state of
  85                         the COLR supplementary service in the network.  If
  86                         enabled, the network will withhold subscriber number
  87                         information from the calling party on incoming calls.
  88                         The possible values are:
  89                                 "disabled",
  90                                 "enabled",
  91                                 "unknown"
  92
  93                         Not all modems can report this information.
  94
  95                 string CallingLineRestriction [readonly]
  96
  97                         Contains the value of the calling line identification
  98                         restriction property.  The value indicates the state of
  99                         the CLIR supplementary service in the network.  If
 100                         enabled permanently or temporarily the restriction is
 101                         in effect, the subscriber number information will be
 102                         withheld from the called party on outgoing calls
 103                         unless the value is overriden using the HideCallerId
 104                         property or on a per call basis.
 105
 106                         The possible values are:
 107                                 "disabled"
 108                                 "permanent"
 109                                 "unknown",
 110                                 "on",
 111                                 "off"
 112
 113                 string HideCallerId [readwrite]
 114
 115                         Sets whether the ID of the caller will should be
 116                         provided or withheld for outgoing calls.  This setting
 117                         is also modified by the status of the CLIR supplementary
 118                         service in the network (see the CallingLineRestriction
 119                         property).  The three possible values are:
 120                                 "default" - Uses the network setting
 121                                 "enabled" - CLIR invoked, caller id is withheld
 122                                 "disabled" - CLIR suppressed, caller id is
 123                                                 provided
 124
 125                         This setting can also be changed on a per-call basis,
 126                         see the VoiceCallManager Dial method documentation.
 127
 128                 string VoiceCallWaiting [readwrite]
 129
 130                         Contains the call waiting status for Voice calls.
 131                         If enabled, the call waiting status will be
 132                         presented to the subscriber for voice calls.
 133                         Possible values are:
 134                                 "disabled",
 135                                 "enabled",