Stay organized with collections
Save and categorize content based on your preferences.
RcsUceAdapter
open class RcsUceAdapter
Manages RCS User Capability Exchange for the subscription specified.
Requires the PackageManager#FEATURE_TELEPHONY_IMS feature which can be detected using PackageManager.hasSystemFeature(String).
Summary
| Public methods |
| open Boolean |
The setting for whether or not the user has opted in to the automatic refresh of the RCS capabilities associated with the contacts in the user's contact address book.
|
Public methods
isUceSettingEnabled
open fun isUceSettingEnabled(): Boolean
The setting for whether or not the user has opted in to the automatic refresh of the RCS capabilities associated with the contacts in the user's contact address book. By default, this setting is disabled and must be enabled after the user has seen the opt-in dialog shown by ImsRcsManager.ACTION_SHOW_CAPABILITY_DISCOVERY_OPT_IN.
If this feature is enabled, the device will periodically share the phone numbers of all of the contacts in the user's address book with the carrier to refresh the RCS capabilities cache associated with those contacts as the local cache becomes stale.
This setting will only enable this feature if android.telephony.CarrierConfigManager.Ims#KEY_RCS_BULK_CAPABILITY_EXCHANGE_BOOL is also enabled.
Note: This setting does not affect whether or not the device publishes its service capabilities if the subscription supports presence publication.
Requires android.Manifest.permission#READ_PHONE_STATE
| Return |
Boolean |
true if the user has opted in for automatic refresh of the RCS capabilities of their contacts, false otherwise. |
| Exceptions |
android.telephony.ims.ImsException |
if the subscription associated with this instance of RcsUceAdapter is valid, but the ImsService associated with the subscription is not available. This can happen if the ImsService has crashed, for example, or if the subscription becomes inactive. See ImsException.getCode() for more information on the error codes. |
java.lang.UnsupportedOperationException |
If the device does not have PackageManager.FEATURE_TELEPHONY_IMS. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# RcsUceAdapter\n\nAdded in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nRcsUceAdapter\n=============\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/telephony/ims/RcsUceAdapter \"View this page in Java\") \n\n```\nopen class RcsUceAdapter\n```\n\n|---|------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.telephony.ims.RcsUceAdapter](#) |\n\nManages RCS User Capability Exchange for the subscription specified. \nRequires the [PackageManager#FEATURE_TELEPHONY_IMS](../../content/pm/PackageManager.html#FEATURE_TELEPHONY_IMS:kotlin.String) feature which can be detected using [PackageManager.hasSystemFeature(String)](../../content/pm/PackageManager.html#hasSystemFeature(kotlin.String)).\n\nSummary\n-------\n\n| Public methods ||\n|-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isUceSettingEnabled](#isUceSettingEnabled())`()` The setting for whether or not the user has opted in to the automatic refresh of the RCS capabilities associated with the contacts in the user's contact address book. |\n\nPublic methods\n--------------\n\n### isUceSettingEnabled\n\nAdded in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun isUceSettingEnabled(): Boolean\n```\n\nThe setting for whether or not the user has opted in to the automatic refresh of the RCS capabilities associated with the contacts in the user's contact address book. By default, this setting is disabled and must be enabled after the user has seen the opt-in dialog shown by [ImsRcsManager.ACTION_SHOW_CAPABILITY_DISCOVERY_OPT_IN](/reference/kotlin/android/telephony/ims/ImsRcsManager#ACTION_SHOW_CAPABILITY_DISCOVERY_OPT_IN:kotlin.String).\n\nIf this feature is enabled, the device will periodically share the phone numbers of all of the contacts in the user's address book with the carrier to refresh the RCS capabilities cache associated with those contacts as the local cache becomes stale.\n\nThis setting will only enable this feature if [android.telephony.CarrierConfigManager.Ims#KEY_RCS_BULK_CAPABILITY_EXCHANGE_BOOL](../CarrierConfigManager.Ims.html#KEY_RCS_BULK_CAPABILITY_EXCHANGE_BOOL:kotlin.String) is also enabled.\n\nNote: This setting does not affect whether or not the device publishes its service capabilities if the subscription supports presence publication. \nRequires [android.Manifest.permission#READ_PHONE_STATE](../../Manifest.permission.html#READ_PHONE_STATE:kotlin.String)\n\n| Return ||\n|------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | true if the user has opted in for automatic refresh of the RCS capabilities of their contacts, false otherwise. |\n\n| Exceptions ||\n|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `android.telephony.ims.ImsException` | if the subscription associated with this instance of [RcsUceAdapter](#) is valid, but the ImsService associated with the subscription is not available. This can happen if the ImsService has crashed, for example, or if the subscription becomes inactive. See [ImsException.getCode()](/reference/kotlin/android/telephony/ims/ImsException#getCode()) for more information on the error codes. |\n| `java.lang.UnsupportedOperationException` | If the device does not have [PackageManager.FEATURE_TELEPHONY_IMS](../../content/pm/PackageManager.html#FEATURE_TELEPHONY_IMS:kotlin.String). |"]]
