Telematics SDK - API Reference
v1.62.0
|
Data Structures | |
class | telux::tel::ISuppServicesListener |
A listener class for receiving supplementary services notifications. The methods in listener can be invoked from multiple different threads. The implementation should be thread safe. More... | |
struct | telux::tel::ForwardInfo |
struct | telux::tel::ForwardReq |
class | telux::tel::ISuppServicesManager |
ISuppServicesManager is the interface to provide supplementary services like call forwarding and call waiting. More... | |
Typedefs | |
using | telux::tel::ServiceClass = std::bitset< 8 > |
using | telux::tel::SetSuppSvcPrefCallback = std::function< void(telux::common::ErrorCode error, FailureCause failureCause)> |
using | telux::tel::GetCallWaitingPrefExCb = std::function< void(SuppServicesStatus suppSvcStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
using | telux::tel::GetForwardingPrefExCb = std::function< void(std::vector< ForwardInfo > forwardInfoList, FailureCause failureCause, telux::common::ErrorCode error)> |
using | telux::tel::GetOirPrefCb = std::function< void(SuppServicesStatus suppSvcStatus, SuppSvcProvisionStatus provisionStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
using | telux::tel::GetCallWaitingPrefCb = std::function< void(SuppServicesStatus suppSvcStatus, SuppSvcProvisionStatus provisionStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
using | telux::tel::GetForwardingPrefCb = std::function< void(std::vector< ForwardInfo > forwardInfoList, SuppSvcProvisionStatus provisionStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
This section contains APIs related to supplementary services to provide services like call forwarding, call waiting.
class telux::tel::ISuppServicesListener |
A listener class for receiving supplementary services notifications. The methods in listener can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual | ~ISuppServicesListener () |
Destroy the ISuppServicesListener object. More... | |
![]() | |
virtual void | onServiceStatusChange (ServiceStatus status) |
virtual | ~IServiceStatusListener () |
|
virtual |
Destroy the ISuppServicesListener object.
struct telux::tel::ForwardInfo |
Represents parameters for forwarding.
Data Fields | ||
---|---|---|
SuppServicesStatus | status |
Status of the supplemetary service |
ServiceClass | serviceClass |
Service class |
string | number |
Phone number to which the call to be forwarded |
uint8_t | noReplyTimer |
No reply timer |
struct telux::tel::ForwardReq |
Represents parameters required for forwarding request.
Data Fields | ||
---|---|---|
ForwardOperation | operation |
Type of operation for forwarding |
ForwardReason | reason |
Reason for call forwarding telux::tel::ForwardReason |
ServiceClass | serviceClass |
Service Class for operation telux::tel::ServiceClass |
string | number |
Number to which call has to be forwarded. This parameter is required only for registration purpose only. telux::tel::ForwardOperation::REGISTER |
uint8_t | noReplyTimer |
Timer for no reply operation. Required only for no reply forward reason. telux::tel::ForwardReason::NOREPLY. |
class telux::tel::ISuppServicesManager |
ISuppServicesManager is the interface to provide supplementary services like call forwarding and call waiting.
|
virtual |
Destructor for ISupplementaryServicesManager
|
pure virtual |
This status indicates whether the ISuppServicesManager object is in a usable state.
|
pure virtual |
Enable/disable call waiting on device.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SUPP_SERVICES permissions to invoke this API successfully.
[in] | suppSvcStatus | - Call waiting preference telux::tel::SuppServicesStatus. |
[in] | callback | - Callback function to get the response of setCallWaitingPref |
|
pure virtual |
This API queries the preference for call waiting.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SUPP_SERVICES permissions to invoke this API successfully.
[in] | callback | - Callback function to get the response of call waiting preference. |
|
pure virtual |
To set call forwarding preference.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SUPP_SERVICES permissions to invoke this API successfully.
[in] | forwardReq | - Parameters for call forwarding operation. telux::tel::ForwardReq |
[in] | callback | - Callback function to get response of setForwardingPref API. |
|
pure virtual |
This API queries preference for call forwarding supplementary service. If active, returns for which service classes and call forwarding number it is active. There is an option to configure for which service class the request is made, if the option is not configured it assumes that the request is made for all service classes.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SUPP_SERVICES permissions to invoke this API successfully.
[in] | serviceClass | - Service class telux::tel::ServiceClass. |
[in] | callback | - Callback function to get the response of request call forwarding preference. |
|
pure virtual |
Activate/Deactivate originating identification restriction preference on the device. If the OIR service was activated, the original call number will be restricted to the target when a call is dialed to a subscriber.
On platforms with access control enabled, the caller must have TELUX_TEL_SUPP_SERVICES permissions to invoke this API successfully.
[in] | serviceClass | - Service class telux::tel::ServiceClass. |
[in] | suppSvcStatus | - OIR Status telux::tel::SuppServicesStatus. |
[in] | callback | - Callback function to get the response of setOIRPref |
|
pure virtual |
This API queries the originating identification restriction preference.
On platforms with access control enabled, the caller must have TELUX_TEL_SUPP_SERVICES permissions to invoke this API successfully.
[in] | serviceClass | - Service class telux::tel::ServiceClass. |
[in] | callback | - Callback function to get the response of requestOIRPref |
|
pure virtual |
Register a listener for supplementary services events.
[in] | listener | Pointer to ISuppServicesListener object that processes the notification. |
|
pure virtual |
Remove a previously added listener.
[in] | listener | Pointer to ISuppServicesListener object that needs to be removed. |
|
pure virtual |
This API queries the preference for call waiting.
[in] | callback | - Callback function to get the response of requestCallWaitingPref. |
|
pure virtual |
This API queries preference for call forwarding supplementary service. If active, returns for which service classes and call forwarding number it is active. It also returns the provision status of the supplemetary service. There is an option to configure for which service class the request is made, if the option is not configured it assumes that the request is made for all service classes.
[in] | serviceClass | - Service class telux::tel::ServiceClass. |
[in] | callback | - Callback function to get the response of request call forwarding preference. |
using telux::tel::ServiceClass = typedef std::bitset<8> |
8 bit mask that denotes which of the service class to be used. telux::tel::ServiceClassType
using telux::tel::SetSuppSvcPrefCallback = typedef std::function<void(telux::common::ErrorCode error, FailureCause failureCause)> |
This function is called with the response to setCallWaitingPref and setForwardingPref APIs.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | error | - Return code which indicates whether the operation succeeded or not telux::common::ErrorCode |
[in] | failureCause | - Failure cause populated only in case of errors telux::tel::FailureCause. |
using telux::tel::GetCallWaitingPrefExCb = typedef std::function<void(SuppServicesStatus suppSvcStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
This function is called with the response to requestCallWaitingPrefEx API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | suppSvcStatus | - Call waiting status telux::tel::SuppServicesStatus |
[in] | failureCause | - Failure cause populated only in case of errors telux::tel::FailureCause. |
[in] | error | - Return code which indicates whether the operation succeeded or not telux::common::ErrorCode |
using telux::tel::GetForwardingPrefExCb = typedef std::function<void(std::vector<ForwardInfo> forwardInfoList, FailureCause failureCause, telux::common::ErrorCode error)> |
This function is called with the response to requestForwardingPrefEx API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | forwardInfoList | - List of forward info telux::tel::ForwardInfo. Multiple info are received when different service class are forwarded to different numbers. |
[in] | failureCause | - Returns failure cause in case the request fails. |
[in] | error | - Return code which indicates whether the operation succeeded or not telux::common::ErrorCode |
using telux::tel::GetOirPrefCb = typedef std::function<void(SuppServicesStatus suppSvcStatus, SuppSvcProvisionStatus provisionStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
This function is called with the response to the requestOirPref API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | suppSvcStatus | - OIR status telux::tel::SuppServicesStatus |
[in] | provisionStatus | - Provision status telux::tel::SuppSvcProvisionStatus. |
[in] | failureCause | - Returns failure cause in case the request fails. |
[in] | error | - Return code which indicates whether the operation succeeded or not telux::common::ErrorCode |
using telux::tel::GetCallWaitingPrefCb = typedef std::function<void(SuppServicesStatus suppSvcStatus, SuppSvcProvisionStatus provisionStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
This function is called with the response to requestCallWaitingPref API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | suppSvcStatus | - Call waiting status telux::tel::SuppServicesStatus |
[in] | provisionStatus | - Provision status telux::tel::SuppSvcProvisionStatus. |
[in] | failureCause | - Failure cause populated only in case of errors telux::tel::FailureCause. |
[in] | error | - Return code which indicates whether the operation succeeded or not telux::common::ErrorCode |
using telux::tel::GetForwardingPrefCb = typedef std::function<void(std::vector<ForwardInfo> forwardInfoList, SuppSvcProvisionStatus provisionStatus, FailureCause failureCause, telux::common::ErrorCode error)> |
This function is called with the response to requestForwardingPref API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | forwardInfoList | - List of forward info telux::tel::ForwardInfo. Multiple info are received when different service class are forwarded to different numbers. |
[in] | provisionStatus | - Provision status telux::tel::SuppSvcProvisionStatus. |
[in] | failureCause | - Returns failure cause in case the request fails. |
[in] | error | - Return code which indicates whether the operation succeeded or not telux::common::ErrorCode |
|
strong |
|
strong |
Defines supplementary services provision status.
|
strong |
|
strong |
|
strong |
|
strong |
Represents the cause for supplementary services failure.