Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_sms_common.h File Reference
#include "legato.h"
#include "taf_types_common.h"

Go to the source code of this file.

Macros

#define IFGEN_TAF_SMS_PROTOCOL_ID   "309f1ede5d1a6d7e47a5f3a2e7b5af98"
 
#define IFGEN_TAF_SMS_MSG_SIZE   193
 
#define TAF_SMS_SMSC_ADDR_BYTES   28
 
#define TAF_SMS_TIMESTAMP_LEN   20
 
#define TAF_SMS_TIMESTAMP_BYTES   21
 
#define TAF_SMS_TEXT_LEN   160
 
#define TAF_SMS_TEXT_BYTES   161
 
#define TAF_SMS_BINARY_BYTES   140
 
#define TAF_SMS_UCS2_BYTES   140
 
#define TAF_SMS_UCS2_CHARS   70
 
#define TAF_SMS_PDU_PAYLOAD   140
 
#define TAF_SMS_PDU_BYTES   176
 

Typedefs

typedef struct taf_sms_Msg * taf_sms_MsgRef_t
 
typedef struct taf_sms_MsgList * taf_sms_MsgListRef_t
 
typedef struct taf_sms_RxMsgHandler * taf_sms_RxMsgHandlerRef_t
 
typedef struct taf_sms_FullStorageEventHandler * taf_sms_FullStorageEventHandlerRef_t
 
typedef void(* taf_sms_CallbackResultFunc_t) (taf_sms_MsgRef_t msgRef, taf_sms_SendStatus_t status, void *contextPtr)
 
typedef void(* taf_sms_RxMsgHandlerFunc_t) (taf_sms_MsgRef_t msgRef, void *contextPtr)
 
typedef void(* taf_sms_FullStorageHandlerFunc_t) (taf_sms_StorageFullType_t fullType, void *contextPtr)
 

Enumerations

enum  taf_sms_Storage_t {
  TAF_SMS_STORAGE_NONE = 0, TAF_SMS_STORAGE_NV = 1, TAF_SMS_STORAGE_SIM = 2, TAF_SMS_STORAGE_HLOS = 3,
  TAF_SMS_STORAGE_UNKNOWN = 4
}
 
enum  taf_sms_StorageFullType_t {
  TAF_SMS_FULL_UNKNOWN = 0, TAF_SMS_FULL_HLOS_ALERT = 1, TAF_SMS_FULL_HLOS = 2, TAF_SMS_FULL_HLOS_STORE_TO_SIM = 3,
  TAF_SMS_FULL_BOTH_HLOS_AND_SIM = 4, TAF_SMS_FULL_NV = 5, TAF_SMS_FULL_SIM = 6, TAF_SMS_FULL_SIM2 = 7
}
 
enum  taf_sms_Type_t { TAF_SMS_TYPE_TX = 0, TAF_SMS_TYPE_RX = 1, TAF_SMS_TYPE_UNKNOWN = 2 }
 
enum  taf_sms_ReadStatus_t { TAF_SMS_RXSTS_READ = 0, TAF_SMS_RXSTS_UNREAD = 1, TAF_SMS_RXSTS_UNKNOWN = 2 }
 
enum  taf_sms_SendStatus_t {
  TAF_SMS_TXSTS_UNSENT = 0, TAF_SMS_TXSTS_SENDING = 1, TAF_SMS_TXSTS_SENT = 2, TAF_SMS_TXSTS_SENDING_FAILED = 3,
  TAF_SMS_TXSTS_SENDING_TIMEOUT = 4, TAF_SMS_TXSTS_UNKNOWN = 5
}
 
enum  taf_sms_LockStatus_t { TAF_SMS_LKSTS_LOCKED = 0, TAF_SMS_LKSTS_UNLOCKED = 1, TAF_SMS_LKSTS_UNKNOWN = 2 }
 
