interfaces/modemServices/c/le_sms.h

Go to the documentation of this file.

#ifndef LEGATO_SMS_OPS_INCLUDE_GUARD
#define LEGATO_SMS_OPS_INCLUDE_GUARD

#include "legato.h"
#include "le_mdm_defs.h"


//--------------------------------------------------------------------------------------------------
// Other new type definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sms_Msg* le_sms_msg_Ref_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sms_msg_List* le_sms_msg_ListRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sms_msg_RxMessageHandler* le_sms_msg_RxMessageHandlerRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void(*le_sms_msg_RxMessageHandlerFunc_t)
(
    le_sms_msg_Ref_t  msgRef,
    void*             contextPtr
);


//--------------------------------------------------------------------------------------------------
// APIs.
//--------------------------------------------------------------------------------------------------


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_msg_Ref_t le_sms_msg_Create
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_msg_Delete
(
    le_sms_msg_Ref_t  msgRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_msg_Format_t le_sms_msg_GetFormat
(
    le_sms_msg_Ref_t   msgRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_SetDestination
(
    le_sms_msg_Ref_t  msgRef,  
    const char*       destPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_GetSenderTel
(
    le_sms_msg_Ref_t msgRef,  
    char*            telPtr,  
    size_t           len      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_GetTimeStamp
(
    le_sms_msg_Ref_t msgRef,       
    char*            timestampPtr, 


    size_t           len           
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_sms_msg_GetUserdataLen
(
    le_sms_msg_Ref_t msgRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_sms_msg_GetPDULen
(
    le_sms_msg_Ref_t msgRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_SetText
(
    le_sms_msg_Ref_t      msgRef, 
    const char*           textPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_SetBinary
(
    le_sms_msg_Ref_t  msg,    
    const uint8_t*    binPtr, 
    size_t            len     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_SetPDU
(
    le_sms_msg_Ref_t  msgRef, 
    const uint8_t*    pduPtr, 
    size_t            len     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_GetText
(
    le_sms_msg_Ref_t msgRef,  
    char*            textPtr, 
    size_t           len      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_GetBinary
(
    le_sms_msg_Ref_t msgRef, 
    uint8_t*         binPtr, 
    size_t*          lenPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_GetPDU
(
    le_sms_msg_Ref_t msgRef, 
    uint8_t*         pduPtr, 
    size_t*          lenPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_msg_RxMessageHandlerRef_t le_sms_msg_AddRxMessageHandler
(
    le_sms_msg_RxMessageHandlerFunc_t handlerFuncPtr, 

    void*                              contextPtr      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_msg_RemoveRxMessageHandler
(
    le_sms_msg_RxMessageHandlerRef_t   handlerRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_Send
(
    le_sms_msg_Ref_t    msgRef         
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_msg_DeleteFromStorage
(
    le_sms_msg_Ref_t msgRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_msg_ListRef_t le_sms_msg_CreateRxMsgList
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_msg_DeleteList
(
    le_sms_msg_ListRef_t     msgListRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_msg_Ref_t le_sms_msg_GetFirst
(
    le_sms_msg_ListRef_t        msgListRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_msg_Ref_t le_sms_msg_GetNext
(
    le_sms_msg_ListRef_t        msgListRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_msg_Status_t le_sms_msg_GetStatus
(
    le_sms_msg_Ref_t      msgRef        
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_msg_MarkRead
(
    le_sms_msg_Ref_t    msgRef         
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_msg_MarkUnread
(
    le_sms_msg_Ref_t    msgRef         
);



#endif // LEGATO_SMS_OPS_INCLUDE_GUARD