# Print output for @column tags ?> CarrierConfigManager.Ims - Android SDK | Android Developers

Most visited

Recently visited

CarrierConfigManager.Ims

public static final class CarrierConfigManager.Ims
extends Object

java.lang.Object
   ↳ android.telephony.CarrierConfigManager.Ims


Configs used by the IMS stack.

Summary

Constants

String KEY_ENABLE_PRESENCE_CAPABILITY_EXCHANGE_BOOL

Flag indicating whether or not this carrier supports the exchange of phone numbers with the carrier's RCS presence server in order to retrieve the RCS capabilities of requested contacts used in the RCS User Capability Exchange (UCE) procedure.

String KEY_ENABLE_PRESENCE_GROUP_SUBSCRIBE_BOOL

Flag indicating whether or not the carrier supports capability exchange with a list of contacts.

String KEY_ENABLE_PRESENCE_PUBLISH_BOOL

A boolean flag specifying whether or not this carrier supports the device notifying the network of its RCS capabilities using the SIP PUBLISH procedure defined for User Capability Exchange (UCE).

String KEY_IMS_SINGLE_REGISTRATION_REQUIRED_BOOL

A boolean flag specifying whether or not this carrier requires one IMS registration for all IMS services (MMTEL and RCS).

String KEY_NON_RCS_CAPABILITIES_CACHE_EXPIRATION_SEC_INT

An integer key associated with the period of time in seconds the non-rcs capability information of each contact is cached on the device.

String KEY_PREFIX

Prefix of all Ims.KEY_* constants.

String KEY_RCS_BULK_CAPABILITY_EXCHANGE_BOOL

Flag indicating whether or not the carrier expects the RCS UCE service to periodically refresh the RCS capabilities cache of the user's contacts as well as request the capabilities of call contacts when the SIM card is first inserted or when a new contact is added, removed, or modified.

String KEY_RCS_FEATURE_TAG_ALLOWED_STRING_ARRAY

Specifies the RCS feature tag allowed for the carrier.

String KEY_WIFI_OFF_DEFERRING_TIME_MILLIS_INT

Delay in milliseconds to turn off wifi when IMS is registered over wifi.

Inherited methods

Constants

KEY_ENABLE_PRESENCE_CAPABILITY_EXCHANGE_BOOL

public static final String KEY_ENABLE_PRESENCE_CAPABILITY_EXCHANGE_BOOL

Flag indicating whether or not this carrier supports the exchange of phone numbers with the carrier's RCS presence server in order to retrieve the RCS capabilities of requested contacts used in the RCS User Capability Exchange (UCE) procedure. See RCC.71, section 3 for more information.

When presence is supported, the device uses the SIP SUBSCRIBE/NOTIFY procedure internally to retrieve the requested RCS capabilities. See RcsUceAdapter for more information on how RCS capabilities can be retrieved from the carrier's network.

Constant Value: "ims.enable_presence_capability_exchange_bool"

KEY_ENABLE_PRESENCE_GROUP_SUBSCRIBE_BOOL

public static final String KEY_ENABLE_PRESENCE_GROUP_SUBSCRIBE_BOOL

Flag indicating whether or not the carrier supports capability exchange with a list of contacts. When true, the device will batch together multiple requests and construct a RLMI document in the SIP SUBSCRIBE request (see RFC 4662). If false, the request will be split up into one SIP SUBSCRIBE request per contact.

Constant Value: "ims.enable_presence_group_subscribe_bool"

KEY_ENABLE_PRESENCE_PUBLISH_BOOL

public static final String KEY_ENABLE_PRESENCE_PUBLISH_BOOL

A boolean flag specifying whether or not this carrier supports the device notifying the network of its RCS capabilities using the SIP PUBLISH procedure defined for User Capability Exchange (UCE). See RCC.71, section 3 for more information.

If this key's value is set to false, the procedure for RCS contact capability exchange via SIP SUBSCRIBE/NOTIFY will also be disabled internally, and Ims#KEY_ENABLE_PRESENCE_PUBLISH_BOOL must also be set to false to ensure apps do not improperly think that capability exchange via SIP PUBLISH is enabled.

The default value for this key is false.

Constant Value: "ims.enable_presence_publish_bool"

KEY_IMS_SINGLE_REGISTRATION_REQUIRED_BOOL

public static final String KEY_IMS_SINGLE_REGISTRATION_REQUIRED_BOOL

A boolean flag specifying whether or not this carrier requires one IMS registration for all IMS services (MMTEL and RCS).

If set to true, the IMS Service must use one IMS registration for all IMS services. If set to false, IMS services may use separate IMS registrations for MMTEL and RCS.

The default value for this configuration is false.

See also:

Constant Value: "ims.ims_single_registration_required_bool"

KEY_NON_RCS_CAPABILITIES_CACHE_EXPIRATION_SEC_INT

public static final String KEY_NON_RCS_CAPABILITIES_CACHE_EXPIRATION_SEC_INT

An integer key associated with the period of time in seconds the non-rcs capability information of each contact is cached on the device.

The rcs capability cache expiration sec is managed by android.telephony.ims.ProvisioningManager but non-rcs capability is managed by CarrierConfigManager since non-rcs capability will be provided via ACS or carrier config.

The default value is 2592000 secs (30 days), see RCC.07 Annex A.1.9.

Constant Value: "ims.non_rcs_capabilities_cache_expiration_sec_int"

KEY_PREFIX

public static final String KEY_PREFIX

Prefix of all Ims.KEY_* constants.

Constant Value: "ims."

KEY_RCS_BULK_CAPABILITY_EXCHANGE_BOOL

public static final String KEY_RCS_BULK_CAPABILITY_EXCHANGE_BOOL

Flag indicating whether or not the carrier expects the RCS UCE service to periodically refresh the RCS capabilities cache of the user's contacts as well as request the capabilities of call contacts when the SIM card is first inserted or when a new contact is added, removed, or modified. This corresponds to the RCC.07 A.19 "DISABLE INITIAL ADDRESS BOOK SCAN" parameter.

If this flag is disabled, the capabilities cache will not be refreshed internally at all and will only be updated if the cached capabilities are stale when an application requests them.

See also:

Constant Value: "ims.rcs_bulk_capability_exchange_bool"

KEY_RCS_FEATURE_TAG_ALLOWED_STRING_ARRAY

public static final String KEY_RCS_FEATURE_TAG_ALLOWED_STRING_ARRAY

Specifies the RCS feature tag allowed for the carrier.

The values refer to RCC.07 2.4.4.

Constant Value: "ims.rcs_feature_tag_allowed_string_array"

KEY_WIFI_OFF_DEFERRING_TIME_MILLIS_INT

public static final String KEY_WIFI_OFF_DEFERRING_TIME_MILLIS_INT

Delay in milliseconds to turn off wifi when IMS is registered over wifi.

Constant Value: "ims.wifi_off_deferring_time_millis_int"