enum  taf_sms_Format_t {
  TAF_SMS_FORMAT_TEXT = 0, TAF_SMS_FORMAT_BINARY = 1, TAF_SMS_FORMAT_UCS2 = 2, TAF_SMS_FORMAT_PDU = 3,
  TAF_SMS_FORMAT_UNKNOWN = 4
}
 

Functions

LE_SHARED bool ifgen_taf_sms_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_sms_InitCommonData (void)
 
LE_SHARED void ifgen_taf_sms_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_sms_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED taf_sms_MsgListRef_t ifgen_taf_sms_CreateRxMsgList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED void ifgen_taf_sms_DeleteList (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgListRef_t msgListRef)
 
LE_SHARED taf_sms_RxMsgHandlerRef_t ifgen_taf_sms_AddRxMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_RxMsgHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_sms_RemoveRxMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_RxMsgHandlerRef_t handlerRef)
 
LE_SHARED taf_sms_FullStorageEventHandlerRef_t ifgen_taf_sms_AddFullStorageEventHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_FullStorageHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_sms_RemoveFullStorageEventHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_FullStorageEventHandlerRef_t handlerRef)
 
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetFirst (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgListRef_t msgListRef)
 
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetNext (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgListRef_t msgListRef)
 
LE_SHARED taf_sms_SendStatus_t ifgen_taf_sms_GetSendStatus (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED taf_sms_ReadStatus_t ifgen_taf_sms_GetReadStatus (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED taf_sms_LockStatus_t ifgen_taf_sms_GetLockStatus (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_Create (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_sms_SetDestination (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, const char *LE_NONNULL dest)
 
LE_SHARED le_result_t ifgen_taf_sms_SetText (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, const char *LE_NONNULL text)
 
LE_SHARED le_result_t ifgen_taf_sms_SetBinary (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, const uint8_t *binPtr, size_t binSize)
 
LE_SHARED le_result_t ifgen_taf_sms_SetUCS2 (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, const uint16_t *ucs2Ptr, size_t ucs2Size)
 
LE_SHARED le_result_t ifgen_taf_sms_SetPDU (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, const uint8_t *pduPtr, size_t pduSize)
 
LE_SHARED le_result_t ifgen_taf_sms_SetCallback (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, taf_sms_CallbackResultFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_sms_SetPhoneId (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, uint8_t phoneId)
 
LE_SHARED void ifgen_taf_sms_Delete (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_GetPhoneId (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, uint8_t *phoneIdPtr)
 
LE_SHARED le_result_t ifgen_taf_sms_GetSenderTel (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, char *tel, size_t telSize)
 
LE_SHARED le_result_t ifgen_taf_sms_GetText (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, char *text, size_t textSize)
 
LE_SHARED le_result_t ifgen_taf_sms_GetBinary (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, uint8_t *binPtr, size_t *binSizePtr)
 
LE_SHARED le_result_t ifgen_taf_sms_GetUCS2 (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, uint16_t *ucs2Ptr, size_t *ucs2SizePtr)
 
LE_SHARED le_result_t ifgen_taf_sms_GetPDU (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef, uint8_t *pduPtr, size_t *pduSizePtr)
 
LE_SHARED size_t ifgen_taf_sms_GetPDULen (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED taf_sms_Type_t ifgen_taf_sms_GetType (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED taf_sms_Format_t ifgen_taf_sms_GetFormat (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED size_t ifgen_taf_sms_GetUserdataLen (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_Send (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_DeleteFromStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_DeleteAllFromStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_Storage_t storage)
 
LE_SHARED void ifgen_taf_sms_MarkRead (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED void ifgen_taf_sms_MarkUnread (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_LockFromStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_UnlockFromStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_EncryptFromStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_MsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_sms_GetSmsCenterAddress (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, char *addr, size_t addrSize)
 
LE_SHARED le_result_t ifgen_taf_sms_SetSmsCenterAddress (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, const char *LE_NONNULL addr)
 
LE_SHARED le_result_t ifgen_taf_sms_SetPreferredStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_Storage_t prefStorage)
 
LE_SHARED le_result_t ifgen_taf_sms_GetPreferredStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_sms_Storage_t *prefStoragePtr)
 
LE_SHARED le_result_t ifgen_taf_sms_SendPduMsg (le_msg_SessionRef_t _ifgen_sessionRef, const uint8_t *dataPtrPtr, size_t dataPtrSize, uint32_t timeout)
 
LE_SHARED le_result_t ifgen_taf_sms_SendPduMsgEx (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, const uint8_t *dataPtrPtr, size_t dataPtrSize, uint32_t timeout)
 
LE_SHARED le_result_t ifgen_taf_sms_ActivateCellBroadcast (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId)
 
LE_SHARED le_result_t ifgen_taf_sms_DeactivateCellBroadcast (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId)
 
LE_SHARED le_result_t ifgen_taf_sms_AddCellBroadcastIds (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, uint16_t fromId, uint16_t toId)
 
LE_SHARED le_result_t ifgen_taf_sms_RemoveCellBroadcastIds (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, uint16_t fromId, uint16_t toId)
 

Macro Definition Documentation

◆ IFGEN_TAF_SMS_PROTOCOL_ID

#define IFGEN_TAF_SMS_PROTOCOL_ID   "309f1ede5d1a6d7e47a5f3a2e7b5af98"

◆ IFGEN_TAF_SMS_MSG_SIZE

#define IFGEN_TAF_SMS_MSG_SIZE   193

◆ TAF_SMS_SMSC_ADDR_BYTES

#define TAF_SMS_SMSC_ADDR_BYTES   28

SMS center string, including size of address type is 3, size of special chars (quotes, comma, plus) is 4, maximum number of address and null terminator.

◆ TAF_SMS_TIMESTAMP_LEN

#define TAF_SMS_TIMESTAMP_LEN   20

Timestamp string length.

◆ TAF_SMS_TIMESTAMP_BYTES

#define TAF_SMS_TIMESTAMP_BYTES   21

Timestamp string length including the null-terminator.

◆ TAF_SMS_TEXT_LEN

#define TAF_SMS_TEXT_LEN   160

The text message length.

◆ TAF_SMS_TEXT_BYTES

#define TAF_SMS_TEXT_BYTES   161

The text message length including the null-terminator.

◆ TAF_SMS_BINARY_BYTES

#define TAF_SMS_BINARY_BYTES   140

The binary message length.

◆ TAF_SMS_UCS2_BYTES

#define TAF_SMS_UCS2_BYTES   140

The UCS2 message length.

◆ TAF_SMS_UCS2_CHARS

#define TAF_SMS_UCS2_CHARS   70

The UCS2 message characters length.

◆ TAF_SMS_PDU_PAYLOAD

#define TAF_SMS_PDU_PAYLOAD   140

The PDU payload bytes length.

◆ TAF_SMS_PDU_BYTES

#define TAF_SMS_PDU_BYTES   176

The PDU message length. 36 bytes header.

Typedef Documentation

◆ taf_sms_MsgRef_t

typedef struct taf_sms_Msg* taf_sms_MsgRef_t

Reference type for SMS message objects.

◆ taf_sms_MsgListRef_t

typedef struct taf_sms_MsgList* taf_sms_MsgListRef_t

Reference type for SMS message List.

◆ taf_sms_RxMsgHandlerRef_t

typedef struct taf_sms_RxMsgHandler* taf_sms_RxMsgHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_sms_RxMsg'

◆ taf_sms_FullStorageEventHandlerRef_t

typedef struct taf_sms_FullStorageEventHandler* taf_sms_FullStorageEventHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_sms_FullStorageEvent'

◆ taf_sms_CallbackResultFunc_t

typedef void(* taf_sms_CallbackResultFunc_t) (taf_sms_MsgRef_t msgRef, taf_sms_SendStatus_t status, void *contextPtr)

Handler for sending messages.

◆ taf_sms_RxMsgHandlerFunc_t

typedef void(* taf_sms_RxMsgHandlerFunc_t) (taf_sms_MsgRef_t msgRef, void *contextPtr)

Handler for receiving messages.

◆ taf_sms_FullStorageHandlerFunc_t

typedef void(* taf_sms_FullStorageHandlerFunc_t) (taf_sms_StorageFullType_t fullType, void *contextPtr)

Handler for full storage notifications.

Enumeration Type Documentation

◆ taf_sms_Storage_t

Message storage type.

Enumerator
TAF_SMS_STORAGE_NONE 

NONE storage (notify only).

TAF_SMS_STORAGE_NV 

NV storage (not supported).

TAF_SMS_STORAGE_SIM 

SIM storage.

TAF_SMS_STORAGE_HLOS 

HLOS storage.

TAF_SMS_STORAGE_UNKNOWN 

Unknown storage.

◆ taf_sms_StorageFullType_t

Full storage indication type.

To notify a client app with differet storage status, the following notifications will be sent to client with storage full indications.

When preferred storage is set as HLOS:

  • FULL_STORAGE_HLOS_ALERT – HLOS storage reached the alert threshold (currently 80%) of usage.
  • FULL_STORAGE_HLOS – HLOS storage reached 100% usage, there is no free slot.

When preferred storage is set as NV (not supported):

  • FULL_STORAGE_NV – Currently not supported.

When preferred storage is set as SIM:

  • FULL_STORAGE_SIM – SIM storage is full.
Enumerator
TAF_SMS_FULL_UNKNOWN 

Unknown.

TAF_SMS_FULL_HLOS_ALERT 

HLOS storage is going to be full.

TAF_SMS_FULL_HLOS 

HLOS storage is full.

TAF_SMS_FULL_HLOS_STORE_TO_SIM 

HLOS storage is full and message is stored in SIM.

TAF_SMS_FULL_BOTH_HLOS_AND_SIM 

Both HLOS storage and SIM storage are full.

TAF_SMS_FULL_NV 

NV storage is full.

TAF_SMS_FULL_SIM 

SIM storage is full.

TAF_SMS_FULL_SIM2 

SIM2 storage is full.

◆ taf_sms_Type_t

Message type.

Enumerator
TAF_SMS_TYPE_TX 

Tx message.

TAF_SMS_TYPE_RX 

Rx message.

TAF_SMS_TYPE_UNKNOWN 

Unknown type.

◆ taf_sms_ReadStatus_t

Read status type (for Rx message).

Enumerator
TAF_SMS_RXSTS_READ 

Message is read.

TAF_SMS_RXSTS_UNREAD 

Message is unread.

TAF_SMS_RXSTS_UNKNOWN 

Unknown status.

◆ taf_sms_SendStatus_t

Send status type (for Tx message).

Enumerator
TAF_SMS_TXSTS_UNSENT 

Message is unsent.

TAF_SMS_TXSTS_SENDING 

Message is being sent.

TAF_SMS_TXSTS_SENT 

Message is sent.

TAF_SMS_TXSTS_SENDING_FAILED 

Message failed to be sent.

TAF_SMS_TXSTS_SENDING_TIMEOUT 

Message timed out while sending.

TAF_SMS_TXSTS_UNKNOWN 

Unknown status.

◆ taf_sms_LockStatus_t

Lock status type (for Rx message stored in HLOS).

Enumerator
TAF_SMS_LKSTS_LOCKED 

Locked status.

TAF_SMS_LKSTS_UNLOCKED 

Unlocked status.

TAF_SMS_LKSTS_UNKNOWN 

Unknown status.

◆ taf_sms_Format_t

Message format type.

Enumerator
TAF_SMS_FORMAT_TEXT 

Text format.

TAF_SMS_FORMAT_BINARY 

Binary format.

TAF_SMS_FORMAT_UCS2 

UCS2 format.

TAF_SMS_FORMAT_PDU 

PDU format.

TAF_SMS_FORMAT_UNKNOWN 

Unknown.

Function Documentation

◆ ifgen_taf_sms_HasLocalBinding()

LE_SHARED bool ifgen_taf_sms_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_sms_InitCommonData()

LE_SHARED void ifgen_taf_sms_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_sms_CleanupCommonData()

LE_SHARED void ifgen_taf_sms_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_sms_OpenSession()

LE_SHARED le_result_t ifgen_taf_sms_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_sms_CreateRxMsgList()

LE_SHARED taf_sms_MsgListRef_t ifgen_taf_sms_CreateRxMsgList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Creates a message list for accessing messages.

Returns
Created message list reference.

◆ ifgen_taf_sms_DeleteList()

LE_SHARED void ifgen_taf_sms_DeleteList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgListRef_t  msgListRef 
)

Deletes a message list.

Parameters
[in]msgListRefMessage list reference.

◆ ifgen_taf_sms_AddRxMsgHandler()

LE_SHARED taf_sms_RxMsgHandlerRef_t ifgen_taf_sms_AddRxMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_RxMsgHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_sms_RxMsg'

Event for handler usage.

Parameters
[in]handlerPtrHandler for receiving messages.
[in]contextPtr

◆ ifgen_taf_sms_RemoveRxMsgHandler()

LE_SHARED void ifgen_taf_sms_RemoveRxMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_RxMsgHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_sms_RxMsg'

Parameters
[in]handlerRef

◆ ifgen_taf_sms_AddFullStorageEventHandler()

LE_SHARED taf_sms_FullStorageEventHandlerRef_t ifgen_taf_sms_AddFullStorageEventHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_FullStorageHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_sms_FullStorageEvent'

Event for information on full storage notifications.

Parameters
[in]handlerPtrHandler for full storage indications.
[in]contextPtr

◆ ifgen_taf_sms_RemoveFullStorageEventHandler()

LE_SHARED void ifgen_taf_sms_RemoveFullStorageEventHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_FullStorageEventHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_sms_FullStorageEvent'

Parameters
[in]handlerRef

◆ ifgen_taf_sms_GetFirst()

LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetFirst ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgListRef_t  msgListRef 
)

Gets the first message in the given list.

Returns
The first message reference in the message list.
Parameters
[in]msgListRefMessage list reference.

◆ ifgen_taf_sms_GetNext()

LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetNext ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgListRef_t  msgListRef 
)

Gets the next message in the list.

Returns
The next message reference from the message list.
Parameters
[in]msgListRefMessage list reference.

◆ ifgen_taf_sms_GetSendStatus()

LE_SHARED taf_sms_SendStatus_t ifgen_taf_sms_GetSendStatus ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Gets the message's send status.

Returns
The message send status.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_GetReadStatus()

LE_SHARED taf_sms_ReadStatus_t ifgen_taf_sms_GetReadStatus ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Gets the message's read status.

Returns
The message's read status.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_GetLockStatus()

LE_SHARED taf_sms_LockStatus_t ifgen_taf_sms_GetLockStatus ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Gets the message's lock status.

Returns
The message's lock status.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_Create()

LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_Create ( le_msg_SessionRef_t  _ifgen_sessionRef)

Creates a new message to send.

Returns
The created message reference.

◆ ifgen_taf_sms_SetDestination()

LE_SHARED le_result_t ifgen_taf_sms_SetDestination ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
const char *LE_NONNULL  dest 
)

Sets the message's destination phone number.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[in]destDestination number.

◆ ifgen_taf_sms_SetText()

LE_SHARED le_result_t ifgen_taf_sms_SetText ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
const char *LE_NONNULL  text 
)

Sets the message's text.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[in]textText message.

◆ ifgen_taf_sms_SetBinary()

LE_SHARED le_result_t ifgen_taf_sms_SetBinary ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
const uint8_t *  binPtr,
size_t  binSize 
)

Sets the message's binary content.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[in]binPtrBinary data.
[in]binSize

◆ ifgen_taf_sms_SetUCS2()

LE_SHARED le_result_t ifgen_taf_sms_SetUCS2 ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
const uint16_t *  ucs2Ptr,
size_t  ucs2Size 
)

Sets the message's UCS2 content.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[in]ucs2PtrUCS2 message.
[in]ucs2Size

◆ ifgen_taf_sms_SetPDU()

LE_SHARED le_result_t ifgen_taf_sms_SetPDU ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
const uint8_t *  pduPtr,
size_t  pduSize 
)

Sets the message's PDU format.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[in]pduPtrMessage in PDU format.
[in]pduSize

◆ ifgen_taf_sms_SetCallback()

LE_SHARED le_result_t ifgen_taf_sms_SetCallback ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
taf_sms_CallbackResultFunc_t  handlerPtr,
void *  contextPtr 
)

Sets the message's callback function.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_NOT_FOUND – Invalid message.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[in]handlerPtrHandler for sending message.
[in]contextPtr

◆ ifgen_taf_sms_SetPhoneId()

LE_SHARED le_result_t ifgen_taf_sms_SetPhoneId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
uint8_t  phoneId 
)

