Telematics_ims_settings

Detailed Description

---

Data Structure Documentation

struct telux::tel::ImsServiceConfig

Defines the selected IMS service configuration parameters and their corresponding value

Data Fields
ImsServiceConfigValidity	configValidityMask	Indicates the configurations type. Bit set to 1 denotes the config is valid.
bool	imsServiceEnabled	Enable/Disable IMS service
bool	voImsEnabled	Enable/Disable VOIMS service

class telux::tel::IImsSettingsManager

ImsSettingsManager allows IMS settings. For example enabling or disabling IMS service, VOIMS service.

Public member functions
virtual telux::common::ServiceStatus	getServiceStatus ()=0
virtual telux::common::Status	requestServiceConfig (SlotId slotId, ImsServiceConfigCb callback)=0
virtual telux::common::Status	setServiceConfig (SlotId slotId, ImsServiceConfig config, common::ResponseCallback callback=nullptr)=0
virtual telux::common::Status	registerListener (std::weak_ptr< IImsSettingsListener > listener)=0
virtual telux::common::Status	deregisterListener (std::weak_ptr< IImsSettingsListener > listener)=0
virtual	~IImsSettingsManager ()

Constructors and Destructors

virtual telux::tel::IImsSettingsManager::~IImsSettingsManager ( )

virtual

Member Function Documentation

virtual telux::common::ServiceStatus telux::tel::IImsSettingsManager::getServiceStatus ( )

pure virtual

This status indicates whether the IImsSettingsManager object is in a usable state.

Returns

SERVICE_AVAILABLE - If IMS settings manager is ready for service. SERVICE_UNAVAILABLE - If IMS settings manager is temporarily unavailable. SERVICE_FAILED - If IMS settings manager encountered an irrecoverable failure.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::tel::IImsSettingsManager::requestServiceConfig ( SlotId  slotId, ImsServiceConfigCb  callback  )

pure virtual

Request the IMS service configurations

Parameters

[in]	slotId	Slot for which the IMS service configurations is requested.
[in]	callback	Callback function to get the response of request IMS service configurations.

Returns

Status of requestServiceConfig i.e. success or suitable error code.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::tel::IImsSettingsManager::setServiceConfig ( SlotId  slotId, ImsServiceConfig  config, common::ResponseCallback  callback = nullptr  )

pure virtual

To configure the IMS service configurations. Also specifiy whether configuration needs to be enabled or disabled.

Parameters

[in]	slotId	Slot for which the IMS service configuration is intended.
[in]	config	Indicates which configuration are configured currently and whether the config is enabled or disabled. ImsServiceConfig.
[in]	callback	Callback function to get the response of set IMS service configuration request.

Returns

Status of setServiceConfig i.e. success or suitable error code.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::tel::IImsSettingsManager::registerListener ( std::weak_ptr< IImsSettingsListener >  listener )

pure virtual

Register a listener for specific events in the IMS settings subsystem.

Parameters

[in]

listener

Pointer to IImsSettingsListener object that processes the notification

Returns

Status of registerListener i.e. success or suitable error code.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::tel::IImsSettingsManager::deregisterListener ( std::weak_ptr< IImsSettingsListener >  listener )

pure virtual

Deregister the previously added listener.

Parameters

[in]

listener

Pointer to IImsSettingsListener object that needs to be deregistered.

Returns

Status of deregisterListener i.e. success or suitable error code.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

class telux::tel::IImsSettingsListener

Listener class for getting IMS service configuration change notifications. The listener method can be invoked from multiple different threads. Client needs to make sure that implementation is thread-safe.

Public member functions
virtual void	onImsServiceConfigsChange (SlotId slotId, ImsServiceConfig config)
virtual void	onServiceStatusChange (telux::common::ServiceStatus status)
virtual	~IImsSettingsListener ()

Constructors and Destructors

virtual telux::tel::IImsSettingsListener::~IImsSettingsListener ( )

virtual

Destructor of IImsSettingsListener

Member Function Documentation

virtual void telux::tel::IImsSettingsListener::onImsServiceConfigsChange ( SlotId  slotId, ImsServiceConfig  config  )

virtual

This function is called whenever any IMS service configuration is changed.

Parameters

[in]	slotId	SIM corresponding to slot identifier for which the IMS service configuration has changed.
[in]	config	Indicates which configuration is valid and whether the config is enabled or disabled. ImsServiceConfig.

Note

Eval: This is a new API and is being evaluated.It is subject to change and could break backwards compatibility.

virtual void telux::tel::IImsSettingsListener::onServiceStatusChange ( telux::common::ServiceStatus  status )

virtual

This function is called when IImsSettingsManager service status changes.

Parameters

[in]

status

- ServiceStatus

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

Enumeration Type Documentation

enum telux::tel::ImsServiceConfigType

Defines the IMS service configuration parameters

Enumerator
IMSSETTINGS_VOIMS	Voice calling support on LTE
IMSSETTINGS_IMS_SERVICE	IMS Normal Registration configuration