public
final
class
Call
extends Object
| java.lang.Object | |
| ↳ | android.telecom.Call |
Represents an ongoing phone call that the in-call app should present to the user.
Nested classes | |
|---|---|
class |
Call.Callback
|
class |
Call.Details
|
Constants | |
|---|---|
String |
AVAILABLE_PHONE_ACCOUNTS
The key to retrieve the optional |
int |
STATE_ACTIVE
The state of a |
int |
STATE_CONNECTING
The initial state of an outgoing |
int |
STATE_DIALING
The state of an outgoing |
int |
STATE_DISCONNECTED
The state of a |
int |
STATE_DISCONNECTING
The state of a |
int |
STATE_HOLDING
The state of a |
int |
STATE_NEW
The state of a |
int |
STATE_RINGING
The state of an incoming |
int |
STATE_SELECT_PHONE_ACCOUNT
The state of an outgoing |
Public methods | |
|---|---|
void
|
answer(int videoState)
Instructs this |
void
|
conference(Call callToConferenceWith)
Instructs this |
void
|
disconnect()
Instructs this |
List<String>
|
getCannedTextResponses()
Obtains a list of canned, pre-configured message responses to present to the user as
ways of rejecting this |
List<Call>
|
getChildren()
Obtains the children of this conference |
List<Call>
|
getConferenceableCalls()
Returns the list of |
Call.Details
|
getDetails()
Obtains an object containing call details. |
Call
|
getParent()
Obtains the parent of this |
String
|
getRemainingPostDialSequence()
Obtains the post-dial sequence remaining to be emitted by this |
int
|
getState()
Obtains the state of this |
InCallService.VideoCall
|
getVideoCall()
Obtains an object that can be used to display video from this |
void
|
hold()
Instructs this |
void
|
mergeConference()
Merges the calls within this conference. |
void
|
phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault)
Notifies this |
void
|
playDtmfTone(char digit)
Instructs this |
void
|
postDialContinue(boolean proceed)
Instructs this |
void
|
registerCallback(Call.Callback callback)
Registers a callback to this |
void
|
registerCallback(Call.Callback callback, Handler handler)
Registers a callback to this |
void
|
reject(boolean rejectWithMessage, String textMessage)
Instructs this |
void
|
splitFromConference()
Instructs this |
void
|
stopDtmfTone()
Instructs this |
void
|
swapConference()
Swaps the calls within this conference. |
String
|
toString()
Returns a string representation of the object. |
void
|
unhold()
Instructs this |
void
|
unregisterCallback(Call.Callback callback)
Unregisters a callback from this |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
String AVAILABLE_PHONE_ACCOUNTS
The key to retrieve the optional PhoneAccounts Telecom can bundle with its Call
extras. Used to pass the phone accounts to display on the front end to the user in order to
select phone accounts to (for example) place a call.
Constant Value: "selectPhoneAccountAccounts"
int STATE_ACTIVE
The state of a Call when actively supporting conversation.
Constant Value: 4 (0x00000004)
int STATE_CONNECTING
The initial state of an outgoing Call.
Common transitions are to STATE_DIALING state for a successful call or
STATE_DISCONNECTED if it failed.
Constant Value: 9 (0x00000009)
int STATE_DIALING
The state of an outgoing Call when dialing the remote number, but not yet connected.
Constant Value: 1 (0x00000001)
int STATE_DISCONNECTED
The state of a Call when no further voice or other communication is being
transmitted, the remote side has been or will inevitably be informed that the Call
is no longer active, and the local data transport has or inevitably will release resources
associated with this Call.
Constant Value: 7 (0x00000007)
int STATE_DISCONNECTING
The state of a Call when the user has initiated a disconnection of the call, but the
call has not yet been disconnected by the underlying ConnectionService. The next
state of the call is (potentially) STATE_DISCONNECTED.
Constant Value: 10 (0x0000000a)
int STATE_HOLDING
The state of a Call when in a holding state.
Constant Value: 3 (0x00000003)
int STATE_NEW
The state of a Call when newly created.
Constant Value: 0 (0x00000000)
int STATE_RINGING
The state of an incoming Call when ringing locally, but not yet connected.
Constant Value: 2 (0x00000002)
int STATE_SELECT_PHONE_ACCOUNT
The state of an outgoing Call when waiting on user to select a
PhoneAccount through which to place the call.
Constant Value: 8 (0x00000008)
void answer (int videoState)
Instructs this STATE_RINGING Call to answer.
| Parameters | |
|---|---|
videoState |
int:
The video state in which to answer the call.
|
void conference (Call callToConferenceWith)
Instructs this Call to enter a conference.
| Parameters | |
|---|---|
callToConferenceWith |
Call:
The other call with which to conference.
|
List<String> getCannedTextResponses ()
Obtains a list of canned, pre-configured message responses to present to the user as
ways of rejecting this Call using via a text message.
| Returns | |
|---|---|
List<String> |
A list of canned text message responses. |
See also:
List<Call> getChildren ()
Obtains the children of this conference Call, if any.
| Returns | |
|---|---|
List<Call> |
The children of this Call if this Call is a conference, or an empty
List otherwise.
|
List<Call> getConferenceableCalls ()
Returns the list of Calls with which this Call is allowed to conference.
| Returns | |
|---|---|
List<Call> |
The list of conferenceable Calls.
|
Call.Details getDetails ()
Obtains an object containing call details.
| Returns | |
|---|---|
Call.Details |
A Call.Details object. Depending on the state of the Call, the
result may be null.
|
Call getParent ()
Obtains the parent of this Call in a conference, if any.
| Returns | |
|---|---|
Call |
The parent Call, or null if this Call is not a
child of any conference Calls.
|
String getRemainingPostDialSequence ()
Obtains the post-dial sequence remaining to be emitted by this Call, if any.
| Returns | |
|---|---|
String |
The remaining post-dial sequence, or null if there is no post-dial sequence
remaining or this Call is not in a post-dial state.
|
int getState ()
Obtains the state of this Call.
| Returns | |
|---|---|
int |
A state value, chosen from the STATE_* constants.
|
InCallService.VideoCall getVideoCall ()
Obtains an object that can be used to display video from this Call.
| Returns | |
|---|---|
InCallService.VideoCall |
An Call.VideoCall.
|
void mergeConference ()
Merges the calls within this conference. See CAPABILITY_MERGE_CONFERENCE.
void phoneAccountSelected (PhoneAccountHandle accountHandle, boolean setDefault)
Notifies this Call that an account has been selected and to proceed with placing
an outgoing call. Optionally sets this account as the default account.
| Parameters | |
|---|---|
accountHandle |
PhoneAccountHandle
|
setDefault |
boolean
|
void playDtmfTone (char digit)
Instructs this Call to play a dual-tone multi-frequency signaling (DTMF) tone.
Any other currently playing DTMF tone in the specified call is immediately stopped.
| Parameters | |
|---|---|
digit |
char:
A character representing the DTMF digit for which to play the tone. This
value must be one of '0' through '9', '*' or '#'.
|
void postDialContinue (boolean proceed)
Instructs this Call to continue playing a post-dial DTMF string.
A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
If the DTMF string contains a DTMF_CHARACTER_PAUSE symbol, this
Call will temporarily pause playing the tones for a pre-defined period of time.
If the DTMF string contains a DTMF_CHARACTER_WAIT symbol, this
Call will pause playing the tones and notify callbacks via
onPostDialWait(Call, String). At this point, the in-call app
should display to the user an indication of this state and an affordance to continue
the postdial sequence. When the user decides to continue the postdial sequence, the in-call
app should invoke the postDialContinue(boolean) method.
| Parameters | |
|---|---|
proceed |
boolean:
Whether or not to continue with the post-dial sequence.
|
void registerCallback (Call.Callback callback)
Registers a callback to this Call.
| Parameters | |
|---|---|
callback |
Call.Callback:
A Callback.
|
void registerCallback (Call.Callback callback, Handler handler)
Registers a callback to this Call.
| Parameters | |
|---|---|
callback |
Call.Callback:
A Callback. |
handler |
Handler:
A handler which command and status changes will be delivered to.
|
Developers
void reject (boolean rejectWithMessage,
String textMessage)
Instructs this STATE_RINGING Call to reject.
| Parameters | |
|---|---|
rejectWithMessage |
boolean:
Whether to reject with a text message. |
textMessage |
String:
An optional text message with which to respond.
|
void splitFromConference ()
Instructs this Call to split from any conference call with which it may be
connected.
void stopDtmfTone ()
Instructs this Call to stop any dual-tone multi-frequency signaling (DTMF) tone
currently playing.
DTMF tones are played by calling playDtmfTone(char). If no DTMF tone is
currently playing, this method will do nothing.
void swapConference ()
Swaps the calls within this conference. See CAPABILITY_SWAP_CONFERENCE.
String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
void unregisterCallback (Call.Callback callback)
Unregisters a callback from this Call.
| Parameters | |
|---|---|
callback |
Call.Callback:
A Callback.
|