Sets the phone ID function for the message; phone ID must be 1 or 2 (for DSDA use case).

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[in]phoneIdPhone ID.

◆ ifgen_taf_sms_Delete()

LE_SHARED void ifgen_taf_sms_Delete ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Deletes a message from the message list, if there is no message list reference, it deletes the message from storage.

Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_GetPhoneId()

LE_SHARED le_result_t ifgen_taf_sms_GetPhoneId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
uint8_t *  phoneIdPtr 
)

Gets the message's phone ID (only for the messages stored in the SIM or created by the client).

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_NOT_PERMITTED – Invalid message type.
  • LE_BAD_PARAMETER – Invalid phone ID pointer.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[out]phoneIdPtrPointer to the stored phone ID.

◆ ifgen_taf_sms_GetSenderTel()

LE_SHARED le_result_t ifgen_taf_sms_GetSenderTel ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
char *  tel,
size_t  telSize 
)

Gets the message sender's phone number.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_NOT_PERMITTED – Invalid message type.
  • LE_FAULT – Invalid input string.
  • LE_OVERFLOW – String overflow.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[out]telBuffer to store sender's number.
[in]telSize

◆ ifgen_taf_sms_GetText()

LE_SHARED le_result_t ifgen_taf_sms_GetText ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
char *  text,
size_t  textSize 
)

