2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FAppPkgPackageAppInfo.h
20 * @brief This is the header file for the %PackageAppInfo class.
22 * This header file contains the declarations of the %PackageAppInfo class.
25 #ifndef _FAPP_PKG_PACKAGE_APP_INFO_H_
26 #define _FAPP_PKG_PACKAGE_APP_INFO_H_
29 #include <FAppTypes.h>
30 #include <FAppPkgPackageManager.h>
32 namespace Tizen { namespace Graphics
37 namespace Tizen { namespace App { namespace Package
41 * @class PackageAppInfo
42 * @brief This class represents the information of the application in package.
46 * @final This class is not intended for extension.
48 * The %PackageAppInfo class provides the information of the application in package.
51 class _OSP_EXPORT_ PackageAppInfo
52 : public Tizen::Base::Object
56 * This destructor overrides Tizen::Base::Object::~Object().
60 virtual ~PackageAppInfo(void);
63 * Gets an application ID.
67 * @return An application ID
69 AppId GetAppId(void) const;
72 * Gets the name of an application.
76 * @return The name of an application
78 Tizen::Base::String GetAppName(void) const;
81 * Gets the display name of an application.
85 * @return The display name of an application
87 Tizen::Base::String GetAppDisplayName(void) const;
90 * Gets the menu icon path of an application.
94 * @return The menu icon path of an application, @n
95 * else an empty string is returned if there is no value @n
97 Tizen::Base::String GetAppMenuIconPath(void) const;
100 * Gets the setting icon path of an application.
104 * @return The setting icon path of an application, @n
105 * else an empty string is returned if there is no value @n
107 Tizen::Base::String GetAppSettingIconPath(void) const;
110 * Gets the notification icon path of an application.
114 * @return The notification icon path of an application, @n
115 * else an empty string is returned if there is no value @n
117 Tizen::Base::String GetAppNotificationIconPath(void) const;
120 * Gets the menu icon of an application.
124 * @return A pointer to menu icon of an application, @n
125 * else @c null if it fails
126 * @exception E_SUCCESS The method is successful.
127 * @exception E_FILE_NOT_FOUND The menu icon does not exist.
128 * @exception E_UNSUPPORTED_FORMAT The image file format is not supported.
129 * @remarks The specific error code can be accessed using the GetLastResult() method.
131 Tizen::Graphics::Bitmap* GetAppMenuIconN(void) const;
134 * Gets the metadata list of an application.
138 * @return A pointer to a map of key(Tizen::Base::String) and value(Tizen::Base::String) pairs of the metadata, @n
139 * else @c null if it fails
140 * @exception E_SUCCESS The method is successful.
141 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
142 * @remarks The specific error code can be accessed using the GetLastResult() method.
143 * @remarks Application can use the metadata to set app-wide information.
145 Tizen::Base::Collection::IMap* GetAppMetadataListN(void) const;
148 * Gets the category list of an application.
152 * @return A pointer to the list of the Tizen::Base::String instances, @n
153 * else @c null if it fails
154 * @exception E_SUCCESS The method is successful.
155 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
156 * @remarks The specific error code can be accessed using the GetLastResult() method.
158 Tizen::Base::Collection::IList* GetAppCategoryListN(void) const;
161 * Checks whether an application is visible on the menu.
165 * @return @c true if an application is visible on the menu, @n
167 * @remarks If the return value is @c false, it is recommended not to display the application on the menu.
169 bool IsMenuIconVisible(void) const;
172 * Checks whether an application is the main application of the package.
176 * @return @c true if an application is the main application of the package, @n
179 bool IsMainApp(void) const;
183 * This is the default constructor for this class. This default constructor is intentionally
184 declared as private so that only the platform can create an instance.
186 PackageAppInfo(void);
189 * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
191 PackageAppInfo(const PackageAppInfo& rhs);
194 * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
196 PackageAppInfo& operator =(const PackageAppInfo& rhs);
199 class _PackageAppInfoImpl* __pPackageAppInfoImpl;
201 friend class _PackageAppInfoImpl;
202 friend class _PackageInfoImpl;
203 friend class _PackageManagerImpl;
204 friend class _PackageParser;
208 } } } // Tizen::App::Package
210 #endif // _FAPP_PKG_PACKAGE_APP_INFO_H_