Telematics SDK - Interface Specification
|
Data Structures | |
class | telux::tel::ICall |
ICall represents a call in progress. An ICall cannot be directly created by the client, rather it is returned as a result of instantiating a call or from the PhoneListener when receiving an incoming call. More... | |
class | telux::tel::ICallListener |
A listener class for monitoring changes in call, including call state change and ECall state change. Override the methods for the state that you wish to receive updates for. More... | |
class | telux::tel::ICallManager |
Call Manager does aggregate state management for in-progress calls It provides APIs for makeCall, makeECall, conferencing or swapping active and on-hold calls and to get the list of in-progress calls. More... | |
class | telux::tel::IMakeCallCallback |
Interface for Make Call callback object. Client needs to implement this interface to get single shot responses for commands like make call. More... | |
This section contains APIs related to Call.
class telux::tel::ICall |
ICall represents a call in progress. An ICall cannot be directly created by the client, rather it is returned as a result of instantiating a call or from the PhoneListener when receiving an incoming call.
Public Member Functions | |
virtual telux::common::Status | answer (std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual telux::common::Status | hold (std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual telux::common::Status | resume (std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual telux::common::Status | reject (std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual telux::common::Status | reject (const std::string &rejectSMS, std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual telux::common::Status | hangup (std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual CallState | getCallState ()=0 |
virtual int | getCallIndex ()=0 |
virtual CallDirection | getCallDirection ()=0 |
virtual std::string | getRemotePartyNumber ()=0 |
virtual CallEndCause | getCallEndCause ()=0 |
virtual int | getPhoneId ()=0 |
virtual | ~ICall () |
|
virtual |
|
pure virtual |
Allows the client to answer the call. This is only applicable for CallDirection::INCOMING.
[in] | callback | - optional callback pointer to get the response of answer request below are possible error codes for callback response
|
|
pure virtual |
Puts the ongoing call on hold.
[in] | callback | - optional callback pointer to get the response of hold request below are possible error codes for callback response
|
|
pure virtual |
Resumes this call from on-hold state to active state
[in] | callback | - optional callback pointer to get the response of resume request below are possible error codes for callback response
|
|
pure virtual |
Reject the incoming call. Only applicable for CallDirection::INCOMING.
[in] | callback | - optional callback pointer to get the response of reject request below are possible error codes for callback response
|
|
pure virtual |
Reject the call and send an SMS to caller. Only applicable for CallDirection::INCOMING.
[in] | rejectSMS | SMS string used to send in response to a call rejection. |
[in] | callback | - optional callback pointer to get the response of rejectwithSMS request below are possible error codes for callback response
|
|
pure virtual |
Hang up the active call.
[in] | callback | - optional callback pointer to get the response of hangup request below are possible error codes for callback response
|
|
pure virtual |
Get the current state of the call, such as ringing, in progress etc.
|
pure virtual |
Get the unique index of the call assigned by Telephony subsystem
|
pure virtual |
Get the direction of the call
|
pure virtual |
Get the dailing number
|
pure virtual |
Get the cause of the termination of the call.
|
pure virtual |
Get id of the phone object which represents the network/SIM on which the call is in progress.
class telux::tel::ICallListener |
A listener class for monitoring changes in call, including call state change and ECall state change. Override the methods for the state that you wish to receive updates for.
The methods in listener can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | onIncomingCall (std::shared_ptr< ICall > call) |
virtual void | onCallInfoChange (std::shared_ptr< ICall > call) |
virtual void | onECallMsdTransmissionStatus (int phoneId, telux::common::ErrorCode errorCode) |
virtual | ~ICallListener () |
|
virtual |
|
virtual |
This function is called when device receives an incoming call.
[in] | call | - Pointer to ICall instance |
|
virtual |
This function is called when there is a change in call attributes
[in] | call | - Pointer to ICall instance |
|
virtual |
This function is called when device completes MSD Transmission.
[in] | phoneId | - Unique Id of phone on which MSD Transmission Status is being reported |
[in] | status | - Indicates MSD Transmission status i.e. success or failure |
class telux::tel::ICallManager |
Call Manager does aggregate state management for in-progress calls It provides APIs for makeCall, makeECall, conferencing or swapping active and on-hold calls and to get the list of in-progress calls.
Public Member Functions | |
virtual telux::common::Status | makeCall (int phoneId, const std::string &dialNumber, std::shared_ptr< IMakeCallCallback > callback=nullptr)=0 |
virtual telux::common::Status | makeECall (int phoneId, const ECallMsdData &eCallMsdData, int emergencyCategory, int eCallVariant, std::shared_ptr< IMakeCallCallback > callback=nullptr)=0 |
virtual telux::common::Status | updateECallMsd (int phoneId, const ECallMsdData &eCallMsd, std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual std::vector < std::shared_ptr< ICall > > | getInProgressCalls ()=0 |
virtual telux::common::Status | conference (std::shared_ptr< ICall > call1, std::shared_ptr< ICall > call2, std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual telux::common::Status | swap (std::shared_ptr< ICall > callToHold, std::shared_ptr< ICall > callToActivate, std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr)=0 |
virtual telux::common::Status | registerListener (std::shared_ptr< telux::tel::ICallListener > listener)=0 |
virtual telux::common::Status | removeListener (std::shared_ptr< telux::tel::ICallListener > listener)=0 |
virtual | ~ICallManager () |
|
virtual |
|
pure virtual |
Initiate a voice call.
[in] | phoneId | - Represents phone corresponding to which on make call operation is performed |
[in] | dialNumber | - String representing the dialing number |
[in] | callback | - Optional callback pointer to get the response of makeCall request. Possible error codes for callback response
|
|
pure virtual |
Initiate an ecall.
[in] | phoneId | - Represents phone corresponding to which on make ecall operation is performed |
[in] | eCallMsdData | - The structure containing required fields to create eCall Minimum Set of Data (MSD) |
[in] | emergencyCategory | - Denotes the eCall category
|
[in] | eCallVariant | - Denotes the call variant enum which can take following values:
|
[in] | callback | - Optional callback pointer to get the response of makeECall request. Possible error codes for callback response
|
|
pure virtual |
Update the eCall MSD in modem to be sent to Public Safety Answering Point (PSAP) when requested.
[in] | phoneId | - Represents phone corresponding to which updateECallMsd operation is performed |
[in] | eCallMsd | - The data structure represents the Minimum Set of Data (MSD) |
|
pure virtual |
Get a vector of all currently in-progress calls in the system
|
pure virtual |
Join two calls in a conference
[in] | call1 | - Call object to conference. |
[in] | call2 | - Call object to conference. |
[in] | callback | - Optional callback pointer to get the result of conference function |
|
pure virtual |
Swap two calls - make one active and put the other on hold.
[in] | callToHold | - Active call object to swap to hold state. |
[in] | callToActivate | - Hold call object to swap to active state. |
[in] | callback | - Optional callback pointer to get the result of swap function |
|
pure virtual |
Add a listener for Call events. This listener will only get called for state changes on the Call objects.
[in] | listener | - Pointer to ICallListener object which receives event corresponding to phone |
|
pure virtual |
Remove a previously added listener.
[in] | listener | - Pointer to ICallListener object which receives event corresponding to call |
class telux::tel::IMakeCallCallback |
Interface for Make Call callback object. Client needs to implement this interface to get single shot responses for commands like make call.
The methods in callback can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | makeCallResponse (telux::common::ErrorCode error, std::shared_ptr< ICall > call=nullptr) |
|
virtual |
This function is called with the response to makeCall API.
[out] | error | - ErrorCode |
[out] | call | - Pointer to Call object or nullptr in case of failure |
|
strong |
|
strong |
Defines the states a call can be in
|
strong |
|
strong |
Defines the service states
|
strong |
Reason for the recently terminated call (either normally ended or failed)
|
strong |
Defines all available radio access technologies