Gets the message's text.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Invalid input string.
  • LE_OVERFLOW – String overflow.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[out]textBuffer to store message text.
[in]textSize

◆ ifgen_taf_sms_GetBinary()

LE_SHARED le_result_t ifgen_taf_sms_GetBinary ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
uint8_t *  binPtr,
size_t *  binSizePtr 
)

Gets the message's binary data.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Invalid input string.
  • LE_OVERFLOW – String overflow.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[out]binPtrBuffer to store binary data.
[in,out]binSizePtr

◆ ifgen_taf_sms_GetUCS2()

LE_SHARED le_result_t ifgen_taf_sms_GetUCS2 ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
uint16_t *  ucs2Ptr,
size_t *  ucs2SizePtr 
)

Gets the message's UCS2 encoding.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Invalid input string.
  • LE_OVERFLOW – String overflow.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[out]ucs2PtrBuffer to store UCS2 characters.
[in,out]ucs2SizePtr

◆ ifgen_taf_sms_GetPDU()

LE_SHARED le_result_t ifgen_taf_sms_GetPDU ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef,
uint8_t *  pduPtr,
size_t *  pduSizePtr 
)

Gets the message's PDU data.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Invalid input string.
  • LE_OVERFLOW – String overflow.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.
[out]pduPtrBuffer to store PDU data.
[in,out]pduSizePtr

