Telematics SDK - Interface Specification
v1.37.0
|
Data Structures | |
struct | telux::tel::MessageAttributes |
Contains structure of message attributes like encoding type, number of segments, characters left in last segment. More... | |
class | telux::tel::SmsMessage |
A Short Message Service message. More... | |
class | telux::tel::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 | telux::tel::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 | telux::tel::ISmscAddressCallback |
Enumerations | |
enum | telux::tel::SmsEncoding { telux::tel::SmsEncoding::GSM7, telux::tel::SmsEncoding::GSM8, telux::tel::SmsEncoding::UCS2, telux::tel::SmsEncoding::UNKNOWN } |
Specifies the encoding of the SMS message. More... | |
This section contains APIs related to Sending and Receiving SMS.
struct telux::tel::MessageAttributes |
Contains structure of message attributes like encoding type, number of segments, characters left in last segment.
Data Fields | ||
---|---|---|
SmsEncoding | encoding |
Data encoding type |
int | numberOfSegments |
Number of segments |
int | segmentSize |
Max size of each segment |
int | numberOfCharsLeftInLastSegment |
characters left in last segment |
class telux::tel::SmsMessage |
A Short Message Service message.
Public Member Functions | |
SmsMessage (std::string text, std::string sender, std::string receiver, SmsEncoding encoding, std::string pdu) | |
const std::string & | getText () const |
const std::string & | getSender () const |
const std::string & | getReceiver () const |
SmsEncoding | getEncoding () const |
const std::string & | getPdu () const |
const std::string | toString () const |
telux::tel::SmsMessage::SmsMessage | ( | std::string | text, |
std::string | sender, | ||
std::string | receiver, | ||
SmsEncoding | encoding, | ||
std::string | pdu | ||
) |
const std::string& telux::tel::SmsMessage::getText | ( | ) | const |
Get the message body.
const std::string& telux::tel::SmsMessage::getSender | ( | ) | const |
Get the originating address (sender) of this SMS message.
const std::string& telux::tel::SmsMessage::getReceiver | ( | ) | const |
Get the destination address (receiver) of this SMS message.
SmsEncoding telux::tel::SmsMessage::getEncoding | ( | ) | const |
Get encoding used for this SMS message.
const std::string& telux::tel::SmsMessage::getPdu | ( | ) | const |
Get the raw PDU for the message.
const std::string telux::tel::SmsMessage::toString | ( | ) | const |
Get the text related informative representation of this object.
class telux::tel::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.
Public Member Functions | |
virtual telux::common::Status | sendSms (const std::string &message, const std::string &receiverAddress, std::shared_ptr< telux::common::ICommandResponseCallback > callback=nullptr, std::shared_ptr< telux::common::ICommandResponseCallback > deliveryCallback=nullptr)=0 |
virtual telux::common::Status | requestSmscAddress (std::shared_ptr< ISmscAddressCallback > callback=nullptr)=0 |
virtual telux::common::Status | setSmscAddress (const std::string &smscAddress, telux::common::ResponseCallback callback=nullptr)=0 |
virtual MessageAttributes | calculateMessageAttributes (const std::string &message)=0 |
virtual int | getPhoneId ()=0 |
virtual telux::common::Status | registerListener (std::weak_ptr< ISmsListener > listener)=0 |
virtual telux::common::Status | removeListener (std::weak_ptr< ISmsListener > listener)=0 |
virtual | ~ISmsManager () |
|
virtual |
|
pure virtual |
Send SMS to destination address. Only support UCS2 format, GSM 7 bit default alphabet and does not support National language shift tables.
[in] | message | Message or payload text to be sent |
[in] | receiverAddress | Receiver or destination address |
[in] | sentCallback | Optional callback pointer to get the response of send SMS request, This callback gives possible error codes. |
[in] | deliveryCallback | Optional callback pointer to get message delivery status |
|
pure virtual |
Request for Short Messaging Service Center (SMSC) Address. Purpose of SMSC is to store, forward, convert and deliver Short Message Service (SMS) messages.
[in] | callback | Optional callback pointer to get the response of Smsc address request |
|
pure virtual |
Sets the Short Message Service Center(SMSC) address on the device.
This will change the SMSC address for all the SMS messages sent from any app.
[in] | smscAddress | SMSC address |
[in] | callback | Optional callback pointer to get the response of set SMSC address |
|
pure virtual |
Calculate message attributes for the given message.
[in] | message | Message to send |
|
pure virtual |
Get associated phone id for this SMSManager.
|
pure virtual |
Register a listener for Sms events
[in] | listener | Pointer to ISmsListener object which receives event corresponding to SMS |
|
pure virtual |
Remove a previously added listener.
[in] | listener | Pointer to ISmsListener object |
class telux::tel::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.
The methods in listener can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | onIncomingSms (int phoneId, std::shared_ptr< SmsMessage > message) |
virtual | ~ISmsListener () |
Public Member Functions inherited from telux::common::IServiceStatusListener | |
virtual void | onServiceStatusChange (ServiceStatus status) |
virtual | ~IServiceStatusListener () |
|
virtual |
|
virtual |
This function is called when device receives an incoming message
[in] | phoneId | Unique identifier per phone |
[in] | SmsMessage | Pointer to SmsMessage object |
class telux::tel::ISmscAddressCallback |
Interface for SMS callback object. Client needs to implement this interface to get single shot responses for send SMS.
The methods in callback can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | smscAddressResponse (const std::string &address, telux::common::ErrorCode error)=0 |
Public Member Functions inherited from telux::common::ICommandCallback | |
virtual | ~ICommandCallback () |
|
pure virtual |
This function is called with the response to the Smsc address request.
[in] | address | Smsc address |
[in] | error | ErrorCode |
|
strong |