Added in API level 30

ImsMmTelManager

open class ImsMmTelManager : RegistrationManager
kotlin.Any
   ↳ android.telephony.ims.ImsMmTelManager

A manager for the MmTel (Multimedia Telephony) feature of an IMS network, given an associated subscription. Allows a user to query the IMS MmTel feature information for a subscription, register for registration and MmTel capability status callbacks, as well as query/modify user settings for the associated subscription. Use android.telephony.ims.ImsManager#getImsMmTelManager(int) to get an instance of this manager.
Requires the PackageManager#FEATURE_TELEPHONY_IMS feature which can be detected using PackageManager.hasSystemFeature(String).

Summary

Nested classes
open

Receives IMS capability status updates from the ImsService.
Constants
static Int

Prefer registering for IMS over LTE if LTE signal quality is high enough.
static Int

Register for IMS over IWLAN if WiFi signal quality is high enough.
static Int

Prefer registering for IMS over IWLAN if possible if WiFi signal quality is high enough.
Inherited constants
Public methods
open Unit
getRegistrationTransportType(executor: Executor, transportTypeCallback: Consumer<Int!>)

Requires Permission: READ_PRECISE_PHONE_STATE or that the calling app has carrier privileges (see android.telephony.TelephonyManager#hasCarrierPrivileges).
open Int

Returns the user's voice over WiFi Roaming mode setting associated with the device.
open Boolean

Query the user’s setting for “Advanced Calling” or "Enhanced 4G LTE", which is used to enable MmTel IMS features, depending on the carrier configuration for the current subscription.
open Boolean

This configuration is meaningful only on dual sim device.
open Boolean


Requires android.
open Boolean

Returns the user's voice over WiFi roaming setting associated with the current subscription.
open Boolean


Requires android.
open Boolean

The user's setting for whether or not they have enabled the "Video Calling" setting.
open Unit

Requires Permission: READ_PRECISE_PHONE_STATE or that the calling app has carrier privileges (see android.telephony.TelephonyManager#hasCarrierPrivileges).
open Unit

Register a new callback, which is used to notify the registrant of changes to the state of the underlying IMS service that is attached to telephony to implement IMS functionality.
open Unit

Registers a CapabilityCallback with the system, which will provide MmTel service availability updates for the subscription specified in ImsManager#getImsMmTelManager(int).
open Unit

Requires Permission: READ_PRECISE_PHONE_STATE or that the calling app has carrier privileges (see android.telephony.TelephonyManager#hasCarrierPrivileges).
open Unit

Unregisters a previously registered callback.
open Unit

Removes an existing MmTel CapabilityCallback.

Constants

WIFI_MODE_CELLULAR_PREFERRED

Added in API level 30
static val WIFI_MODE_CELLULAR_PREFERRED: Int

Prefer registering for IMS over LTE if LTE signal quality is high enough.

Value: 1

WIFI_MODE_WIFI_ONLY

Added in API level 30
static val WIFI_MODE_WIFI_ONLY: Int

Register for IMS over IWLAN if WiFi signal quality is high enough. Do not hand over to LTE registration if signal quality degrades.

Value: 0

WIFI_MODE_WIFI_PREFERRED

Added in API level 30
static val WIFI_MODE_WIFI_PREFERRED: Int

Prefer registering for IMS over IWLAN if possible if WiFi signal quality is high enough.

Value: 2

Public methods

getRegistrationTransportType

Added in API level 30
open fun getRegistrationTransportType(
    executor: Executor, 
    transportTypeCallback: Consumer<Int!>
): Unit

Requires Permission: READ_PRECISE_PHONE_STATE or that the calling app has carrier privileges (see android.telephony.TelephonyManager#hasCarrierPrivileges). Access by profile owners is deprecated and will be removed in a future release. Gets the Transport Type associated with the current IMS registration.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Parameters
executor Executor: This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
transportTypeCallback Consumer<Int!>: This value cannot be null. Value is android.telephony.AccessNetworkConstants.TRANSPORT_TYPE_INVALID, android.telephony.AccessNetworkConstants#TRANSPORT_TYPE_WWAN, or android.telephony.AccessNetworkConstants#TRANSPORT_TYPE_WLAN

getVoWiFiModeSetting

Added in API level 30
open fun getVoWiFiModeSetting(): Int

Returns the user's voice over WiFi Roaming mode setting associated with the device.

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Return
Int The Voice over WiFi Mode preference set by the user, which can be one of the following: - WIFI_MODE_WIFI_ONLY - WIFI_MODE_CELLULAR_PREFERRED - WIFI_MODE_WIFI_PREFERRED Value is android.telephony.ims.ImsMmTelManager.WIFI_MODE_UNKNOWN, android.telephony.ims.ImsMmTelManager#WIFI_MODE_WIFI_ONLY, android.telephony.ims.ImsMmTelManager#WIFI_MODE_CELLULAR_PREFERRED, or android.telephony.ims.ImsMmTelManager#WIFI_MODE_WIFI_PREFERRED
Exceptions
java.lang.IllegalArgumentException if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid.
java.lang.UnsupportedOperationException If the device does not have PackageManager#FEATURE_TELEPHONY_IMS.

isAdvancedCallingSettingEnabled

Added in API level 30
open fun isAdvancedCallingSettingEnabled(): Boolean

Query the user’s setting for “Advanced Calling” or "Enhanced 4G LTE", which is used to enable MmTel IMS features, depending on the carrier configuration for the current subscription. If this setting is enabled, IMS voice and video telephony over IWLAN/LTE will be enabled as long as the carrier has provisioned these services for the specified subscription. Other IMS services (SMS/UT) are not affected by this user setting and depend on carrier requirements.

Note: If the carrier configuration for advanced calling is not editable or hidden, this method will always return the default value.

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Return
Boolean true if the user's setting for advanced calling is enabled, false otherwise.
Exceptions
java.lang.IllegalArgumentException if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid.
java.lang.UnsupportedOperationException If the device does not have PackageManager#FEATURE_TELEPHONY_IMS.

isCrossSimCallingEnabled

Added in API level 31
open fun isCrossSimCallingEnabled(): Boolean

This configuration is meaningful only on dual sim device. If enabled, this will result in the device setting up IMS of all other active subscriptions over the INTERNET APN of the primary default data subscription when any of those subscriptions are roaming or out of service and if wifi is not available for VoWifi. This feature will be disabled if CarrierConfigManager#KEY_CARRIER_CROSS_SIM_IMS_AVAILABLE_BOOL is set to false.

Following are the conditions in which system will try to register IMS over cross sim

  • Wifi is not available, one SIM is roaming and the default data SIM is in home network. Then roaming SIM IMS will be registered over INTERNET APN of the default data subscription
  • Wifi is not available, one SIM is out of service and the default data SIM is in home network. Then out of service SIM IMS will be registered over INTERNET APN of the default data subscription

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Return
Boolean true if the user's setting for Voice over Cross SIM is enabled and false if it is not
Exceptions
android.telephony.ims.ImsException if the IMS service associated with this subscription is not available or the IMS service is not available.
java.lang.UnsupportedOperationException If the device does not have PackageManager#FEATURE_TELEPHONY_IMS.

isTtyOverVolteEnabled

Added in API level 30
open fun isTtyOverVolteEnabled(): Boolean


Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Return
Boolean true if TTY over VoLTE is supported

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Exceptions
java.lang.IllegalArgumentException if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid.
java.lang.UnsupportedOperationException If the device does not have PackageManager#FEATURE_TELEPHONY_IMS.

isVoWiFiRoamingSettingEnabled

Added in API level 30
open fun isVoWiFiRoamingSettingEnabled(): Boolean

Returns the user's voice over WiFi roaming setting associated with the current subscription.

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Return
Boolean true if the user's setting for Voice over WiFi while roaming is enabled, false if disabled.
Exceptions
java.lang.IllegalArgumentException if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid.
java.lang.UnsupportedOperationException If the device does not have PackageManager#FEATURE_TELEPHONY_IMS.

isVoWiFiSettingEnabled

Added in API level 30
open fun isVoWiFiSettingEnabled(): Boolean


Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Return
Boolean true if the user's setting for Voice over WiFi is enabled and false if it is not.

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Exceptions
java.lang.IllegalArgumentException if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid.
java.lang.UnsupportedOperationException If the device does not have PackageManager#FEATURE_TELEPHONY_IMS.

isVtSettingEnabled

Added in API level 30
open fun isVtSettingEnabled(): Boolean

The user's setting for whether or not they have enabled the "Video Calling" setting.

Note: If the carrier configuration for advanced calling is not editable or hidden, this method will always return the default value.

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Return
Boolean true if the user’s “Video Calling” setting is currently enabled.
Exceptions
java.lang.IllegalArgumentException if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid.
java.lang.UnsupportedOperationException If the device does not have PackageManager#FEATURE_TELEPHONY_IMS.

registerImsRegistrationCallback

Added in API level 30
open fun registerImsRegistrationCallback(
    executor: Executor, 
    c: RegistrationManager.RegistrationCallback
): Unit

Requires Permission: READ_PRECISE_PHONE_STATE or that the calling app has carrier privileges (see android.telephony.TelephonyManager#hasCarrierPrivileges). Registers a RegistrationCallback with the system. Use
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Parameters
executor Executor: This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
c RegistrationManager.RegistrationCallback: This value cannot be null.
Exceptions
android.telephony.ims.ImsException if the subscription associated with this callback is valid, but the ImsService associated with the subscription is not available. This can happen if the service crashed, for example. See ImsException#getCode() for a more detailed reason.

registerImsStateCallback

Added in API level 33
open fun registerImsStateCallback(
    executor: Executor, 
    callback: ImsStateCallback
): Unit

Register a new callback, which is used to notify the registrant of changes to the state of the underlying IMS service that is attached to telephony to implement IMS functionality. If the manager is created for the SubscriptionManager#DEFAULT_SUBSCRIPTION_ID, this throws an ImsException.

Requires Permission: READ_PRECISE_PHONE_STATE or that the calling app has carrier privileges (see android.telephony.TelephonyManager#hasCarrierPrivileges).
Requires android.Manifest.permission#READ_PRECISE_PHONE_STATE or android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE

Parameters
executor Executor: the Executor that will be used to call the ImsStateCallback. This value cannot be null.
callback ImsStateCallback: The callback instance being registered. This value cannot be null.
Exceptions
android.telephony.ims.ImsException in the case that the callback can not be registered. See ImsException#getCode for more information on when this is called.

registerMmTelCapabilityCallback

Added in API level 30
open fun registerMmTelCapabilityCallback(
    executor: Executor, 
    c: ImsMmTelManager.CapabilityCallback
): Unit

Registers a CapabilityCallback with the system, which will provide MmTel service availability updates for the subscription specified in ImsManager#getImsMmTelManager(int). Use SubscriptionManager.OnSubscriptionsChangedListener to listen to subscription changed events and call unregisterMmTelCapabilityCallback(android.telephony.ims.ImsMmTelManager.CapabilityCallback) to clean up.

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release. When the callback is registered, it will initiate the callback c to be called with the current capabilities.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Parameters
executor Executor: The executor the callback events should be run on. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
c ImsMmTelManager.CapabilityCallback: The MmTel CapabilityCallback to be registered. This value cannot be null.
Exceptions
android.telephony.ims.ImsException if the subscription associated with this callback is valid, but the ImsService associated with the subscription is not available. This can happen if the service crashed, for example. See ImsException#getCode() for a more detailed reason.

unregisterImsRegistrationCallback

Added in API level 30
open fun unregisterImsRegistrationCallback(c: RegistrationManager.RegistrationCallback): Unit

Requires Permission: READ_PRECISE_PHONE_STATE or that the calling app has carrier privileges (see android.telephony.TelephonyManager#hasCarrierPrivileges). Access by profile owners is deprecated and will be removed in a future release. Removes an existing RegistrationCallback. When the subscription associated with this callback is removed (SIM removed, ESIM swap, etc...), this callback will automatically be removed. If this method is called for an inactive subscription, it will result in a no-op.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Parameters
c RegistrationManager.RegistrationCallback: This value cannot be null.

unregisterImsStateCallback

Added in API level 33
open fun unregisterImsStateCallback(callback: ImsStateCallback): Unit

Unregisters a previously registered callback.

Parameters
callback ImsStateCallback: The callback instance to be unregistered. This value cannot be null.

unregisterMmTelCapabilityCallback

Added in API level 30
open fun unregisterMmTelCapabilityCallback(c: ImsMmTelManager.CapabilityCallback): Unit

Removes an existing MmTel CapabilityCallback. When the subscription associated with this callback is removed (SIM removed, ESIM swap, etc...), this callback will automatically be removed. If this method is called for an inactive subscription, it will result in a no-op.

This API requires one of the following:

The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or android.Manifest.permission#READ_PRECISE_PHONE_STATE

Parameters
c ImsMmTelManager.CapabilityCallback: The MmTel CapabilityCallback to be removed. This value cannot be null.