◆ ifgen_taf_sms_GetPDULen()

LE_SHARED size_t ifgen_taf_sms_GetPDULen ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Gets the message's PDU length.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Invalid input string.
  • LE_OVERFLOW – String overflow.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_GetType()

LE_SHARED taf_sms_Type_t ifgen_taf_sms_GetType ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Gets the message's type.

Returns
The message type.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_GetFormat()

LE_SHARED taf_sms_Format_t ifgen_taf_sms_GetFormat ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Gets the message's format.

Returns
The message format.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_GetUserdataLen()

LE_SHARED size_t ifgen_taf_sms_GetUserdataLen ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Gets the message's text length.

Returns
The message's text length.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_Send()

LE_SHARED le_result_t ifgen_taf_sms_Send ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Send the message.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_BAD_PARAMETER – Invalid phone ID.
  • LE_FORMAT_ERROR – Failed to encode message.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_DeleteFromStorage()

LE_SHARED le_result_t ifgen_taf_sms_DeleteFromStorage ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Deletes a message from storage.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_BAD_PARAMETER – Invalid storage.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_DeleteAllFromStorage()

LE_SHARED le_result_t ifgen_taf_sms_DeleteAllFromStorage ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_Storage_t  storage 
)

Deletes all messages from storage.

Note
In the case of HLOS storage, this API only deletes unlocked messages.
Returns
  • LE_BAD_PARAMETER – Invalid storage.
  • LE_FAULT: Failed.
  • LE_OK – Succeeded.
