doc/cdma-voicecall-manager-api.txt

   1 CDMA VoiceCallManager hierarchy [experimental]
   2 ===============================
   3
   4 Service         org.ofono
   5 Interface       org.ofono.cdma.VoiceCallManager
   6 Object path     [variable prefix]/{modem0,modem1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the VoiceCallManager Interface.
  11                         See the properties section for available properties.
  12
  13                 void Dial(string number)
  14
  15                         Initiates a new outgoing call.  This is usually
  16                         implemented using the ATD AT command.
  17
  18                         Possible Errors: [service].Error.InProgress
  19                                          [service].Error.InvalidArguments
  20                                          [service].Error.InvalidFormat
  21                                          [service].Error.NotImplemented
  22                                          [service].Error.Failed
  23
  24                 void Hangup()
  25
  26                         Hangup all active calls.
  27
  28                         Possible Errors: [service].Error.InProgress
  29                                          [service].Error.NotImplemented
  30                                          [service].Error.Failed
  31
  32                 void Answer()
  33
  34                         Answer the incoming call.  This only affects the
  35                         incoming call.
  36
  37                 void SendFlash(string flash_string)
  38
  39                         Sends the flash string to the network.
  40
  41                 void SendTones(string tones)
  42
  43                         Sends the DTMF tones to the network.  The tones have
  44                         a fixed duration.  Tones can be one of: '0' - '9',
  45                         '*', '#', 'A', 'B', 'C', 'D'.  The last four are
  46                         typically not used in normal circumstances.
  47
  48                 void SetProperty(string property, variant value)
  49
  50                         Changes the value of the specified property. Only
  51                         properties that are listed as readwrite are
  52                         changeable. On success a PropertyChanged signal
  53                         will be emitted.
  54
  55                         Possible Errors: [service].Error.InvalidArguments
  56                                          [service].Error.DoesNotExist
  57
  58 Signals         PropertyChanged(string property, variant value)
  59
  60                         Signal is emitted whenever a property has changed.
  61                         The new value is passed as the signal argument.
  62
  63                 DisconnectReason(string reason)
  64
  65                         This signal is emitted when the modem manager can
  66                         provide extra information about why the call was
  67                         released. The possible reason values are:
  68                                 "local" - The call was release due to local
  69                                                 user action
  70                                 "remote" - Remote party released the call
  71                                 "network" - Network released the call, most
  72                                                 likely due to low signal or
  73                                                 other network failure
  74
  75                         Not all implementations are able to provide this
  76                         information, so applications should treat the emission
  77                         of this signal as optional. This signal will be
  78                         emitted before the PropertyChanged signal.
  79
  80 Properties      string State [readonly]
  81
  82                         Contains the state of the current call.  The state
  83                         can be one of:
  84                                 - "active" - The call is active
  85                                 - "dialing" - The call is being dialed
  86                                 - "alerting" - The remote party is being alerted
  87                                 - "incoming" - Incoming call in progress
  88                                 - "disconnected" - No call is connected
  89
  90                 boolean CallWaiting [readonly]
  91
  92                         Contains whether a call is waiting.
  93
  94                 string CallWaitingNumber [readonly, optional]
  95
  96                         Contains the call waiting number.
  97
  98                 string ToneDuration [readwrite]
  99
 100                         Contains the length of the DTMF tone duration.  The
 101                         currently supported values are:
 102                                 "short",
 103                                 "long"
 104
 105                 string LineIdentification [readonly]
 106
 107                         Contains the Line Identification information returned
 108                         by the network, if present. For incoming calls this is
 109                         effectively the CLIP. For outgoing calls this attribute
 110                         will hold the dialed number.
 111
 112                         Please note that after sending flash this property
 113                         will be empty.
 114
 115                 string StartTime [readonly, optional]
 116
 117                         Contains the starting time of the call.  The time is
 118                         stamped when the call enters the "active" state.
 119                         Client applications can use this to infer somewhat
 120                         reliable call duration information.
 121
 122                         Please note that after sending Flash, there will not be
 123                         any StartTime property change for the Flash
 124                         string/number.