Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#constants) \| [Inherited Methods](https://developer.android.com/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#inhmethods)

# CarrierConfigManager.ImsServiceEntitlement

*** ** * ** ***


`
public
static
final

class
CarrierConfigManager.ImsServiceEntitlement
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.telephony.CarrierConfigManager.ImsServiceEntitlement |

<br />

*** ** * ** ***

Configs used by ImsServiceEntitlement.

## Summary

| ### Constants ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_ENTITLEMENT_SERVER_URL_STRING` The address of the entitlement configuration server. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_FCM_SENDER_ID_STRING` The FCM sender ID for the carrier. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/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. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_PREFIX` Prefix of all ImsServiceEntitlement.KEY_\* constants. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/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. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/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 https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/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` | ` https://developer.android.com/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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Constants

### KEY_ENTITLEMENT_SERVER_URL_STRING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

Constant Value:

"imsserviceentitlement.entitlement_server_url_string"


### KEY_FCM_SENDER_ID_STRING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

**See also:**

- [About FCM messages - Credentials](https://firebase.google.com/docs/cloud-messaging/concept-options#senderid)

Constant Value:

"imsserviceentitlement.fcm_sender_id_string"


### KEY_IMS_PROVISIONING_BOOL

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.
`https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL` is set to true.

Reference: GSMA TS.43-v5, section 3 - 5, VoWiFi/VoLTE/SMSoIP entitlement configuration.

<br />

Constant Value:

"imsserviceentitlement.ims_provisioning_bool"


### KEY_PREFIX

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String KEY_PREFIX
```

Prefix of all ImsServiceEntitlement.KEY_\* constants.

<br />

Constant Value:

"imsserviceentitlement."


### KEY_SHOW_VOWIFI_WEBVIEW_BOOL

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/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 `https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING`
is set to this app.

Reference: GSMA TS.43-v5, section 3, VoWiFi entitlement configuration.

<br />

Constant Value:

"imsserviceentitlement.show_vowifi_webview_bool"