Stay organized with collections
Save and categorize content based on your preferences.
ImsServiceEntitlement
class ImsServiceEntitlement
Configs used by ImsServiceEntitlement.
Summary
| Constants |
| static String |
The address of the entitlement configuration server.
|
| static String |
The FCM sender ID for the carrier.
|
| static String |
For some carriers, the network is not provisioned by default to support IMS (VoLTE/VoWiFi/SMSoIP) service for all end users.
|
| static String |
Prefix of all ImsServiceEntitlement.
|
| static String |
For some carriers, end-users may be presented with a web portal of the carrier before being allowed to use the VoWiFi service.
|
Constants
KEY_ENTITLEMENT_SERVER_URL_STRING
static val KEY_ENTITLEMENT_SERVER_URL_STRING: String
The address of the entitlement configuration server. Reference: GSMA TS.43-v5, section 2.1 Default Entitlement Configuration Server.
Value: "imsserviceentitlement.entitlement_server_url_string"
KEY_FCM_SENDER_ID_STRING
static val KEY_FCM_SENDER_ID_STRING: String
The FCM sender ID for the carrier. Used to trigger a carrier network requested entitlement configuration via Firebase Cloud Messaging (FCM). Do not set if the carrier doesn't use FCM for network requested entitlement configuration. Reference: GSMA TS.43-v5, section 2.4, Network Requested Entitlement Configuration.
Value: "imsserviceentitlement.fcm_sender_id_string"
KEY_IMS_PROVISIONING_BOOL
static val KEY_IMS_PROVISIONING_BOOL: String
For some carriers, the network is not provisioned by default to support IMS (VoLTE/VoWiFi/SMSoIP) service for all end users. Some type of network-side provisioning must then take place before offering the IMS service to the end-user. true - need this ImsServiceEntitlement app to do IMS (VoLTE/VoWiFi/SMSoIP) provisioning in the background before offering the IMS service to the end-user. Note: this is effective only if the carrier needs IMS provisioning, i.e. KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL is set to true. Reference: GSMA TS.43-v5, section 3 - 5, VoWiFi/VoLTE/SMSoIP entitlement configuration.
Value: "imsserviceentitlement.ims_provisioning_bool"
KEY_PREFIX
static val KEY_PREFIX: String
Prefix of all ImsServiceEntitlement.KEY_* constants.
Value: "imsserviceentitlement."
KEY_SHOW_VOWIFI_WEBVIEW_BOOL
static val KEY_SHOW_VOWIFI_WEBVIEW_BOOL: String
For some carriers, end-users may be presented with a web portal of the carrier before being allowed to use the VoWiFi service. To support this feature, the app hosts a android.webkit.WebView in the foreground VoWiFi entitlement configuration flow to show the web portal. true - show the VoWiFi portal in a webview. Note: this is effective only if the KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING is set to this app. Reference: GSMA TS.43-v5, section 3, VoWiFi entitlement configuration.
Value: "imsserviceentitlement.show_vowifi_webview_bool"
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,["# CarrierConfigManager.ImsServiceEntitlement\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nImsServiceEntitlement\n=====================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement \"View this page in Java\") \n\n```\nclass ImsServiceEntitlement\n```\n\n|---|-------------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.telephony.CarrierConfigManager.ImsServiceEntitlement](#) |\n\nConfigs used by ImsServiceEntitlement.\n\nSummary\n-------\n\n| Constants ||\n|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_ENTITLEMENT_SERVER_URL_STRING](#KEY_ENTITLEMENT_SERVER_URL_STRING:kotlin.String) The address of the entitlement configuration server. |\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_FCM_SENDER_ID_STRING](#KEY_FCM_SENDER_ID_STRING:kotlin.String) The FCM sender ID for the carrier. |\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_IMS_PROVISIONING_BOOL](#KEY_IMS_PROVISIONING_BOOL:kotlin.String) For some carriers, the network is not provisioned by default to support IMS (VoLTE/VoWiFi/SMSoIP) service for all end users. |\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_PREFIX](#KEY_PREFIX:kotlin.String) Prefix of all ImsServiceEntitlement. |\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_SHOW_VOWIFI_WEBVIEW_BOOL](#KEY_SHOW_VOWIFI_WEBVIEW_BOOL:kotlin.String) For some carriers, end-users may be presented with a web portal of the carrier before being allowed to use the VoWiFi service. |\n\nConstants\n---------\n\n### KEY_ENTITLEMENT_SERVER_URL_STRING\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val KEY_ENTITLEMENT_SERVER_URL_STRING: String\n```\n\nThe address of the entitlement configuration server. Reference: GSMA TS.43-v5, section 2.1 Default Entitlement Configuration Server. \n\n Value: \"imsserviceentitlement.entitlement_server_url_string\"\n\n### KEY_FCM_SENDER_ID_STRING\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val KEY_FCM_SENDER_ID_STRING: String\n```\n\nThe FCM sender ID for the carrier. Used to trigger a carrier network requested entitlement configuration via Firebase Cloud Messaging (FCM). Do not set if the carrier doesn't use FCM for network requested entitlement configuration. Reference: GSMA TS.43-v5, section 2.4, Network Requested Entitlement Configuration. \n\n Value: \"imsserviceentitlement.fcm_sender_id_string\"\n\n**See Also**\n\n### KEY_IMS_PROVISIONING_BOOL\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val KEY_IMS_PROVISIONING_BOOL: String\n```\n\nFor some carriers, the network is not provisioned by default to support IMS (VoLTE/VoWiFi/SMSoIP) service for all end users. Some type of network-side provisioning must then take place before offering the IMS service to the end-user. `true` - need this ImsServiceEntitlement app to do IMS (VoLTE/VoWiFi/SMSoIP) provisioning in the background before offering the IMS service to the end-user. Note: this is effective only if the carrier needs IMS provisioning, i.e. [KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL](/reference/kotlin/android/telephony/CarrierConfigManager#KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL:kotlin.String) is set to true. Reference: GSMA TS.43-v5, section 3 - 5, VoWiFi/VoLTE/SMSoIP entitlement configuration. \n\n Value: \"imsserviceentitlement.ims_provisioning_bool\"\n\n### KEY_PREFIX\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val KEY_PREFIX: String\n```\n\nPrefix of all ImsServiceEntitlement.KEY_\\* constants. \n\n Value: \"imsserviceentitlement.\"\n\n### KEY_SHOW_VOWIFI_WEBVIEW_BOOL\n\nAdded in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val KEY_SHOW_VOWIFI_WEBVIEW_BOOL: String\n```\n\nFor some carriers, end-users may be presented with a web portal of the carrier before being allowed to use the VoWiFi service. To support this feature, the app hosts a [android.webkit.WebView](../webkit/WebView.html#) in the foreground VoWiFi entitlement configuration flow to show the web portal. `true` - show the VoWiFi portal in a webview. Note: this is effective only if the [KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING](/reference/kotlin/android/telephony/CarrierConfigManager#KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING:kotlin.String) is set to this app. Reference: GSMA TS.43-v5, section 3, VoWiFi entitlement configuration. \n\n Value: \"imsserviceentitlement.show_vowifi_webview_bool\""]]
