doc/voicecall-api.txt

   1 VoiceCall hierarchy
   2 ===================
   3
   4 Service         org.ofono
   5 Interface       org.ofono.VoiceCall
   6 Object path     [variable prefix]/{modem0,modem1,...}/{voicecall01,voicecall02,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns all properties for this object. See the
  11                         properties section for available properties.
  12
  13                 void Deflect(string number)
  14
  15                         Deflects the incoming or waiting call to number given
  16                         in the argument.  This method is only valid if the
  17                         call is in "incoming" or "waiting" state and the
  18                         Call Deflection supplementary service is subscribed to.
  19
  20                         This functionality is generally implemented by using
  21                         the +CHLD=4 * NUMBER command.
  22
  23                         This method should not be confused with the Transfer()
  24                         method.
  25
  26                         Possible Errors: [service].Error.InProgress
  27                                          [service].Error.NotImplemented
  28                                          [service].Error.InvalidArguments
  29                                          [service].Error.InvalidFormat
  30                                          [service].Error.Failed
  31
  32                 void Hangup()
  33
  34                         Hangs up the voice call.
  35
  36                         For an incoming call, the call is hung up using ATH or
  37                         equivalent.  For a waiting call, the remote party is
  38                         notified by using the User Determined User Busy (UDUB)
  39                         condition.  This is generally implemented using CHLD=0.
  40
  41                         Please note that the GSM specification does not allow
  42                         the release of a held call when a waiting call exists,
  43                         or the release of a particular party in a held
  44                         multiparty call.
  45
  46                         Note that releasing a held call or a particular party
  47                         of a held multiparty call might not be possible on some
  48                         implementations.
  49
  50                         Possible Errors: [service].Error.InProgress
  51                                          [service].Error.Failed
  52                                          [service].Error.NotImplemented
  53
  54                 void Answer()
  55
  56                         Answers the incoming call.  Only valid if the state
  57                         of the call is "incoming."
  58
  59                         This functionality is generally implemented by ATA
  60                         AT command.
  61
  62                         Possible Errors: [service].Error.InProgress
  63                                          [service].Error.Failed
  64                                          [service].Error.NotImplemented
  65                                          [service].Error.Failed
  66
  67 Signals         PropertyChanged(string property, variant value)
  68
  69                         Signal is emitted whenever a property has changed.
  70                         The new value is passed as the signal argument.
  71
  72                 DisconnectReason(string reason)
  73
  74                         This signal is emitted when the modem manager can
  75                         provide extra information about why this call was
  76                         released. The possible reason values are:
  77                                 "local" - The call was release due to local
  78                                                 user action
  79                                 "remote" - Remote party released the call
  80                                 "network" - Network released the call, most
  81                                                 likely due to low signal or
  82                                                 other network failure
  83
  84                         Not all implementations are able to provide this
  85                         information, so applications should treat the emission
  86                         of this signal as optional. This signal will be
  87                         emitted before the PropertyChanged signal.
  88
  89 Properties      string LineIdentification [readonly]
  90
  91                         Contains the Line Identification information returned
  92                         by the network, if present. For incoming calls this is
  93                         effectively the CLIP. For outgoing calls this attribute
  94                         will hold the dialed number, or the COLP if received by
  95                         the underlying implementation.
  96
  97                         Please note that COLP may be different from the
  98                         dialed number. A special "withheld" value means the
  99                         remote party refused to provide caller ID and the
 100                         "override category" option was not provisioned for
 101                         the current subscriber.
 102
 103                 string IncomingLine [readonly, optional]
 104
 105                         Contains the Called Line Identification information
 106                         returned by the network. This is only available for
 107                         incoming calls and indicates the local subscriber
 108                         number which was dialed by the remote party. This is
 109                         useful for subscribers which have a multiple line
 110                         service with their network provider and would like
 111                         to know what line the call is coming in on.
 112
 113                 string Name [readonly]
 114
 115                         Contains the Name Identification information returned
 116                         by the network, if present.
 117
 118                 boolean Multiparty [readonly]
 119
 120                         Contains the indication if the voice call is part
 121                         of a multiparty call or not.
 122
 123                         Notifications if a call becomes part or leaves a
 124                         multipart call are sent.
 125
 126                 string State [readonly]
 127
 128                         Contains the state of the current call.  The state
 129                         can be one of:
 130                                 - "active" - The call is active
 131                                 - "held" - The call is on hold
 132                                 - "dialing" - The call is being dialed
 133                                 - "alerting" - The remote party is being alerted
 134                                 - "incoming" - Incoming call in progress
 135                                 - "waiting" - Call is waiting
 136                                 - "disconnected" - No further use of this object
 137                                         is allowed, it will be destroyed shortly
 138
 139                 string StartTime [readonly, optional]
 140
 141                         Contains the starting time of the call.  The time is
 142                         stamped when the call enters the "active" state.
 143                         Client applications can use this to infer somewhat
 144                         reliable call duration information.
 145
 146                 string Information [readonly, optional]
 147
 148                         Contains information related to the call for the
 149                         user.  Currently this property is set for calls
 150                         initiated by SIM Toolkit applications.
 151
 152                 byte Icon [readonly, optional]
 153
 154                         Icon identifier to be used instead of or together
 155                         with the text information.
 156
 157                 boolean Emergency [readonly]
 158
 159                         Contains the indication if the voice call is an
 160                         emergency call or not.
 161
 162                 boolean RemoteHeld [experimental]
 163
 164                         Contains the indication whether the voice call is put
 165                         on hold by the remote party or not.
 166
 167                 boolean RemoteMultiparty [experimental]
 168
 169                         Contains the indication whether the voice call is
 170                         joined in a multiparty call by the remote party or not.