le_smsInbox1_interface.h
Go to the documentation of this file.
33 * In fact, at device's startup or when a SIM is inserted, the SIM content is copied into the "Inbox34 * Message Storage" folder allocated in the root file system of the device. Then, the process frees40 * This process is the same when the SMS message storage is the device's storage area (ME - Mobile47 * (cf. @subpage le_smsInbox_configdb section). This way, the message box contents will be kept up67 * @note By default, smsInboxService starts manually. To start it automatically, the user can remove120 * le_smsInbox1_GetMsgLen(), le_smsInbox1_GetText(), le_smsInbox1_GetBinary(), le_smsInbox1_GetPdu().122 * To finish, you can also modify the received status of a message with le_smsInbox1_MarkRead() and133 * Use the API le_smsInbox1_Close() to close a message box (the message box is still exist and can be146 * The configuration database for the SMS Inbox Service is stored in the @c smsInboxService config161 * The application name is given by the API name provided into the Components.cdef, both must be the164 * @todo: Give an indication of memory consumption for 1 message, including the file system overhead189 //--------------------------------------------------------------------------------------------------193 //--------------------------------------------------------------------------------------------------196 //--------------------------------------------------------------------------------------------------199 * Connect the current client thread to the service providing this API. Block until the service is202 * For each thread that wants to use this API, either ConnectService or TryConnectService must be203 * called before any other functions in this API. Normally, ConnectService is automatically called208 //--------------------------------------------------------------------------------------------------214 //--------------------------------------------------------------------------------------------------217 * Try to connect the current client thread to the service providing this API. Return with an error220 * For each thread that wants to use this API, either ConnectService or TryConnectService must be221 * called before any other functions in this API. Normally, ConnectService is automatically called230 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).233 //--------------------------------------------------------------------------------------------------239 //--------------------------------------------------------------------------------------------------243 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants246 //--------------------------------------------------------------------------------------------------253 //--------------------------------------------------------------------------------------------------259 * longer a connection to the service, and the functions in this API can't be used. For details, see264 //--------------------------------------------------------------------------------------------------271 //--------------------------------------------------------------------------------------------------275 //--------------------------------------------------------------------------------------------------278 //--------------------------------------------------------------------------------------------------282 //--------------------------------------------------------------------------------------------------285 //--------------------------------------------------------------------------------------------------289 //--------------------------------------------------------------------------------------------------293 //--------------------------------------------------------------------------------------------------297 //--------------------------------------------------------------------------------------------------301 //--------------------------------------------------------------------------------------------------306 //--------------------------------------------------------------------------------------------------308 (315 //--------------------------------------------------------------------------------------------------322 //--------------------------------------------------------------------------------------------------328 //--------------------------------------------------------------------------------------------------333 //--------------------------------------------------------------------------------------------------340 //--------------------------------------------------------------------------------------------------347 //--------------------------------------------------------------------------------------------------356 //--------------------------------------------------------------------------------------------------360 //--------------------------------------------------------------------------------------------------367 //--------------------------------------------------------------------------------------------------373 //--------------------------------------------------------------------------------------------------380 //--------------------------------------------------------------------------------------------------392 //--------------------------------------------------------------------------------------------------403 //--------------------------------------------------------------------------------------------------414 //--------------------------------------------------------------------------------------------------421 //--------------------------------------------------------------------------------------------------430 //--------------------------------------------------------------------------------------------------441 //--------------------------------------------------------------------------------------------------451 //--------------------------------------------------------------------------------------------------465 //--------------------------------------------------------------------------------------------------472 //--------------------------------------------------------------------------------------------------479 //--------------------------------------------------------------------------------------------------490 //--------------------------------------------------------------------------------------------------501 //--------------------------------------------------------------------------------------------------512 //--------------------------------------------------------------------------------------------------523 //--------------------------------------------------------------------------------------------------536 //--------------------------------------------------------------------------------------------------547 //--------------------------------------------------------------------------------------------------555 //--------------------------------------------------------------------------------------------------562 //--------------------------------------------------------------------------------------------------570 //--------------------------------------------------------------------------------------------------577 //--------------------------------------------------------------------------------------------------579 * allow to know whether the message has been read or not. The message status is tied to the client584 * @note If the caller is passing a bad message reference into this function, it is a fatal error,587 //--------------------------------------------------------------------------------------------------594 //--------------------------------------------------------------------------------------------------598 * @note If the caller is passing a bad message reference into this function, it is a fatal error,601 //--------------------------------------------------------------------------------------------------608 //--------------------------------------------------------------------------------------------------612 * @note If the caller is passing a bad message reference into this function, it is a fatal error,615 //--------------------------------------------------------------------------------------------------le_result_t le_smsInbox1_GetPdu(uint32_t msgId, uint8_t *pduPtr, size_t *pduSizePtr)le_result_t le_smsInbox1_GetText(uint32_t msgId, char *text, size_t textSize)void le_smsInbox1_RemoveRxMessageHandler(le_smsInbox1_RxMessageHandlerRef_t handlerRef)uint32_t le_smsInbox1_GetFirst(le_smsInbox1_SessionRef_t sessionRef)le_smsInbox1_SessionRef_t le_smsInbox1_Open(void)size_t le_smsInbox1_GetMsgLen(uint32_t msgId)uint32_t le_smsInbox1_GetNext(le_smsInbox1_SessionRef_t sessionRef)void le_smsInbox1_DeleteMsg(uint32_t msgId)le_smsInbox1_RxMessageHandlerRef_t le_smsInbox1_AddRxMessageHandler(le_smsInbox1_RxMessageHandlerFunc_t handlerPtr, void *contextPtr)void le_smsInbox1_SetServerDisconnectHandler(le_smsInbox1_DisconnectHandler_t disconnectHandler, void *contextPtr)le_result_t le_smsInbox1_GetImsi(uint32_t msgId, char *imsi, size_t imsiSize)void le_smsInbox1_ConnectService(void)le_sms_Format_t le_smsInbox1_GetFormat(uint32_t msgId)bool le_smsInbox1_IsUnread(uint32_t msgId)le_result_t le_smsInbox1_GetBinary(uint32_t msgId, uint8_t *binPtr, size_t *binSizePtr)le_result_t le_smsInbox1_TryConnectService(void)void le_smsInbox1_MarkUnread(uint32_t msgId)struct le_smsInbox1_Session * le_smsInbox1_SessionRef_tDefinition: le_smsInbox1_interface.h:290le_result_t le_smsInbox1_GetTimeStamp(uint32_t msgId, char *timestamp, size_t timestampSize)void le_smsInbox1_DisconnectService(void)void le_smsInbox1_MarkRead(uint32_t msgId)void(* le_smsInbox1_DisconnectHandler_t)(void *)Definition: le_smsInbox1_interface.h:194void le_smsInbox1_Close(le_smsInbox1_SessionRef_t sessionRef)struct le_smsInbox1_RxMessageHandler * le_smsInbox1_RxMessageHandlerRef_tDefinition: le_smsInbox1_interface.h:298void(* le_smsInbox1_RxMessageHandlerFunc_t)(uint32_t msgId, void *contextPtr)Definition: le_smsInbox1_interface.h:308le_result_t le_smsInbox1_GetSenderTel(uint32_t msgId, char *tel, size_t telSize)