Telematics SDK - Interface Specification  v1.26.8
telux::rsp Namespace Reference

Data Structures

struct  CustomHeader
 
class  IHttpTransactionListener
 The interface listens for indication to perform HTTP request and send back the response for HTTP request to modem. More...
 
class  IHttpTransactionManager
 IHttpTransactionManager is the interface to service HTTP related requests from the modem, for Sim profile update related operations. 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 on the eUICC. More...
 
class  SimProfile
 SimProfile class represents single eUICC profile on the card. More...
 
class  SimProfileFactory
 SimProfileFactory is the central factory to create all eUICC manager class instances. More...
 

Typedefs

using PolicyRuleMask = std::bitset< 16 >
 
using ProfileListResponseCb = std::function< void(const std::vector< std::shared_ptr< SimProfile >> &profiles, telux::common::ErrorCode error)>
 

Enumerations

enum  HttpResult {
  HttpResult::TRANSACTION_SUCCESSFUL = 0, HttpResult::UNKNOWN_ERROR = 1, HttpResult::HTTP_SERVER_ERROR = 2, HttpResult::HTTP_TLS_ERROR = 3,
  HttpResult::HTTP_NETWORK_ERROR = 4
}
 
enum  ProfileType { ProfileType::UNKNOWN = -1, ProfileType::REGULAR = 0, ProfileType::EMERGENCY }
 
enum  IconType { IconType::NONE = 0, IconType::JPEG, IconType::PNG }
 
enum  ProfileClass { ProfileClass::UNKNOWN = -1, ProfileClass::TEST = 0, ProfileClass::PROVISIONING, ProfileClass::OPERATIONAL }
 
enum  DownloadStatus {
  DownloadStatus::DOWNLOAD_ERROR = 1, DownloadStatus::DOWNLOAD_IN_PROGRESS, DownloadStatus::DOWNLOAD_COMPLETE_INSTALLATION_IN_PROGRESS, DownloadStatus::INSTALLATION_COMPLETE,
  DownloadStatus::USER_CONSENT_REQUIRED
}
 
enum  DownloadErrorCause { DownloadErrorCause::GENERIC = 1, DownloadErrorCause::SIM, DownloadErrorCause::NETWORK, DownloadErrorCause::MEMORY }
 
enum  PolicyRuleType { PROFILE_DISABLE_NOT_ALLOWED = (1 << 0), PROFILE_DELETE_NOT_ALLOWED = (1 << 1), PROFILE_DELETE_ON_DISABLE = (1 << 2) }
 

Typedef Documentation

using telux::rsp::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.

Parameters
[in]infoProfiles information SimProfile.
[in]errorReturn code which indicates whether the operation succeeded or not. ErrorCode.
Note
Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.