Stay organized with collections
Save and categorize content based on your preferences.
CarrierConfigManager.ImsServiceEntitlement
public
static
final
class
CarrierConfigManager.ImsServiceEntitlement
extends Object
Configs used by ImsServiceEntitlement.
Summary
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Constants
KEY_ENTITLEMENT_SERVER_URL_STRING
public static final String KEY_ENTITLEMENT_SERVER_URL_STRING
The address of the entitlement configuration server.
Reference: GSMA TS.43-v5, section 2.1 Default Entitlement Configuration Server.
Constant Value:
"imsserviceentitlement.entitlement_server_url_string"
KEY_FCM_SENDER_ID_STRING
public static final String KEY_FCM_SENDER_ID_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.
Constant Value:
"imsserviceentitlement.fcm_sender_id_string"
KEY_IMS_PROVISIONING_BOOL
public static final String KEY_IMS_PROVISIONING_BOOL
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.
CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL is set to true.
Reference: GSMA TS.43-v5, section 3 - 5, VoWiFi/VoLTE/SMSoIP entitlement configuration.
Constant Value:
"imsserviceentitlement.ims_provisioning_bool"
KEY_PREFIX
public static final String KEY_PREFIX
Prefix of all ImsServiceEntitlement.KEY_* constants.
Constant Value:
"imsserviceentitlement."
KEY_SHOW_VOWIFI_WEBVIEW_BOOL
public static final String KEY_SHOW_VOWIFI_WEBVIEW_BOOL
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 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 CarrierConfigManager.KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING
is set to this app.
Reference: GSMA TS.43-v5, section 3, VoWiFi entitlement configuration.
Constant 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](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Constants](#constants) \\| [Inherited Methods](#inhmethods) \n\nCarrierConfigManager.ImsServiceEntitlement\n==========================================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/telephony/CarrierConfigManager.ImsServiceEntitlement \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nCarrierConfigManager.ImsServiceEntitlement\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|--------------------------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.telephony.CarrierConfigManager.ImsServiceEntitlement |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nConfigs used by ImsServiceEntitlement.\n\nSummary\n-------\n\n| ### Constants ||\n|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/String) | [KEY_ENTITLEMENT_SERVER_URL_STRING](/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_ENTITLEMENT_SERVER_URL_STRING) The address of the entitlement configuration server. |\n| [String](/reference/java/lang/String) | [KEY_FCM_SENDER_ID_STRING](/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_FCM_SENDER_ID_STRING) The FCM sender ID for the carrier. |\n| [String](/reference/java/lang/String) | [KEY_IMS_PROVISIONING_BOOL](/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_IMS_PROVISIONING_BOOL) For some carriers, the network is not provisioned by default to support IMS (VoLTE/VoWiFi/SMSoIP) service for all end users. |\n| [String](/reference/java/lang/String) | [KEY_PREFIX](/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_PREFIX) Prefix of all ImsServiceEntitlement.KEY_\\* constants. |\n| [String](/reference/java/lang/String) | [KEY_SHOW_VOWIFI_WEBVIEW_BOOL](/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_SHOW_VOWIFI_WEBVIEW_BOOL) For some carriers, end-users may be presented with a web portal of the carrier before being allowed to use the VoWiFi service. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nConstants\n---------\n\n### KEY_ENTITLEMENT_SERVER_URL_STRING\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic static final String KEY_ENTITLEMENT_SERVER_URL_STRING\n```\n\nThe address of the entitlement configuration server.\n\nReference: GSMA TS.43-v5, section 2.1 Default Entitlement Configuration Server.\n\n\u003cbr /\u003e\n\nConstant Value:\n\n\"imsserviceentitlement.entitlement_server_url_string\"\n\n\n### KEY_FCM_SENDER_ID_STRING\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic static final String KEY_FCM_SENDER_ID_STRING\n```\n\nThe FCM sender ID for the carrier.\nUsed to trigger a carrier network requested entitlement configuration\nvia Firebase Cloud Messaging (FCM). Do not set if the carrier doesn't use FCM for network\nrequested entitlement configuration.\n\nReference: GSMA TS.43-v5, section 2.4, Network Requested Entitlement Configuration.\n\n\u003cbr /\u003e\n\n**See also:**\n\n- [About FCM messages - Credentials](https://firebase.google.com/docs/cloud-messaging/concept-options#senderid)\n\nConstant Value:\n\n\"imsserviceentitlement.fcm_sender_id_string\"\n\n\n### KEY_IMS_PROVISIONING_BOOL\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic static final String KEY_IMS_PROVISIONING_BOOL\n```\n\nFor some carriers, the network is not provisioned by default to support\nIMS (VoLTE/VoWiFi/SMSoIP) service for all end users. Some type of network-side\nprovisioning must then take place before offering the IMS service to the end-user.\n\n`true` - need this ImsServiceEntitlement app to do IMS (VoLTE/VoWiFi/SMSoIP)\nprovisioning in the background before offering the IMS service to the end-user.\n\nNote: this is effective only if the carrier needs IMS provisioning, i.e.\n[CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL](/reference/android/telephony/CarrierConfigManager#KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL) is set to true.\n\nReference: GSMA TS.43-v5, section 3 - 5, VoWiFi/VoLTE/SMSoIP entitlement configuration.\n\n\u003cbr /\u003e\n\nConstant Value:\n\n\"imsserviceentitlement.ims_provisioning_bool\"\n\n\n### KEY_PREFIX\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic static final String KEY_PREFIX\n```\n\nPrefix of all ImsServiceEntitlement.KEY_\\* constants.\n\n\u003cbr /\u003e\n\nConstant Value:\n\n\"imsserviceentitlement.\"\n\n\n### KEY_SHOW_VOWIFI_WEBVIEW_BOOL\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic static final String KEY_SHOW_VOWIFI_WEBVIEW_BOOL\n```\n\nFor some carriers, end-users may be presented with a web portal of the carrier before\nbeing allowed to use the VoWiFi service.\nTo support this feature, the app hosts a [WebView](/reference/android/webkit/WebView) in the foreground\nVoWiFi entitlement configuration flow to show the web portal.\n\n`true` - show the VoWiFi portal in a webview.\n\nNote: this is effective only if the [CarrierConfigManager.KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING](/reference/android/telephony/CarrierConfigManager#KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING)\nis set to this app.\n\nReference: GSMA TS.43-v5, section 3, VoWiFi entitlement configuration.\n\n\u003cbr /\u003e\n\nConstant Value:\n\n\"imsserviceentitlement.show_vowifi_webview_bool\""]]
