Telematics SDK - Interface Specification
v1.43.0
|
Data Structures | |
struct | CardReaderStatus |
class | CdmaCellIdentity |
class | CdmaCellInfo |
class | CdmaSignalStrengthInfo |
struct | CellBroadcastFilter |
class | CellBroadcastMessage |
Cell Broadcast message. More... | |
class | CellInfo |
struct | CellularCapabilityInfo |
class | Circle |
class | CmasInfo |
struct | DcStatus |
struct | ECallHlapTimerEvents |
struct | ECallHlapTimerStatus |
struct | ECallModeInfo |
struct | ECallMsdControlBits |
struct | ECallMsdData |
struct | ECallMsdOptionals |
struct | ECallOptionalPdu |
struct | ECallVehicleIdentificationNumber |
struct | ECallVehicleLocation |
struct | ECallVehicleLocationDelta |
struct | ECallVehiclePropulsionStorageType |
class | EtwsInfo |
class | Geometry |
class | GsmCellIdentity |
class | GsmCellInfo |
class | GsmSignalStrengthInfo |
class | IAtrResponseCallback |
class | 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 | 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 | ICallManager |
Call Manager is the primary interface for call related operations Allows to conference calls, swap calls, make normal voice call and emergency call, send and update MSD pdu. More... | |
class | ICard |
ICard represents currently inserted UICC or eUICC. More... | |
class | ICardApp |
Represents a single card application. More... | |
class | ICardChannelCallback |
class | ICardCommandCallback |
class | ICardListener |
class | ICardManager |
class | ICardReaderCallback |
struct | IccResult |
class | ICellBroadcastListener |
A listener class which monitors cell broadcast messages. More... | |
class | ICellBroadcastManager |
CellBroadcastManager class is primary interface to configure and activate emergency broadcast messages and receive broadcast messages. More... | |
class | ICellularCapabilityCallback |
class | 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. More... | |
class | IImsSettingsManager |
ImsSettingsManager allows IMS settings. For example enabling or disabling IMS service, VOIMS service. More... | |
class | IMakeCallCallback |
Interface for Make Call callback object. Client needs to implement this interface to get single shot responses for commands like make call. More... | |
struct | ImsServiceConfig |
class | IMultiSimListener |
Listener class for getting high capability change notification. The listener method can be invoked from multiple different threads. Client needs to make sure that implementation is thread-safe. More... | |
class | IMultiSimManager |
MultiSimManager allows to perform operation pertaining to devices which have more than one SIM/UICC card. Clients should check if the subsystem is ready before invoking any of the APIs as follows. More... | |
class | INetworkSelectionListener |
Listener class for getting network selection mode change notification. More... | |
class | INetworkSelectionManager |
Network Selection Manager class provides the interface to get and set network selection mode, preferred network list and scan available networks. More... | |
class | IOperatingModeCallback |
class | IPhone |
This class allows getting system information and registering for system events. Each Phone instance is associated with a single SIM. So on a dual SIM device you would have 2 Phone instances. More... | |
class | IPhoneListener |
A listener class for monitoring changes in specific telephony states on the device, including service state and signal strength. Override the methods for the state that you wish to receive updates for. More... | |
class | IPhoneManager |
Phone Manager creates one or more phones based on SIM slot count, it allows clients to register for notification of system events. Clients should check if the subsystem is ready before invoking any of the APIs. More... | |
class | IRemoteSimListener |
A listener class for getting remote SIM notifications. More... | |
class | IRemoteSimManager |
IRemoteSimManager provides APIs for remote SIM related operations. This allows a device to use a SIM card on another device for its WWAN modem functionality. The SIM provider service is the endpoint that interfaces with the SIM card (e.g. over bluetooth) and sends/receives data to the other endpoint, the modem. The modem sends requests to the SIM provider service to interact with the SIM card (e.g. power up, transmit APDU, etc.), and is notified of events (e.g. card errors, resets, etc.). This API is used by the SIM provider endpoint to provide a SIM card to the modem. More... | |
class | ISapCardCommandCallback |
class | ISapCardListener |
class | ISapCardManager |
ISapCardManager provide APIs for SAP related operations. More... | |
class | IServingSystemListener |
Listener class for getting radio access technology mode preference change notification. More... | |
class | IServingSystemManager |
Serving System Manager class provides the API to request and set service domain preference and RAT preference. More... | |
class | ISignalStrengthCallback |
Interface for Signal strength callback object. Client needs to implement this interface to get single shot responses for commands like get signal strength. More... | |
class | ISimProfileListener |
The interface listens for profile download indication and keep track of download and install progress of profile. More... | |
class | ISimProfileManager |
ISimProfileManager is a primary interface for remote eUICCs (eSIMs or embedded SIMs) provisioning.This interface provides APIs to add, delete, set profile, update nickname, provide user consent, get Eid on the eUICC. More... | |
class | ISmscAddressCallback |
class | ISmsListener |
A listener class for monitoring incoming SMS and notify subsystem status changes. Override the methods for the state that you wish to receive updates for. More... | |
class | ISmsManager |
SMS Manager class is the primary interface to send and receive SMS messages. It allows to send an SMS in several formats and sizes. More... | |
class | ISubscription |
Subscription returns information about network operator subscription details pertaining to a SIM card. More... | |
class | ISubscriptionListener |
A listener class for receiving device subscription information. The methods in listener can be invoked from multiple different threads. The implementation should be thread safe. More... | |
class | ISubscriptionManager |
class | IVoiceServiceStateCallback |
Interface for voice service state callback object. Client needs to implement this interface to get single shot responses for commands like request voice radio technology. More... | |
class | LteCellIdentity |
class | LteCellInfo |
class | LteSignalStrengthInfo |
struct | MessageAttributes |
Contains structure of message attributes like encoding type, number of segments, characters left in last segment. More... | |
class | Nr5gSignalStrengthInfo |
class | OperatorInfo |
struct | OperatorStatus |
class | PhoneFactory |
PhoneFactory is the central factory to create all Telephony SDK Classes and services. More... | |
struct | Point |
class | Polygon |
struct | PreferredNetworkInfo |
class | SignalStrength |
class | SimProfile |
SimProfile class represents single eUICC profile on the card. More... | |
struct | SimRatCapability |
struct | SlotStatus |
class | SmsMessage |
A Short Message Service message. More... | |
class | TdscdmaCellIdentity |
class | TdscdmaCellInfo |
class | TdscdmaSignalStrengthInfo |
class | VoiceServiceInfo |
class | WarningAreaInfo |
class | WcdmaCellIdentity |
class | WcdmaCellInfo |
class | WcdmaSignalStrengthInfo |
struct telux::tel::Point |
Point represented by latitude and longitude.
Data Fields | ||
---|---|---|
double | latitude | |
double | longitude |
using telux::tel::MakeCallCallback = typedef std::function<void(telux::common::ErrorCode error, std::shared_ptr<ICall> call)> |
This function is called with the response to make normal call and emergency call.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[out] | error | ErrorCode |
[out] | call | Pointer to Call object or nullptr in case of failure |
using telux::tel::ECallHlapTimerStatusCallback = typedef std::function<void(telux::common::ErrorCode error, int phoneId, ECallHlapTimerStatus timersStatus)> |
This function is called with response to request for eCall High Level Application Protocol(HLAP) timers status.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[out] | error | ErrorCode |
[out] | phoneId | Represents the phone corresponding to which the response is being reported. |
[out] | timersStatus | ECallHlapTimerStatus |
using telux::tel::EcbmStatusCallback = typedef std::function<void(telux::tel::EcbMode ecbMode, telux::common::ErrorCode error)> |
This function is called with response to request for ECBM(requestEcbm API).
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[out] | ecbMode | Indicates the status of the ECBM. EcbMode |
[out] | error | ErrorCode |
using telux::tel::PinOperationResponseCb = typedef std::function<void(int retryCount, telux::common::ErrorCode error)> |
This function is called with the response to pin operations like change pin password, unlock card and set card lock.
[in] | retryCount | No of retry attempts left |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::tel::QueryFdnLockResponseCb = typedef std::function<void(bool isAvailable, bool isEnabled, telux::common::ErrorCode error)> |
This function is called with the response to queryFdnLockState API.
[in] | isAvailable | Determine FDN lock state availability |
[in] | isEnabled | Determine FDN lock state i.e enable or disable |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::tel::QueryPin1LockResponseCb = typedef std::function<void(bool state, telux::common::ErrorCode error)> |
This function is called with the response to queryPin1LockState API.
[in] | state | Determine state whether enabled or disabled |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::tel::EidResponseCallback = typedef std::function<void(const std::string &eid, telux::common::ErrorCode error)> |
This function is called with the response to requestEid API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | eid | eUICC identifier. |
[in] | error | Return code which indicates whether the operation succeeded or not. ErrorCode |
using telux::tel::RequestFiltersResponseCallback = typedef std::function<void(std::vector<CellBroadcastFilter> filters, telux::common::ErrorCode error)> |
This function is called with the response to requestMessageIdFilters API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | filters | List of broadcast filters CellBroadcastFilter |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::RequestActivationStatusResponseCallback = typedef std::function<void(bool isActivated, telux::common::ErrorCode error)> |
This function is called with the response to requestActivationStatus API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | isActivated | If true then filters are activated else filters are deactivated |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::ImsServiceConfigValidity = typedef std::bitset<32> |
32 bit mask that denotes which of the IMS settings configuration parameters defined in ImsServiceConfigType enum are configured currently. For example, if the client selects the VOIMS configuration, 1st bit position is set.
using telux::tel::ImsServiceConfigCb = typedef std::function<void(SlotId slotId, ImsServiceConfig config, telux::common::ErrorCode error)> |
This function is called in the response to requestServiceConfig API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | slotId | Slot for which the IMS service configuration is intended. |
[in] | config | Indicates which configuration is valid and whether the configuration is enabled or disabled. ImsServiceConfig. |
[in] | error | Return code which indicates whether the operation succeeded or not . |
using telux::tel::HighCapabilityCallback = typedef std::function<void(int slotId, telux::common::ErrorCode error)> |
This function is called in the response to requestHighCapability API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | slotId | SIM corresponding to slot identifier has high capability. |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::SlotStatusCallback = typedef std::function<void(std::map<SlotId, SlotStatus> slotStatus, telux::common::ErrorCode error)> |
This function is called in response to requestSlotStatus API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | slotStatus | list of slots status SlotStatus |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::RatMask = typedef std::bitset<16> |
16 bit mask that denotes which of the radio access technologies defined in RatType enum are used for preferred networks.
using telux::tel::SelectionModeResponseCallback = typedef std::function<void(NetworkSelectionMode mode, telux::common::ErrorCode error)> |
This function is called with the response to requestNetworkSelectionMode API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | mode | NetworkSelectionMode |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::PreferredNetworksCallback = typedef std::function<void(std::vector<PreferredNetworkInfo> info, std::vector<PreferredNetworkInfo> staticInfo, telux::common::ErrorCode error)> |
This function is called with the response to requestPreferredNetworks API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | info | 3GPP preferred networks list i.e PLMN list. |
[in] | staticInfo | Static 3GPP preferred networks list i.e OPLMN list. |
[in] | error | Return code which indicates whether the operation succeeded or not. ErrorCode |
using telux::tel::NetworkScanCallback = typedef std::function<void(std::vector<OperatorInfo> operatorInfos, telux::common::ErrorCode error)> |
This function is called with the response to performNetworkScan API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | operatorInfos | Operators info with details of network operator name, MCC, MNC and status. |
[in] | error | Return code which indicates whether the operation succeeded or not. ErrorCode |
using telux::tel::VoiceRadioTechResponseCb = typedef std::function<void(telux::tel::RadioTechnology radioTech, telux::common::ErrorCode error)> |
This function is called with the response to requestVoiceRadioTechnology API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | radioTech | Pointer to radio technology |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::tel::CellInfoCallback = typedef std::function<void(std::vector<std::shared_ptr<CellInfo>> cellInfoList, telux::common::ErrorCode error)> |
This function is called with the response to requestCellInfo API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[out] | cellInfoList | vector of shared pointers to cell info object |
[out] | error | Return code for whether the operation succeeded or failed |
using telux::tel::ECallGetOperatingModeCallback = typedef std::function<void(ECallMode eCallMode, telux::common::ErrorCode error)> |
This function is called with the response to requestECallOperatingMode API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[out] | eCallMode | ECallMode |
[out] | error | Return code for whether the operation succeeded or failed |
using telux::tel::RATCapabilitiesMask = typedef std::bitset<16> |
using telux::tel::VoiceServiceTechnologiesMask = typedef std::bitset<16> |
using telux::tel::SapStateResponseCallback = typedef std::function<void(SapState sapState, telux::common::ErrorCode error)> |
This function is called with the response to requestSapState API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | sapState | SapState of SIM access profile (SAP) connection |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::tel::RatPreference = typedef std::bitset<16> |
16 bit mask that denotes which of the radio access technology mode preference defined in RatPrefType enum are used to set or get RAT preference.
using telux::tel::RatPreferenceCallback = typedef std::function<void(RatPreference preference, telux::common::ErrorCode error)> |
This function is called with the response to requestRatPreference API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | preference | RatPreference |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::ServiceDomainPreferenceCallback = typedef std::function<void(ServiceDomainPreference preference, telux::common::ErrorCode error)> |
This function is called with the response to requestServiceDomainPreference API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | preference | ServiceDomainPreference |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::ProfileListResponseCb = typedef std::function<void( const std::vector<std::shared_ptr<SimProfile>> &profiles, telux::common::ErrorCode error)> |
This function is called with the response to requestProfileList API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | info | Profiles information SimProfile. |
[in] | error | Return code which indicates whether the operation succeeded or not. ErrorCode. |
using telux::tel::EidResponseCb = typedef std::function<void(std::string eid, telux::common::ErrorCode error)> |
This function is called with the response to requestEid API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | eid | eUICC identifier. |
[in] | error | Return code which indicates whether the operation succeeded or not. ErrorCode. |