//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
#include <FAppTypes.h>
#include <FAppPkgPackageManager.h>
+namespace Tizen { namespace Graphics
+{
+class Bitmap;
+} }
+
namespace Tizen { namespace App { namespace Package
{
/**
* @class PackageAppInfo
- * @brief This class represents the information of the application in package.
+ * @brief This class represents the information of an application in a package.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %PackageAppInfo class provides the information of the application in package.
+ * The %PackageAppInfo class provides the information of an application in a package.
*
*/
class _OSP_EXPORT_ PackageAppInfo
virtual ~PackageAppInfo(void);
/**
- * Gets an application ID.
+ * Gets the application ID.
*
* @since 2.0
*
- * @return An application ID
+ * @return The application ID
*/
AppId GetAppId(void) const;
*
* @since 2.0
*
- * @return The name of an application
+ * @return The name of the application
*/
Tizen::Base::String GetAppName(void) const;
*
* @since 2.0
*
- * @return The display name of an application
+ * @return The display name of the application
*/
Tizen::Base::String GetAppDisplayName(void) const;
/**
- * @if VISPARTNER-MANUFACTURER
- * Gets the menu icon path of an application.
- *
- * @since 2.0
- * @visibility partner-manufacturer
- * @privilege %http://tizen.org/privilege/packagesetting
- *
- * @return The menu icon path of an application, @n
- * else an empty string is returned if there is no value
- * @endif
- */
+ * Gets the menu icon path of an application.
+ *
+ * @since 2.1
+ *
+ * @return The menu icon path of the application, @n
+ * else an empty string is returned if there is no value
+ */
Tizen::Base::String GetAppMenuIconPath(void) const;
/**
- * @if VISPARTNER-MANUFACTURER
- * Gets the setting icon path of an application.
- *
- * @since 2.0
- * @visibility partner-manufacturer
- * @privilege %http://tizen.org/privilege/packagesetting
- *
- * @return The setting icon path of an application, @n
- * else an empty string is returned if there is no value
- * @endif
- */
+ * Gets the setting icon path of an application.
+ *
+ * @since 2.1
+ *
+ * @return The setting icon path of the application, @n
+ * else an empty string is returned if there is no value
+ */
Tizen::Base::String GetAppSettingIconPath(void) const;
/**
- * @if VISPARTNER-MANUFACTURER
- * Gets the notification icon path of an application.
- *
- * @since 2.0
- * @visibility partner-manufacturer
- * @privilege %http://tizen.org/privilege/packagesetting
- *
- * @return The notification icon path of an application, @n
- * else an empty string is returned if there is no value
- * @endif
- */
+ * Gets the notification icon path of an application.
+ *
+ * @since 2.1
+ *
+ * @return The notification icon path of the application, @n
+ * else an empty string is returned if there is no value
+ */
Tizen::Base::String GetAppNotificationIconPath(void) const;
/**
+ * Gets the menu icon of an application.
+ *
+ * @since 2.1
+ *
+ * @return A pointer to the menu icon of the application, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FILE_NOT_FOUND The menu icon does not exist.
+ * @exception E_UNSUPPORTED_FORMAT The image file format is not supported.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
+ Tizen::Graphics::Bitmap* GetAppMenuIconN(void) const;
+
+ /**
+ * Gets the metadata list of an application.
+ *
+ * @since 2.1
+ *
+ * @return A pointer to the map of the key(Tizen::Base::String) and value(%Tizen::Base::String) pairs of the metadata, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - An application can use the metadata to set the app-wide information.
+ */
+ Tizen::Base::Collection::IMap* GetAppMetadataListN(void) const;
+
+ /**
* Gets the category list of an application.
*
* @since 2.0
Tizen::Base::Collection::IList* GetAppCategoryListN(void) const;
/**
- * Checks whether an application is visible on the menu.
+ * Checks if an application is visible on the menu.
*
* @since 2.0
*
- * @return @c true if an application is visible on the menu, @n
+ * @return @c true if the application is visible on the menu, @n
* else @c false
- * @remarks If the return value is @c false, it is recommended not to display the application on the menu.
+ * @remarks If the return value is @c false, it is not recommended to display the application on the menu.
*/
bool IsMenuIconVisible(void) const;
/**
- * Checks whether an application is the main application of the package.
+ * Checks if an application is the main application of the package.
*
* @since 2.0
*
- * @return @c true if an application is the main application of the package, @n
+ * @return @c true if the application is the main application of the package, @n
* else @c false
*/
bool IsMainApp(void) const;
-
+
private:
/**
* This is the default constructor for this class. This default constructor is intentionally
friend class _PackageAppInfoImpl;
friend class _PackageInfoImpl;
friend class _PackageManagerImpl;
+ friend class _PackageParser;
+ friend class _PackageManagerServer;
}; // PackageAppInfo
projects / platform / framework / native / appfw.git / blobdiff