2 * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 ///////////////////////////////////////////////////////////////////////////////
18 /// \ingroup tag_NSFramework
19 /// \brief This file provides framework's API which are used by system services.
23 ///////////////////////////////////////////////////////////////////////////////
26 * @file frameworkunified_framework_system_if.h
27 * @brief \~english This file provides framework's API which are used by system services.
30 /** @addtogroup BaseSystem
33 /** @addtogroup native_service
37 /** @addtogroup framework_unified
38 * @ingroup native_service
41 /** @addtogroup framework
42 * @ingroup native_service
45 #ifndef __FRAMEWORKUNIFIED_NATIVESERVICES_INC_FRAMEWORK_FRAMEWORKUNIFIED_FRAMEWORK_SYSTEM_IF_H__ // NOLINT (build/header_guard)
46 #define __FRAMEWORKUNIFIED_NATIVESERVICES_INC_FRAMEWORK_FRAMEWORKUNIFIED_FRAMEWORK_SYSTEM_IF_H__
48 #include <native_service/frameworkunified_types.h>
50 /////////////////////////////////////////////////////////////////////////////////////
51 /// \ingroup FrameworkunifiedNPClearPersistedData
52 /// \~english @par Summary
53 /// API to delete all the persistent files and notification data from persistent memory
54 /// related to NS_NPS.
55 /// Note: This API is only to be used HMI service.
56 /// This API should not be used by the other application.
57 /// \~english @param [in] hApp
58 /// hApp - Handle to the Framework
61 /// \~english @param [in] eFrameworkunifiedClearPersistenceScope
62 /// eFrameworkunifiedClearPersistenceScope - specifies what data to delete from persistent memory
64 /// eFrameworkunifiedClearPersistenceScope EFrameworkunifiedClearPersistence enum
66 /// typedef enum _EFrameworkunifiedClearPersistence {
67 /// eFrameworkunifiedClearAllData = 0, ///< clears all the data in persistence memory for all users
68 /// ///< (currently only this enum value is supported.)
69 /// eFrameworkunifiedClearAllApplicationData, ///< clears all the data(files, folders) related to all application for all
71 /// eFrameworkunifiedClearAllNotificationData, ///< clears all the notification data related to all application for all users
72 /// eFrameworkunifiedClearCurrentUserData, ///< clears all the data in persistence memory for current users
73 /// eFrameworkunifiedClearCurrentUserApplicationData, ///< clears all the data(files, folders) related to all application for
75 /// eFrameworkunifiedClearCurrentUserNotificationData ///< clears all the notification data related to all application for
77 /// } EFrameworkunifiedClearPersistence;
79 /// \~english @retval EFrameworkunifiedStatus
81 /// eFrameworkunifiedStatusOK
82 /// eFrameworkunifiedStatusNullPointer
83 /// eFrameworkunifiedStatusInvldParam
84 /// \~english @par Preconditions
86 /// \~english @par Change of the internal state
87 /// - The internal state is not changed.
88 /// \~english @par Causes of failures
89 /// - If input parameter Framework handler is invalid. [eFrameworkunifiedStatusNullPointer]
90 /// - If communicate handler of NPPService is NULL. [eFrameworkunifiedStatusNullPointer]
91 /// - Function NPClearPersistedData return invalid parameter. [eFrameworkunifiedStatusInvldParam]
92 /// \~english @par Classification
94 /// \~english @par Type
96 /// \~english @par Detail
97 /// API to delete all the persistent files and notification data from persistent memory
98 /// related to NS_NPS.
99 /// Note: This API is only to be used HMI service.
100 /// This API should not be used by the other application.
101 /// \~english @see None
102 ////////////////////////////////////////////////////////////////////////////////////
103 EFrameworkunifiedStatus FrameworkunifiedNPClearPersistedData(HANDLE hApp, EFrameworkunifiedClearPersistence eFrameworkunifiedClearPersistenceScope = eFrameworkunifiedClearAllData);
105 #endif /* __FRAMEWORKUNIFIED_NATIVESERVICES_INC_FRAMEWORK_FRAMEWORKUNIFIED_FRAMEWORK_SYSTEM_IF_H__ */ // NOLINT (build/header_guard)
106 /**@}*/ // end of framework
107 /**@}*/ // end of framework_unified
108 /**@}*/ // end of native_service
109 /**@}*/ // end of BaseSystem