Telematics SDK - Interface Specification
v1.33.62
|
Data Structures | |
class | telux::tel::SimProfile |
SimProfile class represents single eUICC profile on the card. More... | |
class | telux::tel::ISimProfileListener |
The interface listens for profile download indication and keep track of download and install progress of profile. More... | |
class | telux::tel::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... | |
Typedefs | |
using | telux::tel::PolicyRuleMask = std::bitset< 16 > |
This section contains APIs related to Remote SIM provisioning.
class telux::tel::SimProfile |
SimProfile class represents single eUICC profile on the card.
Public Member Functions | |
SimProfile (int profileId, ProfileType profileType, const std::string &iccid, bool isActive, const std::string &nickName, const std::string &spn, const std::string &name, IconType iconType, std::vector< uint8_t > icon, ProfileClass profileClass, PolicyRuleMask policyRuleMask) | |
int | getSlotId () |
int | getProfileId () |
ProfileType | getType () |
const std::string & | getIccid () |
bool | isActive () |
const std::string & | getNickName () |
const std::string & | getSPN () |
const std::string & | getName () |
IconType | getIconType () |
std::vector< uint8_t > | getIcon () |
ProfileClass | getClass () |
PolicyRuleMask | getPolicyRule () |
std::string | toString () |
telux::tel::SimProfile::SimProfile | ( | int | profileId, |
ProfileType | profileType, | ||
const std::string & | iccid, | ||
bool | isActive, | ||
const std::string & | nickName, | ||
const std::string & | spn, | ||
const std::string & | name, | ||
IconType | iconType, | ||
std::vector< uint8_t > | icon, | ||
ProfileClass | profileClass, | ||
PolicyRuleMask | policyRuleMask | ||
) |
int telux::tel::SimProfile::getSlotId | ( | ) |
Get slot id associated for this profile
int telux::tel::SimProfile::getProfileId | ( | ) |
Get profile identifier.
ProfileType telux::tel::SimProfile::getType | ( | ) |
Get profile Type.
const std::string& telux::tel::SimProfile::getIccid | ( | ) |
Get profile ICCID.
bool telux::tel::SimProfile::isActive | ( | ) |
Indicates the profile state whether active or not.
const std::string& telux::tel::SimProfile::getNickName | ( | ) |
Get profile nick name.
const std::string& telux::tel::SimProfile::getSPN | ( | ) |
Get profile service provider name.
const std::string& telux::tel::SimProfile::getName | ( | ) |
Get profile name.
IconType telux::tel::SimProfile::getIconType | ( | ) |
Get profile icon type.
std::vector<uint8_t> telux::tel::SimProfile::getIcon | ( | ) |
Get profile icon content.
ProfileClass telux::tel::SimProfile::getClass | ( | ) |
Get profile class.
PolicyRuleMask telux::tel::SimProfile::getPolicyRule | ( | ) |
Get profile policy rules.
std::string telux::tel::SimProfile::toString | ( | ) |
Get the text related informative representation of this object.
class telux::tel::ISimProfileListener |
The interface listens for profile download indication and keep track of download and install progress of profile.
The methods in the listener can be invoked from multiple threads. It is client's responsibility to make sure the implementation is thread safe.
Public Member Functions | |
virtual void | onAddProfileUpdate (SlotId slotId, bool userConsentRequired, DownloadStatus status, uint8_t percentage, DownloadErrorCause cause, PolicyRuleMask mask) |
virtual | ~ISimProfileListener () |
Public Member Functions inherited from telux::common::IServiceStatusListener | |
virtual void | onServiceStatusChange (ServiceStatus status) |
virtual | ~IServiceStatusListener () |
|
virtual |
Destructor of ISimProfileListener
|
virtual |
This function is called when indication about status of profile download and installation comes.
[in] | slotId | Slot on which profile get downloaded and installed. |
[in] | userConsentRequired | User consent required or not. |
[in] | status | ProfileDownloadStatus. |
[in] | percentage | Download and installation percentage. |
[in] | cause | ProfileDownloadErrorCause. |
[in] | mask | PprMask (Profile policy rules Mask) |
class telux::tel::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.
Public Member Functions | |
virtual bool | isSubsystemReady ()=0 |
virtual std::future< bool > | onSubsystemReady ()=0 |
virtual telux::common::Status | addProfile (SlotId slotId, const std::string &activationCode, const std::string &confirmationCode="", bool userConsentSupported=false, common::ResponseCallback callback=nullptr)=0 |
virtual telux::common::Status | deleteProfile (SlotId slotId, int profileId, common::ResponseCallback callback=nullptr)=0 |
virtual telux::common::Status | setProfile (SlotId slotId, int profileId, bool enable=false, common::ResponseCallback callback=nullptr)=0 |
virtual telux::common::Status | updateNickName (SlotId slotId, int profileId, const std::string &nickName, common::ResponseCallback callback=nullptr)=0 |
virtual telux::common::Status | requestProfileList (SlotId slotId, ProfileListResponseCb callback)=0 |
virtual telux::common::Status | requestEid (SlotId slotId, EidResponseCb callback)=0 |
virtual telux::common::Status | provideUserConsent (SlotId slotId, bool userConsent=false, common::ResponseCallback callback=nullptr)=0 |
virtual telux::common::Status | registerListener (std::weak_ptr< ISimProfileListener > listener)=0 |
virtual telux::common::Status | deregisterListener (std::weak_ptr< ISimProfileListener > listener)=0 |
virtual | ~ISimProfileManager () |
|
virtual |
Destructor for ISimProfileManager
|
pure virtual |
Checks if the eUICC subsystem is ready.
|
pure virtual |
Wait for eUICC subsystem to be ready.
|
pure virtual |
Add new profile to eUICC card and download and install the profile on eUICC.
[in] | slotId | Slot identifier corresponding to the card. |
[in] | activationCode | Activation code. |
[in] | confirmationCode | Optional confirmation code required for downloading the profile. |
[in] | userConsentSupported | Optional User consent supported or not. |
[in] | callback | Callback function to get the result of add profile. |
|
pure virtual |
Delete profile from eUICC card.
[in] | slotId | Slot identifier corresponding to the card. |
[in] | profileId | Profile identifier |
[in] | callback | Callback function to get the result of delete profile. |
|
pure virtual |
Enable or disable profile which allows to switch to other profile on eUICC card.
[in] | slotId | Slot identifier corresponding to the card. |
[in] | profileId | Profile identifier. |
[in] | enable | Indicates whether a profile must be enabled or disabled. true - Enable and false - Disable. |
[in] | callback | Callback function to get the result of set profile. |
|
pure virtual |
Update nick name of the profile
[in] | slotId | Slot identifier corresponding to the card. |
[in] | profileId | Profile identifier |
[in] | nickName | New nick name for profile. |
[in] | callback | Callback function to get the result of update nickname. |
|
pure virtual |
Request list of profiles supported by the eUICC card.
[in] | slotId | Slot identifier corresponding to the card. |
[in] | callback | Callback function to get the result of request profile list. |
|
pure virtual |
Request eUICC identifier(EID) for the slot.
[in] | slotId | Slot identifier corresponding to the card. |
[in] | callback | Callback function to get the result of request EID. |
|
pure virtual |
Provide user consent required for downloading and installing profile.
[in] | slotId | Slot identifier corresponding to the card. |
[in] | userConsent | Consent for proļ¬le download and install. True means user consent to download and install. |
[in] | callback | Callback function to get the result of user consent request. |
|
pure virtual |
Register a listener to listen for status of specific events like download and installation of profile on eUICC.
[in] | listener | Pointer of ISimProfileListener object that processes the notification. |
|
pure virtual |
De-register the listener.
[in] | listener | Pointer of ISimProfileListener object that needs to be removed |
using telux::tel::PolicyRuleMask = typedef std::bitset<16> |
16 bit mask that denotes which of the profile policy rules(PPR) defined in Policy Rule Type enum are used.
|
strong |
|
strong |
|
strong |
|
strong |
Indicates profile download status.
|
strong |
Defines profile policy rules(PPR). Each value represents corresponding bit for PprMask bitset.