Parameters
[in]storage

◆ ifgen_taf_sms_MarkRead()

LE_SHARED void ifgen_taf_sms_MarkRead ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Marks a message's status as read.

Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_MarkUnread()

LE_SHARED void ifgen_taf_sms_MarkUnread ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Marks a message's status as unread.

Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_LockFromStorage()

LE_SHARED le_result_t ifgen_taf_sms_LockFromStorage ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Marks a message's lock status as locked; the message cannot be deleted from storage.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
  • LE_NOT_PERMITTED – Message is locked or is not stored in HLOS.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_UnlockFromStorage()

LE_SHARED le_result_t ifgen_taf_sms_UnlockFromStorage ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Marks a message's lock status as unlocked; the message can be deleted from storage.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
  • LE_NOT_PERMITTED – Message is not locked or is not stored in HLOS.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_EncryptFromStorage()

LE_SHARED le_result_t ifgen_taf_sms_EncryptFromStorage ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_MsgRef_t  msgRef 
)

Encrypts a message which is stored in HLOS.

Returns
  • LE_NOT_FOUND – Invalid message.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
  • LE_NOT_PERMITTED – Message is not stored in HLOS.
Parameters
[in]msgRefMessage reference.

◆ ifgen_taf_sms_GetSmsCenterAddress()

