public enum CallAvailability

  1. Object
  2. Enum<CallAvailability>
  3. CallAvailability

ImplementsComparable<CallAvailability>

Whether the app may ring a call right now. Distinct from Calls.isSupported(), which asks whether the platform has the machinery at all: an app can be perfectly supported and still be unable to ring, because the user is on an emergency call or another app holds one.

Check this before reporting an incoming call so the far end can be told to stop trying, rather than discovering the refusal from a failed report.

The ordinals cross the SPI boundary, so existing constants must not be reordered.

Enum constants

AVAILABLEA call can be reported now.
EMERGENCY_CALL_IN_PROGRESSAn emergency call is in progress.
OTHER_APP_IN_CALLAnother application holds a call the system will not interrupt.
NOT_PERMITTEDThe user has switched this app’s calling off, or the required permission or role is missing.
UNSUPPORTEDThe platform has no system call integration at all.
NOT_CONFIGUREDCalls.configure has not run, so a report would be refused.
THIS_APP_IN_CALLThis application already holds a call the platform will not let it stack another on.

Methods

public static CallAvailability[] values()
public static CallAvailability valueOf(String name)

Inherited methods

Enum constant details

AVAILABLE

AVAILABLE
A call can be reported now.

EMERGENCY_CALL_IN_PROGRESS

EMERGENCY_CALL_IN_PROGRESS
An emergency call is in progress. Nothing else may ring.

OTHER_APP_IN_CALL

OTHER_APP_IN_CALL
Another application holds a call the system will not interrupt.

NOT_PERMITTED

NOT_PERMITTED
The user has switched this app’s calling off, or the required permission or role is missing.

UNSUPPORTED

UNSUPPORTED
The platform has no system call integration at all.

NOT_CONFIGURED

NOT_CONFIGURED

Calls.configure has not run, so a report would be refused.

Appended rather than inserted: the ordinals cross the SPI boundary.

Android registers a Telecom PhoneAccount from the configuration and ignores calls from an account it does not know, so a report made before configuring is refused whatever the permissions say. This exists because answering AVAILABLE and then refusing the very next report is precisely what the check above is documented to prevent.

THIS_APP_IN_CALL

THIS_APP_IN_CALL

This application already holds a call the platform will not let it stack another on.

Appended rather than inserted: the ordinals cross the SPI boundary.

iOS only, and not an oversight elsewhere. The provider is configured for one call group of one call, so CallKit refuses a second report while this app owns a live call – and answering AVAILABLE there would be the same broken promise as answering it before configure(). Android Telecom accepts a second self-managed call from the same account, so its bridge deliberately does NOT report this; see the note in AndroidCallBridge about isInCall() being true for our own call too.

Method details

values

public static CallAvailability[] values()

valueOf

public static CallAvailability valueOf(String name)