le_smsInbox1_interface.h
Go to the documentation of this file.
31 * In fact, at device's startup or when a SIM is inserted, the SIM content is copied into the "Inbox32 * Message Storage" folder allocated in the root file system of the device. Then, the process frees38 * This process is the same when the SMS message storage is the device's storage area (ME - Mobile45 * (cf. @subpage le_smsInbox_configdb section). This way, the message box contents will be kept up65 * @note By default, smsInboxService starts manually. To start it automatically, the user can remove118 * le_smsInbox1_GetMsgLen(), le_smsInbox1_GetText(), le_smsInbox1_GetBinary(), le_smsInbox1_GetPdu().120 * To finish, you can also modify the received status of a message with le_smsInbox1_MarkRead() and131 * Use the API le_smsInbox1_Close() to close a message box (the message box is still exist and can be144 * The configuration database for the SMS Inbox Service is stored in the @c smsInboxService config159 * The application name is given by the API name provided into the Components.cdef, both must be the162 * @todo: Give an indication of memory consumption for 1 message, including the file system overhead187 //--------------------------------------------------------------------------------------------------190 * Connect the current client thread to the service providing this API. Block until the service is193 * For each thread that wants to use this API, either ConnectService or TryConnectService must be194 * called before any other functions in this API. Normally, ConnectService is automatically called199 //--------------------------------------------------------------------------------------------------205 //--------------------------------------------------------------------------------------------------208 * Try to connect the current client thread to the service providing this API. Return with an error211 * For each thread that wants to use this API, either ConnectService or TryConnectService must be212 * called before any other functions in this API. Normally, ConnectService is automatically called219 * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.220 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).223 //--------------------------------------------------------------------------------------------------229 //--------------------------------------------------------------------------------------------------235 * longer a connection to the service, and the functions in this API can't be used. For details, see240 //--------------------------------------------------------------------------------------------------247 //--------------------------------------------------------------------------------------------------251 //--------------------------------------------------------------------------------------------------255 //--------------------------------------------------------------------------------------------------259 //--------------------------------------------------------------------------------------------------263 //--------------------------------------------------------------------------------------------------267 //--------------------------------------------------------------------------------------------------271 //--------------------------------------------------------------------------------------------------275 //--------------------------------------------------------------------------------------------------279 //--------------------------------------------------------------------------------------------------288 //--------------------------------------------------------------------------------------------------290 (295 //--------------------------------------------------------------------------------------------------302 //--------------------------------------------------------------------------------------------------308 //--------------------------------------------------------------------------------------------------313 //--------------------------------------------------------------------------------------------------320 //--------------------------------------------------------------------------------------------------326 //--------------------------------------------------------------------------------------------------336 //--------------------------------------------------------------------------------------------------340 //--------------------------------------------------------------------------------------------------347 //--------------------------------------------------------------------------------------------------353 //--------------------------------------------------------------------------------------------------360 //--------------------------------------------------------------------------------------------------372 //--------------------------------------------------------------------------------------------------385 //--------------------------------------------------------------------------------------------------396 //--------------------------------------------------------------------------------------------------403 //--------------------------------------------------------------------------------------------------412 //--------------------------------------------------------------------------------------------------425 //--------------------------------------------------------------------------------------------------435 //--------------------------------------------------------------------------------------------------451 //--------------------------------------------------------------------------------------------------458 //--------------------------------------------------------------------------------------------------465 //--------------------------------------------------------------------------------------------------476 //--------------------------------------------------------------------------------------------------489 //--------------------------------------------------------------------------------------------------500 //--------------------------------------------------------------------------------------------------513 //--------------------------------------------------------------------------------------------------526 //--------------------------------------------------------------------------------------------------539 //--------------------------------------------------------------------------------------------------547 //--------------------------------------------------------------------------------------------------554 //--------------------------------------------------------------------------------------------------562 //--------------------------------------------------------------------------------------------------569 //--------------------------------------------------------------------------------------------------571 * allow to know whether the message has been read or not. The message status is tied to the client576 * @note If the caller is passing a bad message reference into this function, it is a fatal error,579 //--------------------------------------------------------------------------------------------------586 //--------------------------------------------------------------------------------------------------590 * @note If the caller is passing a bad message reference into this function, it is a fatal error,593 //--------------------------------------------------------------------------------------------------600 //--------------------------------------------------------------------------------------------------604 * @note If the caller is passing a bad message reference into this function, it is a fatal error,607 //--------------------------------------------------------------------------------------------------void le_smsInbox1_RemoveRxMessageHandler(le_smsInbox1_RxMessageHandlerRef_t addHandlerRef)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)le_result_t le_smsInbox1_GetPdu(uint32_t msgId, uint8_t *pduPtr, size_t *pduNumElementsPtr)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_ConnectService(void)void(* le_smsInbox1_RxMessageHandlerFunc_t)(uint32_t msgId, void *contextPtr)Definition: le_smsInbox1_interface.h:290le_sms_Format_t le_smsInbox1_GetFormat(uint32_t msgId)bool le_smsInbox1_IsUnread(uint32_t msgId)le_result_t le_smsInbox1_TryConnectService(void)le_result_t le_smsInbox1_GetTimeStamp(uint32_t msgId, char *timestamp, size_t timestampNumElements)void le_smsInbox1_MarkUnread(uint32_t msgId)le_result_t le_smsInbox1_GetBinary(uint32_t msgId, uint8_t *binPtr, size_t *binNumElementsPtr)struct le_smsInbox1_Session * le_smsInbox1_SessionRef_tDefinition: le_smsInbox1_interface.h:252void le_smsInbox1_DisconnectService(void)le_result_t le_smsInbox1_GetSenderTel(uint32_t msgId, char *tel, size_t telNumElements)void le_smsInbox1_MarkRead(uint32_t msgId)le_result_t le_smsInbox1_GetImsi(uint32_t msgId, char *imsi, size_t imsiNumElements)le_result_t le_smsInbox1_GetText(uint32_t msgId, char *text, size_t textNumElements)void le_smsInbox1_Close(le_smsInbox1_SessionRef_t sessionRef)struct le_smsInbox1_RxMessageHandler * le_smsInbox1_RxMessageHandlerRef_tDefinition: le_smsInbox1_interface.h:276