LE_SHARED le_result_t ifgen_taf_sms_GetSmsCenterAddress ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  phoneId,
char *  addr,
size_t  addrSize 
)

Gets the SMS center address for the specified phone ID.

Returns
  • LE_OVERFLOW – Input buffer len is not enough.
  • LE_FAULT – Internal error.
  • LE_TIMEOUT – Timeout occurred.
  • LE_BAD_PARAMETER – Invalid input.
  • LE_OK – Succeeded.
Parameters
[in]phoneIdPhone ID.
[out]addrBuffer to store SMS center address.
[in]addrSize

◆ ifgen_taf_sms_SetSmsCenterAddress()

LE_SHARED le_result_t ifgen_taf_sms_SetSmsCenterAddress ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  phoneId,
const char *LE_NONNULL  addr 
)

Sets the SMS center address for the specified phone ID.

Returns
  • LE_OVERFLOW – Input buffer len is not enough.
  • LE_FAULT – Internal error.
  • LE_TIMEOUT – Timeout occurred.
  • LE_OK – Succeeded.
Parameters
[in]phoneIdPhone ID.
[in]addrSMS center address.

◆ ifgen_taf_sms_SetPreferredStorage()

LE_SHARED le_result_t ifgen_taf_sms_SetPreferredStorage ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_Storage_t  prefStorage 
)

