Call

AVAILABLE_PHONE_ACCOUNTS

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"

STATE_ACTIVE

int STATE_ACTIVE

The state of a Call when actively supporting conversation.

Constant Value: 4 (0x00000004)

STATE_CONNECTING

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)

STATE_DIALING

int STATE_DIALING

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

Constant Value: 1 (0x00000001)

STATE_DISCONNECTED

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)

STATE_DISCONNECTING

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)

STATE_HOLDING

int STATE_HOLDING

The state of a Call when in a holding state.

Constant Value: 3 (0x00000003)

STATE_NEW

int STATE_NEW

The state of a Call when newly created.

Constant Value: 0 (0x00000000)

STATE_PULLING_CALL

int STATE_PULLING_CALL

The state of an external call which is in the process of being pulled from a remote device to the local device.

A call can only be in this state if the PROPERTY_IS_EXTERNAL_CALL property and CAPABILITY_CAN_PULL_CALL capability are set on the call.

An InCallService will only see this state if it has the METADATA_INCLUDE_EXTERNAL_CALLS metadata set to true in its manifest.

Constant Value: 11 (0x0000000b)

STATE_RINGING

int STATE_RINGING

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

Constant Value: 2 (0x00000002)

STATE_SELECT_PHONE_ACCOUNT

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)

answer

void answer (int videoState)

Instructs this STATE_RINGING Call to answer.

conference

void conference (Call callToConferenceWith)

Instructs this Call to enter a conference.

disconnect

void disconnect ()

Instructs this Call to disconnect.

getCannedTextResponses

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.

getChildren

List<Call> getChildren ()

Obtains the children of this conference Call, if any.

getConferenceableCalls

List<Call> getConferenceableCalls ()

Returns the list of Calls with which this Call is allowed to conference.

getDetails

Call.Details getDetails ()

Obtains an object containing call details.

getParent

Call getParent ()

Obtains the parent of this Call in a conference, if any.

getRemainingPostDialSequence

String getRemainingPostDialSequence ()

Obtains the post-dial sequence remaining to be emitted by this Call, if any.

getState

int getState ()

Obtains the state of this Call.

getVideoCall

InCallService.VideoCall getVideoCall ()

Obtains an object that can be used to display video from this Call.

hold

void hold ()

Instructs this Call to go on hold.

mergeConference

void mergeConference ()

Merges the calls within this conference. See CAPABILITY_MERGE_CONFERENCE.

phoneAccountSelected

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.

playDtmfTone

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.

postDialContinue

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.

pullExternalCall

void pullExternalCall ()

Initiates a request to the ConnectionService to pull an external call to the local device.

Calls to this method are ignored if the call does not have the PROPERTY_IS_EXTERNAL_CALL property set.

An InCallService will only see calls which support this method if it has the METADATA_INCLUDE_EXTERNAL_CALLS metadata set to true in its manifest.

putExtras

void putExtras (Bundle extras)

Adds some extras to this Call. Existing keys are replaced and new ones are added.

No assumptions should be made as to how an In-Call UI or service will handle these extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.

registerCallback

void registerCallback (Call.Callback callback)

Registers a callback to this Call.

registerCallback

void registerCallback (Call.Callback callback, 
                Handler handler)

Registers a callback to this Call.

reject

void reject (boolean rejectWithMessage, 
                String textMessage)

Instructs this STATE_RINGING Call to reject.

removeExtras

void removeExtras (List<String> keys)

Removes extras from this Call.

removeExtras

void removeExtras (String... keys)

Removes extras from this Call.

sendCallEvent

void sendCallEvent (String event, 
                Bundle extras)

Sends a Call event from this Call to the associated Connection in the ConnectionService.

Call events are used to communicate point in time information from an InCallService to a ConnectionService. A ConnectionService implementation could define events which enable the InCallService, for example, toggle a unique feature of the ConnectionService.

A ConnectionService can communicate to the InCallService using sendConnectionEvent(String, Bundle).

Events are exposed to ConnectionService implementations via onCallEvent(String, Bundle).

No assumptions should be made as to how a ConnectionService will handle these events. The InCallService must assume that the ConnectionService could chose to ignore some events altogether.

Events should be fully qualified (e.g., com.example.event.MY_EVENT) to avoid conflicts between InCallService implementations. Further, InCallService implementations shall not re-purpose events in the android.* namespace, nor shall they define their own event types in this namespace. When defining a custom event type, ensure the contents of the extras Bundle is clearly defined. Extra keys for this bundle should be named similar to the event type (e.g. com.example.extra.MY_EXTRA).

When defining events and the associated extras, it is important to keep their behavior consistent when the associated InCallService is updated. Support for deprecated events/extras should me maintained to ensure backwards compatibility with older ConnectionService implementations which were built to support the older behavior.

splitFromConference

void splitFromConference ()

Instructs this Call to split from any conference call with which it may be connected.

stopDtmfTone

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.

swapConference

void swapConference ()

Swaps the calls within this conference. See CAPABILITY_SWAP_CONFERENCE.

toString

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())
 

unhold

void unhold ()

Instructs this STATE_HOLDING call to release from hold.

unregisterCallback

void unregisterCallback (Call.Callback callback)

Unregisters a callback from this Call.