Call - Android SDK

Classes

Summary: Nested Classes | Constants | Methods | Inherited Methods | [Expand All]

Added in API level 23

public final class

Call

extends Object

java.lang.Object
↳	android.telecom.Call

Class Overview

Represents an ongoing phone call that the in-call app should present to the user.

Summary

Nested Classes
class	Call.Callback
class	Call.Details

Constants
String	AVAILABLE_PHONE_ACCOUNTS	The key to retrieve the optional `PhoneAccount`s Telecom can bundle with its Call extras.
int	STATE_ACTIVE	The state of a `Call` when actively supporting conversation.
int	STATE_CONNECTING	The initial state of an outgoing `Call`.
int	STATE_DIALING	The state of an outgoing `Call` when dialing the remote number, but not yet connected.
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`.
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`.
int	STATE_HOLDING	The state of a `Call` when in a holding state.
int	STATE_NEW	The state of a `Call` when newly created.
int	STATE_RINGING	The state of an incoming `Call` when ringing locally, but not yet connected.
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.

Public Methods
void	answer(int videoState) Instructs this `STATE_RINGING` `Call` to answer.
void	conference(Call callToConferenceWith) Instructs this `Call` to enter a conference.
void	disconnect() Instructs this `Call` to disconnect.
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.
List<Call>	getChildren() Obtains the children of this conference `Call`, if any.
List<Call>	getConferenceableCalls() Returns the list of `Call`s with which this `Call` is allowed to conference.
Call.Details	getDetails() Obtains an object containing call details.
Call	getParent() Obtains the parent of this `Call` in a conference, if any.
String	getRemainingPostDialSequence() Obtains the post-dial sequence remaining to be emitted by this `Call`, if any.
int	getState() Obtains the state of this `Call`.
InCallService.VideoCall	getVideoCall() Obtains an object that can be used to display video from this `Call`.
void	hold() Instructs this `Call` to go on hold.
void	mergeConference() Merges the calls within this conference.
void	phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) Notifies this `Call` that an account has been selected and to proceed with placing an outgoing call.
void	playDtmfTone(char digit) Instructs this `Call` to play a dual-tone multi-frequency signaling (DTMF) tone.
void	postDialContinue(boolean proceed) Instructs this `Call` to continue playing a post-dial DTMF string.
void	registerCallback(Call.Callback callback) Registers a callback to this `Call`.
void	registerCallback(Call.Callback callback, Handler handler) Registers a callback to this `Call`.
void	reject(boolean rejectWithMessage, String textMessage) Instructs this `STATE_RINGING` `Call` to reject.
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.
void	swapConference() Swaps the calls within this conference.
void	unhold() Instructs this `STATE_HOLDING` call to release from hold.
void	unregisterCallback(Call.Callback callback) Unregisters a callback from this `Call`.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Constants

public static final String AVAILABLE_PHONE_ACCOUNTS

Added in API level 23

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"

public static final int STATE_ACTIVE

Added in API level 23

The state of a Call when actively supporting conversation.

Constant Value: 4 (0x00000004)

public static final int STATE_CONNECTING

Added in API level 23

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)

public static final int STATE_DIALING

Added in API level 23

The state of an outgoing Call when dialing the remote number, but not yet connected.

Constant Value: 1 (0x00000001)

public static final int STATE_DISCONNECTED

Added in API level 23

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)

public static final int STATE_DISCONNECTING

Added in API level 23

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)

public static final int STATE_HOLDING

Added in API level 23

The state of a Call when in a holding state.

Constant Value: 3 (0x00000003)

public static final int STATE_NEW

Added in API level 23

The state of a Call when newly created.

Constant Value: 0 (0x00000000)

public static final int STATE_RINGING

Added in API level 23

The state of an incoming Call when ringing locally, but not yet connected.

Constant Value: 2 (0x00000002)

public static final int STATE_SELECT_PHONE_ACCOUNT

Added in API level 23

The state of an outgoing Call when waiting on user to select a PhoneAccount through which to place the call.

Constant Value: 8 (0x00000008)

callback	A `Callback`.
handler	A handler which command and status changes will be delivered to.

rejectWithMessage	Whether to reject with a text message.
textMessage	An optional text message with which to respond.

Results

Classes

Call

Class Overview

Summary

Constants

public static final String AVAILABLE_PHONE_ACCOUNTS

public static final int STATE_ACTIVE

public static final int STATE_CONNECTING

public static final int STATE_DIALING

public static final int STATE_DISCONNECTED

public static final int STATE_DISCONNECTING

public static final int STATE_HOLDING

public static final int STATE_NEW

public static final int STATE_RINGING

public static final int STATE_SELECT_PHONE_ACCOUNT

Public Methods

public void answer (int videoState)

Parameters

public void conference (Call callToConferenceWith)

Parameters

public void disconnect ()

public List<String> getCannedTextResponses ()

Returns

See Also

public List<Call> getChildren ()

Returns

public List<Call> getConferenceableCalls ()

Returns

public Call.Details getDetails ()

Returns

public Call getParent ()

Returns

public String getRemainingPostDialSequence ()

Returns

public int getState ()

Returns

public InCallService.VideoCall getVideoCall ()

Returns

public void hold ()

public void mergeConference ()

public void phoneAccountSelected (PhoneAccountHandle accountHandle, boolean setDefault)

public void playDtmfTone (char digit)

Parameters

public void postDialContinue (boolean proceed)

Parameters

public void registerCallback (Call.Callback callback)

Parameters

public void registerCallback (Call.Callback callback, Handler handler)

Parameters

public void reject (boolean rejectWithMessage, String textMessage)

Parameters

public void splitFromConference ()

public void stopDtmfTone ()

public void swapConference ()

public void unhold ()

public void unregisterCallback (Call.Callback callback)

Parameters