Sets the preferred SMS storage place.

Returns
  • LE_FAULT – Failed.
  • LE_TIMEOUT – Timeout occurred.
  • LE_UNSUPPORTED – Input storage is not suppported.
  • LE_BAD_PARAMETER – Invalid input.
  • LE_OK – Succeeded.
Parameters
[in]prefStoragePreferred storage type.

◆ ifgen_taf_sms_GetPreferredStorage()

LE_SHARED le_result_t ifgen_taf_sms_GetPreferredStorage ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_sms_Storage_t prefStoragePtr 
)

Gets the preferred SMS storage place.

Returns
  • LE_FAULT – Failed.
  • LE_TIMEOUT – Timeout occurred.
  • LE_OK – Succeeded.
Parameters
[out]prefStoragePtrPreferred storage type.

◆ ifgen_taf_sms_SendPduMsg()

LE_SHARED le_result_t ifgen_taf_sms_SendPduMsg ( le_msg_SessionRef_t  _ifgen_sessionRef,
const uint8_t *  dataPtrPtr,
size_t  dataPtrSize,
uint32_t  timeout 
)

Sends a PDU message.

Returns
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]dataPtrPtrMessage in PDU format.
[in]dataPtrSize
[in]timeoutTimeout value message sent.

◆ ifgen_taf_sms_SendPduMsgEx()

LE_SHARED le_result_t ifgen_taf_sms_SendPduMsgEx ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  phoneId,
const uint8_t *  dataPtrPtr,
size_t  dataPtrSize,
uint32_t  timeout 
)

Sends a PDU message with phone ID.

Returns
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]phoneIdPhone ID.
[in]dataPtrPtrMessage in PDU format.
[in]dataPtrSize
[in]timeoutTimeout value message sent.

◆ ifgen_taf_sms_ActivateCellBroadcast()

LE_SHARED le_result_t ifgen_taf_sms_ActivateCellBroadcast ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  phoneId 
)

Activates cell broadcast for the specified phone ID.

Returns
  • LE_TIMEOUT – Timeout occurred.
  • LE_FAULT – Failed.
  • LE_OK – Succeeded.
Parameters
[in]phoneIdPhone ID.

◆ ifgen_taf_sms_DeactivateCellBroadcast()

LE_SHARED le_result_t ifgen_taf_sms_DeactivateCellBroadcast ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  phoneId 
)

Deactivates cell broadcast for the specified phone ID.

Returns
  • LE_FAULT – Failed.
  • LE_TIMEOUT – Timeout occurred.
  • LE_OK – Succeeded.
Parameters
[in]phoneIdPhone ID.

◆ ifgen_taf_sms_AddCellBroadcastIds()

LE_SHARED le_result_t ifgen_taf_sms_AddCellBroadcastIds ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  phoneId,
uint16_t  fromId,
uint16_t  toId 
)

Adds cell broadcast message range of identifier for the specified phone ID.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_TIMEOUT – Timeout occurred.
  • LE_FAULT – Internal error.
  • LE_OK – Succceeded.
Parameters
[in]phoneIdPhone ID.
[in]fromIdStarting point of the filter.
[in]toIdEnding point of the filter.

◆ ifgen_taf_sms_RemoveCellBroadcastIds()

LE_SHARED le_result_t ifgen_taf_sms_RemoveCellBroadcastIds ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  phoneId,
uint16_t  fromId,
uint16_t  toId 
)

Removes cell broadcast range of message identifiers for the specified phone ID.

Returns
  • LE_BAD_PARAMETER – Invalid input.
  • LE_TIMEOUT – Timeout occurred.
  • LE_FAULT – Internal error.
  • LE_OK – Succceeded.
Parameters
[in]phoneIdPhone ID.
[in]fromIdStarting point of the range.
[in]toIdEnding point of the range.