2 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
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.
18 * @file FSecPrivacyInfo.h
19 * @brief This is the header file for the %PrivacyInfo class.
21 * This header file contains the declarations of the %PrivacyInfo class.
24 #ifndef _FSEC_PRIVACY_INFO_H_
25 #define _FSEC_PRIVACY_INFO_H_
27 #include <FBaseObject.h>
29 namespace Tizen { namespace Security
34 * @brief This class represents the privacy information.
38 * @final This class is not intended for extension.
40 * The %PrivacyInfo class represents the privacy information.
41 * This class provides methods to retrieve the name and description of privilege.
44 class _OSP_EXPORT_ PrivacyInfo
45 : public Tizen::Base::Object
51 * The object is not fully constructed after this constructor is called. @n
52 * For full construction, the Construct() method must be called right after calling this constructor.
56 * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance.
61 * This destructor overrides Tizen::Base::Object::~Object().
66 virtual ~PrivacyInfo(void);
69 * Initializes this instance of %PrivacyInfo with the specified parameters.
73 * @return An error code
74 * @param[in] privacyId The privacy ID
75 * @param[in] enable Set to @c true to enable the privacy setting, @n
77 * @exception E_SUCCESS The method is successful.
78 * @exception E_INVALID_ARG The specified @c privacyId is invalid or the @c privacyId does not exist.
81 result Construct(const Tizen::Base::String& privacyId, bool enable = false);
88 * @return The privacy ID
91 Tizen::Base::String GetId(void) const;
94 * Checks whether the privacy setting is enabled.
98 * @return @c true if the privacy setting is enabled, @n
102 bool IsEnabled(void) const;
105 * Enables or disables the privacy setting.
109 * @param[in] enable A Boolean value indicating whether the privacy setting is enabled
113 void SetEnabled(bool enable);
116 * Gets a localized display name of privacy.
120 * @return The display name of privacy, @n
121 * else an empty string is returned if there is no value
124 Tizen::Base::String GetDisplayName(void) const;
127 * Gets a localized description of privacy.
131 * @return The description of privacy, @n
132 * else an empty string is returned if there is no value
135 Tizen::Base::String GetDescription(void) const;
140 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
142 // @param[in] rhs An instance of %PrivacyInfo
144 PrivacyInfo(const PrivacyInfo& rhs);
147 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
149 // @param[in] rhs An instance of %PrivacyInfo
151 PrivacyInfo& operator =(const PrivacyInfo& rhs);
155 class _PrivacyInfoImpl* __pImpl;
156 friend class _PrivacyInfoImpl;
160 } } // Tizen::Security
162 #endif // _FSEC_PRIVACY_INFO_H_