Telematics SDK - Interface Specification
v1.21.0
|
Data Structures | |
class | telux::tel::ISubscription |
Subscription returns information about network operator subscription details pertaining to a SIM card. More... | |
class | telux::tel::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 | telux::tel::ISubscriptionManager |
This section contains APIs related to Subscription Management.
class telux::tel::ISubscription |
Subscription returns information about network operator subscription details pertaining to a SIM card.
Public Member Functions | |
virtual std::string | getCarrierName ()=0 |
virtual std::string | getIccId ()=0 |
virtual int | getMcc ()=0 |
virtual int | getMnc ()=0 |
virtual std::string | getPhoneNumber ()=0 |
virtual int | getSlotId ()=0 |
virtual std::string | getImsi ()=0 |
virtual | ~ISubscription () |
|
virtual |
|
pure virtual |
Retrieves the name of the carrier on which this subscription is made.
|
pure virtual |
Retrieves the SIM's ICCID (Integrated Chip ID) - i.e SIM Serial Number.
|
pure virtual |
Retrieves the mobile country code of the carrier to which the phone is connected.
|
pure virtual |
Retrieves the mobile network code of the carrier to which phone is connected.
|
pure virtual |
Retrieves the phone number for the SIM subscription.
|
pure virtual |
Retrieves SIM Slot index for the SIM pertaining to this subscription object.
|
pure virtual |
Retrieves IMSI (International Mobile Subscriber Identity) for the SIM. This will have home network MCC and MNC values.
class telux::tel::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.
Public Member Functions | |
virtual void | onSubscriptionInfoChanged (std::shared_ptr< ISubscription > subscription) |
virtual void | onNumberOfSubscriptionsChanged (int count) |
virtual | ~ISubscriptionListener () |
|
virtual |
|
virtual |
This function is called whenever there is a change in Subscription details.
[in] | subscription | Pointer to ISubscription Object. |
|
virtual |
This function called whenever there is a change in the subscription count. for example when a new subscription is discovered or an existing subscription goes away when SIM is inserted or removed respectively.
[in] | count | count of subscription |
class telux::tel::ISubscriptionManager |
Public Member Functions | |
virtual bool | isSubsystemReady ()=0 |
virtual std::future< bool > | onSubsystemReady ()=0 |
virtual std::shared_ptr < ISubscription > | getSubscription (int slotId=DEFAULT_SLOT_ID, telux::common::Status *status=nullptr)=0 |
virtual std::vector < std::shared_ptr < ISubscription > > | getAllSubscriptions (telux::common::Status *status=nullptr)=0 |
virtual telux::common::Status | registerListener (std::weak_ptr< ISubscriptionListener > listener)=0 |
virtual telux::common::Status | removeListener (std::weak_ptr< ISubscriptionListener > listener)=0 |
virtual | ~ISubscriptionManager () |
|
virtual |
|
pure virtual |
Checks the status of SubscriptionManager and returns the result.
|
pure virtual |
Wait for Subscription subsystem to be ready.
|
pure virtual |
Get Subscription details of the SIM in the given SIM slot.
[in] | slotId | Slot id corresponding to the subscription. |
[out] | status | Status of getSubscription i.e. success or suitable status code. |
|
pure virtual |
Get all the subscription details of the device.
[out] | status | Status of getAllSubscriptions i.e. success or suitable status code. |
|
pure virtual |
Register a listener for Subscription events.
[in] | listener | Pointer to ISubscriptionListener object that processes the notification. |
|
pure virtual |
Remove a previously added listener.
[in] | listener | Pointer to ISubscriptionListener object that needs to be removed. |