![]() |
![]() |
![]() |
AppStream-glib Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#include <appstream-glib.h> #define AS_TYPE_APP struct AsAppClass; enum AsAppParseFlags; enum AsAppSubsumeFlags; #define AS_APP_SUBSUME_FLAG_SOURCE_FILE #define AS_APP_SUBSUME_FLAG_MERGE #define AS_APP_SUBSUME_FLAG_PARTIAL #define AS_APP_SUBSUME_FLAG_DEDUPE enum AsAppError; enum AsAppValidateFlags; enum AsAppTrustFlags; typedef AsAppSourceKind; #define AS_APP_SOURCE_KIND_UNKNOWN #define AS_APP_SOURCE_KIND_APPSTREAM #define AS_APP_SOURCE_KIND_DESKTOP #define AS_APP_SOURCE_KIND_APPDATA #define AS_APP_SOURCE_KIND_METAINFO #define AS_APP_SOURCE_KIND_INF enum AsAppKind; enum AsAppQuirk; enum AsAppState; enum AsAppScope; enum AsAppMergeKind; enum AsAppSearchMatch; #define AS_APP_ERROR AsApp * as_app_new (void
); GQuark as_app_error_quark (void
); const gchar * as_app_state_to_string (AsAppState state
); const gchar * as_app_kind_to_string (AsAppKind kind
); AsAppKind as_app_kind_from_string (const gchar *kind
); AsAppScope as_app_scope_from_string (const gchar *scope
); const gchar * as_app_scope_to_string (AsAppScope scope
); AsAppMergeKind as_app_merge_kind_from_string (const gchar *merge_kind
); const gchar * as_app_merge_kind_to_string (AsAppMergeKind merge_kind
); AsAppKind as_app_get_kind (AsApp *app
); AsAppScope as_app_get_scope (AsApp *app
); AsAppMergeKind as_app_get_merge_kind (AsApp *app
); AsAppState as_app_get_state (AsApp *app
); guint32 as_app_get_trust_flags (AsApp *app
); guint16 as_app_get_search_match (AsApp *app
); GList * as_app_get_languages (AsApp *app
); GPtrArray * as_app_get_addons (AsApp *app
); GPtrArray * as_app_get_categories (AsApp *app
); GPtrArray * as_app_get_compulsory_for_desktops (AsApp *app
); GPtrArray * as_app_get_extends (AsApp *app
); GPtrArray * as_app_get_keywords (AsApp *app
,const gchar *locale
); GPtrArray * as_app_get_kudos (AsApp *app
); GPtrArray * as_app_get_permissions (AsApp *app
); GPtrArray * as_app_get_formats (AsApp *app
); GPtrArray * as_app_get_mimetypes (AsApp *app
); GPtrArray * as_app_get_pkgnames (AsApp *app
); GPtrArray * as_app_get_architectures (AsApp *app
); GPtrArray * as_app_get_releases (AsApp *app
); GPtrArray * as_app_get_provides (AsApp *app
); GPtrArray * as_app_get_launchables (AsApp *app
); GPtrArray * as_app_get_screenshots (AsApp *app
); GPtrArray * as_app_get_reviews (AsApp *app
); GPtrArray * as_app_get_content_ratings (AsApp *app
); GPtrArray * as_app_get_icons (AsApp *app
); GPtrArray * as_app_get_bundles (AsApp *app
); GPtrArray * as_app_get_translations (AsApp *app
); GPtrArray * as_app_get_suggests (AsApp *app
); GPtrArray * as_app_get_requires (AsApp *app
); GHashTable * as_app_get_names (AsApp *app
); GHashTable * as_app_get_comments (AsApp *app
); GHashTable * as_app_get_developer_names (AsApp *app
); GHashTable * as_app_get_metadata (AsApp *app
); GHashTable * as_app_get_descriptions (AsApp *app
); GHashTable * as_app_get_urls (AsApp *app
); GPtrArray * as_app_get_vetos (AsApp *app
); const gchar * as_app_get_icon_path (AsApp *app
); const gchar * as_app_get_id_filename (AsApp *app
); const gchar * as_app_get_id (AsApp *app
); const gchar * as_app_get_id_no_prefix (AsApp *app
); const gchar * as_app_get_unique_id (AsApp *app
); const gchar * as_app_get_pkgname_default (AsApp *app
); const gchar * as_app_get_source_pkgname (AsApp *app
); const gchar * as_app_get_origin (AsApp *app
); const gchar * as_app_get_project_group (AsApp *app
); const gchar * as_app_get_project_license (AsApp *app
); const gchar * as_app_get_metadata_license (AsApp *app
); const gchar * as_app_get_update_contact (AsApp *app
); const gchar * as_app_get_branch (AsApp *app
); const gchar * as_app_get_name (AsApp *app
,const gchar *locale
); const gchar * as_app_get_comment (AsApp *app
,const gchar *locale
); const gchar * as_app_get_developer_name (AsApp *app
,const gchar *locale
); const gchar * as_app_get_description (AsApp *app
,const gchar *locale
); gint as_app_get_priority (AsApp *app
); gint as_app_get_language (AsApp *app
,const gchar *locale
); const gchar * as_app_get_metadata_item (AsApp *app
,const gchar *key
); const gchar * as_app_get_url_item (AsApp *app
,AsUrlKind url_kind
); gboolean as_app_has_category (AsApp *app
,const gchar *category
); gboolean as_app_has_kudo (AsApp *app
,const gchar *kudo
); gboolean as_app_has_kudo_kind (AsApp *app
,AsKudoKind kudo
); gboolean as_app_has_permission (AsApp *app
,const gchar *permission
); AsFormat * as_app_get_format_default (AsApp *app
); AsFormat * as_app_get_format_by_kind (AsApp *app
,AsFormatKind kind
); AsFormat * as_app_get_format_by_filename (AsApp *app
,const gchar *filename
); gboolean as_app_has_compulsory_for_desktop (AsApp *app
,const gchar *desktop
); gboolean as_app_has_quirk (AsApp *app
,AsAppQuirk quirk
); AsLaunchable * as_app_get_launchable_default (AsApp *app
); AsLaunchable * as_app_get_launchable_by_kind (AsApp *app
,AsLaunchableKind kind
); void as_app_set_id (AsApp *app
,const gchar *id
); void as_app_set_kind (AsApp *app
,AsAppKind kind
); void as_app_set_scope (AsApp *app
,AsAppScope scope
); void as_app_set_merge_kind (AsApp *app
,AsAppMergeKind merge_kind
); void as_app_set_state (AsApp *app
,AsAppState state
); void as_app_set_trust_flags (AsApp *app
,guint32 trust_flags
); void as_app_set_search_match (AsApp *app
,guint16 search_match
); void as_app_set_origin (AsApp *app
,const gchar *origin
); void as_app_set_project_group (AsApp *app
,const gchar *project_group
); void as_app_set_project_license (AsApp *app
,const gchar *project_license
); void as_app_set_metadata_license (AsApp *app
,const gchar *metadata_license
); void as_app_set_source_pkgname (AsApp *app
,const gchar *source_pkgname
); void as_app_set_update_contact (AsApp *app
,const gchar *update_contact
); void as_app_set_icon_path (AsApp *app
,const gchar *icon_path
); void as_app_set_name (AsApp *app
,const gchar *locale
,const gchar *name
); void as_app_set_comment (AsApp *app
,const gchar *locale
,const gchar *comment
); void as_app_set_developer_name (AsApp *app
,const gchar *locale
,const gchar *developer_name
); void as_app_set_description (AsApp *app
,const gchar *locale
,const gchar *description
); void as_app_set_branch (AsApp *app
,const gchar *branch
); void as_app_set_priority (AsApp *app
,gint priority
); void as_app_add_category (AsApp *app
,const gchar *category
); void as_app_remove_category (AsApp *app
,const gchar *category
); void as_app_add_keyword (AsApp *app
,const gchar *locale
,const gchar *keyword
); void as_app_add_kudo (AsApp *app
,const gchar *kudo
); void as_app_remove_kudo (AsApp *app
,const gchar *kudo
); void as_app_add_kudo_kind (AsApp *app
,AsKudoKind kudo_kind
); void as_app_add_permission (AsApp *app
,const gchar *permission
); void as_app_add_format (AsApp *app
,AsFormat *format
); void as_app_remove_format (AsApp *app
,AsFormat *format
); void as_app_add_mimetype (AsApp *app
,const gchar *mimetype
); void as_app_add_pkgname (AsApp *app
,const gchar *pkgname
); void as_app_add_arch (AsApp *app
,const gchar *arch
); void as_app_add_release (AsApp *app
,AsRelease *release
); void as_app_add_provide (AsApp *app
,AsProvide *provide
); void as_app_add_launchable (AsApp *app
,AsLaunchable *launchable
); void as_app_add_screenshot (AsApp *app
,AsScreenshot *screenshot
); void as_app_add_review (AsApp *app
,AsReview *review
); void as_app_add_content_rating (AsApp *app
,AsContentRating *content_rating
); void as_app_add_agreement (AsApp *app
,AsAgreement *agreement
); void as_app_add_icon (AsApp *app
,AsIcon *icon
); void as_app_add_bundle (AsApp *app
,AsBundle *bundle
); void as_app_add_translation (AsApp *app
,AsTranslation *translation
); void as_app_add_suggest (AsApp *app
,AsSuggest *suggest
); void as_app_add_require (AsApp *app
,AsRequire *require
); void as_app_add_language (AsApp *app
,gint percentage
,const gchar *locale
); void as_app_add_compulsory_for_desktop (AsApp *app
,const gchar *compulsory_for_desktop
); void as_app_add_url (AsApp *app
,AsUrlKind url_kind
,const gchar *url
); void as_app_add_metadata (AsApp *app
,const gchar *key
,const gchar *value
); void as_app_remove_metadata (AsApp *app
,const gchar *key
); void as_app_add_addon (AsApp *app
,AsApp *addon
); void as_app_add_extends (AsApp *app
,const gchar *extends
); void as_app_add_quirk (AsApp *app
,AsAppQuirk quirk
); GPtrArray * as_app_validate (AsApp *app
,guint32 flags
,GError **error
); void as_app_subsume (AsApp *app
,AsApp *donor
); void as_app_subsume_full (AsApp *app
,AsApp *donor
,guint64 flags
); void as_app_add_veto (AsApp *app
,const gchar *fmt
,...
); void as_app_remove_veto (AsApp *app
,const gchar *description
); guint as_app_search_matches_all (AsApp *app
,gchar **search
); guint as_app_search_matches (AsApp *app
,const gchar *search
); gboolean as_app_parse_file (AsApp *app
,const gchar *filename
,guint32 flags
,GError **error
); gboolean as_app_parse_data (AsApp *app
,GBytes *data
,guint32 flags
,GError **error
); gboolean as_app_to_file (AsApp *app
,GFile *file
,GCancellable *cancellable
,GError **error
); AsContentRating * as_app_get_content_rating (AsApp *app
,const gchar *kind
); AsAgreement * as_app_get_agreement_by_kind (AsApp *app
,AsAgreementKind kind
); AsAgreement * as_app_get_agreement_default (AsApp *app
); AsScreenshot * as_app_get_screenshot_default (AsApp *app
); AsIcon * as_app_get_icon_default (AsApp *app
); AsIcon * as_app_get_icon_for_size (AsApp *app
,guint width
,guint height
); AsBundle * as_app_get_bundle_default (AsApp *app
); AsRelease * as_app_get_release (AsApp *app
,const gchar *version
); AsRelease * as_app_get_release_default (AsApp *app
); AsRelease * as_app_get_release_by_version (AsApp *app
,const gchar *version
); AsRequire * as_app_get_require_by_value (AsApp *app
,AsRequireKind kind
,const gchar *value
); gboolean as_app_convert_icons (AsApp *app
,AsIconKind kind
,GError **error
); gboolean as_app_equal (AsApp *app1
,AsApp *app2
); AsIdKind as_app_get_id_kind (AsApp *app
); void as_app_set_id_kind (AsApp *app
,AsIdKind id_kind
); void as_app_set_source_file (AsApp *app
,const gchar *source_file
); const gchar * as_app_get_source_file (AsApp *app
); AsFormatKind as_app_get_source_kind (AsApp *app
); void as_app_set_source_kind (AsApp *app
,AsFormatKind source_kind
); AsFormatKind as_app_source_kind_from_string (const gchar *source_kind
); const gchar * as_app_source_kind_to_string (AsFormatKind source_kind
); AsFormatKind as_app_guess_source_kind (const gchar *filename
);
This object represents the base object of all AppStream, the application. Although called AsApp, this object also represents components like fonts, codecs and input methods.
See also: AsScreenshot, AsRelease
typedef enum { AS_APP_PARSE_FLAG_NONE = 0, AS_APP_PARSE_FLAG_USE_HEURISTICS = 1 << 0, /* Since: 0.1.2 */ AS_APP_PARSE_FLAG_KEEP_COMMENTS = 1 << 1, /* Since: 0.1.6 */ AS_APP_PARSE_FLAG_CONVERT_TRANSLATABLE = 1 << 2, /* Since: 0.1.6 */ AS_APP_PARSE_FLAG_APPEND_DATA = 1 << 3, /* Since: 0.1.8 */ AS_APP_PARSE_FLAG_ALLOW_VETO = 1 << 4, /* Since: 0.2.5 */ AS_APP_PARSE_FLAG_USE_FALLBACKS = 1 << 5, /* Since: 0.4.1 */ AS_APP_PARSE_FLAG_ADD_ALL_METADATA = 1 << 6, /* Since: 0.6.1 */ AS_APP_PARSE_FLAG_ONLY_NATIVE_LANGS = 1 << 7, /* Since: 0.6.3 */ } AsAppParseFlags;
The flags to use when parsing resources.
No special actions to use | |
Use heuristic to infer properties | |
Save comments from the file | |
Allow translatable flags like <_p> | |
Append new data rather than replacing | |
Do not return errors for vetoed apps | |
Fall back to suboptimal data where required | |
Add all extra metadata from the source file | |
Only load native languages |
typedef enum { AS_APP_SUBSUME_FLAG_NONE = 0, AS_APP_SUBSUME_FLAG_NO_OVERWRITE = 1ull << 0, /* Since: 0.1.4 */ AS_APP_SUBSUME_FLAG_BOTH_WAYS = 1ull << 1, /* Since: 0.1.4 */ AS_APP_SUBSUME_FLAG_REPLACE = 1ull << 2, /* Since: 0.6.3 */ AS_APP_SUBSUME_FLAG_KIND = 1ull << 3, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_STATE = 1ull << 4, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_BUNDLES = 1ull << 5, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_TRANSLATIONS = 1ull << 6, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_RELEASES = 1ull << 7, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_KUDOS = 1ull << 8, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_CATEGORIES = 1ull << 9, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_PERMISSIONS = 1ull << 10, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_EXTENDS = 1ull << 11, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_COMPULSORY = 1ull << 12, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_SCREENSHOTS = 1ull << 13, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_REVIEWS = 1ull << 14, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_CONTENT_RATINGS = 1ull << 15, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_PROVIDES = 1ull << 16, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_ICONS = 1ull << 17, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_MIMETYPES = 1ull << 18, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_VETOS = 1ull << 19, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_LANGUAGES = 1ull << 20, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_NAME = 1ull << 21, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_COMMENT = 1ull << 22, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_DEVELOPER_NAME = 1ull << 23, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_DESCRIPTION = 1ull << 24, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_METADATA = 1ull << 25, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_URL = 1ull << 26, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_KEYWORDS = 1ull << 27, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_FORMATS = 1ull << 28, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_BRANCH = 1ull << 29, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_ORIGIN = 1ull << 30, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_METADATA_LICENSE = 1ull << 31, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_PROJECT_LICENSE = 1ull << 32, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_PROJECT_GROUP = 1ull << 33, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_SOURCE_KIND = 1ull << 34, /* Since: 0.6.1 */ AS_APP_SUBSUME_FLAG_SUGGESTS = 1ull << 35, /* Since: 0.6.3 */ AS_APP_SUBSUME_FLAG_LAUNCHABLES = 1ull << 36, /* Since: 0.6.13 */ AS_APP_SUBSUME_FLAG_AGREEMENTS = 1ull << 37, /* Since: 0.7.8 */ } AsAppSubsumeFlags;
The flags to use when subsuming applications.
No special actions to use | |
Do not overwrite already set properties | |
Copy unset properties both ways | |
Copy the kind | |
Copy the state | |
Copy the bundles | |
Copy the translations | |
Copy the releases | |
Copy the kudos | |
Copy the categories | |
Copy the permissions | |
Copy the extends | |
Copy the compulsory-for-desktop | |
Copy the screenshots | |
Copy the reviews | |
Copy the content ratings | |
Copy the provides | |
Copy the icons | |
Copy the mimetypes | |
Copy the vetos | |
Copy the languages | |
Copy the name | |
Copy the comment | |
Copy the developer name | |
Copy the description | |
Copy the metadata | |
Copy the urls | |
Copy the keywords | |
Copy the source file | |
Copy the branch | |
Copy the origin | |
Copy the metadata license | |
Copy the project license | |
Copy the project group | |
Copy the source kind | |
Copy the launchables | |
Copy the agreements |
typedef enum { AS_APP_ERROR_FAILED, AS_APP_ERROR_INVALID_TYPE, } AsAppError;
The error type.
typedef enum { AS_APP_VALIDATE_FLAG_NONE = 0, /* Since: 0.1.4 */ AS_APP_VALIDATE_FLAG_RELAX = 1, /* Since: 0.1.4 */ AS_APP_VALIDATE_FLAG_STRICT = 2, /* Since: 0.1.4 */ AS_APP_VALIDATE_FLAG_NO_NETWORK = 4, /* Since: 0.1.4 */ AS_APP_VALIDATE_FLAG_ALL_APPS = 8, /* Since: 0.2.6 */ } AsAppValidateFlags;
The flags to use when validating.
typedef enum { AS_APP_TRUST_FLAG_COMPLETE = 0, /* Since: 0.2.2 */ AS_APP_TRUST_FLAG_CHECK_DUPLICATES = 1, /* Since: 0.2.2 */ AS_APP_TRUST_FLAG_CHECK_VALID_UTF8 = 2, /* Since: 0.2.2 */ } AsAppTrustFlags;
The flags to use when checking input.
typedef AsFormatKind AsAppSourceKind;
The source kind.
This has been deprecated since 0.6.9 in favour of using AsFormatKind.
#define AS_APP_SOURCE_KIND_UNKNOWN AS_FORMAT_KIND_UNKNOWN /* Since: 0.1.4 */
#define AS_APP_SOURCE_KIND_APPSTREAM AS_FORMAT_KIND_APPSTREAM /* Since: 0.1.4 */
#define AS_APP_SOURCE_KIND_DESKTOP AS_FORMAT_KIND_DESKTOP /* Since: 0.1.4 */
#define AS_APP_SOURCE_KIND_APPDATA AS_FORMAT_KIND_APPDATA /* Since: 0.1.4 */
#define AS_APP_SOURCE_KIND_METAINFO AS_FORMAT_KIND_METAINFO /* Since: 0.1.7 */
typedef enum { AS_APP_KIND_UNKNOWN, /* Since: 0.5.10 */ AS_APP_KIND_DESKTOP, /* Since: 0.5.10 */ AS_APP_KIND_FONT, /* Since: 0.5.10 */ AS_APP_KIND_CODEC, /* Since: 0.5.10 */ AS_APP_KIND_INPUT_METHOD, /* Since: 0.5.10 */ AS_APP_KIND_WEB_APP, /* Since: 0.5.10 */ AS_APP_KIND_SOURCE, /* Since: 0.5.10 */ AS_APP_KIND_ADDON, /* Since: 0.5.10 */ AS_APP_KIND_FIRMWARE, /* Since: 0.5.10 */ AS_APP_KIND_RUNTIME, /* Since: 0.5.10 */ AS_APP_KIND_GENERIC, /* Since: 0.5.10 */ AS_APP_KIND_OS_UPDATE, /* Since: 0.5.10 */ AS_APP_KIND_OS_UPGRADE, /* Since: 0.5.10 */ AS_APP_KIND_SHELL_EXTENSION, /* Since: 0.5.10 */ AS_APP_KIND_LOCALIZATION, /* Since: 0.5.11 */ AS_APP_KIND_CONSOLE, /* Since: 0.6.1 */ AS_APP_KIND_DRIVER, /* Since: 0.6.3 */ } AsAppKind;
The component type.
Type invalid or not known | |
A desktop application | |
A font add-on | |
A codec add-on | |
A input method add-on | |
A web appication | |
A software source | |
An addon, e.g. a plugin | |
A firmware update | |
Runtime platform | |
Generic component | |
Operating system update | |
Operating system upgrade | |
GNOME Shell extension | |
Localization data | |
Console program | |
Driver for hardware support |
typedef enum { AS_APP_QUIRK_NONE = 0, /* Since: 0.5.10 */ AS_APP_QUIRK_PROVENANCE = 1 << 0, /* Since: 0.5.10 */ AS_APP_QUIRK_COMPULSORY = 1 << 1, /* Since: 0.5.10 */ AS_APP_QUIRK_HAS_SOURCE = 1 << 2, /* Since: 0.5.10 */ AS_APP_QUIRK_MATCH_ANY_PREFIX = 1 << 3, /* Since: 0.5.12 */ AS_APP_QUIRK_NEEDS_REBOOT = 1 << 4, /* Since: 0.5.14 */ AS_APP_QUIRK_NOT_REVIEWABLE = 1 << 5, /* Since: 0.5.14 */ AS_APP_QUIRK_HAS_SHORTCUT = 1 << 6, /* Since: 0.5.15 */ AS_APP_QUIRK_NOT_LAUNCHABLE = 1 << 7, /* Since: 0.5.15 */ AS_APP_QUIRK_NEEDS_USER_ACTION = 1 << 8, /* Since: 0.6.2 */ AS_APP_QUIRK_IS_PROXY = 1 << 9, /* Since: 0.6.6 */ AS_APP_QUIRK_REMOVABLE_HARDWARE = 1 << 10, /* Since: 0.6.6 */ } AsAppQuirk;
The component attributes.
No special attributes | |
Installed by OS vendor | |
Cannot be removed | |
Has a source to allow staying up-to-date | |
Matches applications with any prefix | |
A reboot is required after the action | |
The app is not reviewable | |
The app has a shortcut in the system | |
The app is not launchable (run-able) | |
The component requires some kind of user action | |
Is a proxy app that operates on other applications | |
The device is unusable whilst the action is performed |
typedef enum { AS_APP_STATE_UNKNOWN, /* Since: 0.2.2 */ AS_APP_STATE_INSTALLED, /* Since: 0.2.2 */ AS_APP_STATE_AVAILABLE, /* Since: 0.2.2 */ AS_APP_STATE_AVAILABLE_LOCAL, /* Since: 0.2.2 */ AS_APP_STATE_UPDATABLE, /* Since: 0.2.2 */ AS_APP_STATE_UNAVAILABLE, /* Since: 0.2.2 */ AS_APP_STATE_QUEUED_FOR_INSTALL, /* Since: 0.2.2 */ AS_APP_STATE_INSTALLING, /* Since: 0.2.2 */ AS_APP_STATE_REMOVING, /* Since: 0.2.2 */ AS_APP_STATE_UPDATABLE_LIVE, /* Since: 0.5.4 */ AS_APP_STATE_PURCHASABLE, /* Since: 0.5.17 */ AS_APP_STATE_PURCHASING, /* Since: 0.5.17 */ } AsAppState;
The application state.
Unknown state | |
Application is installed | |
Application is available | |
Application is locally available as a file | |
Application is installed and updatable | |
Application is referenced, but not available | |
Application is queued for install | |
Application is being installed | |
Application is being removed | |
Application is installed and updatable live | |
Application is available for purchasing | |
Application is being purchased |
typedef enum { AS_APP_SCOPE_UNKNOWN, /* Since: 0.6.1 */ AS_APP_SCOPE_USER, /* Since: 0.6.1 */ AS_APP_SCOPE_SYSTEM, /* Since: 0.6.1 */ } AsAppScope;
The application scope.
typedef enum { AS_APP_MERGE_KIND_UNKNOWN, /* Since: 0.6.1 */ AS_APP_MERGE_KIND_NONE, /* Since: 0.6.1 */ AS_APP_MERGE_KIND_REPLACE, /* Since: 0.6.1 */ AS_APP_MERGE_KIND_APPEND, /* Since: 0.6.1 */ } AsAppMergeKind;
The component merge kind.
The token match kind, which we want to be exactly 16 bits for storage reasons.
No token matching | |
Use the app mimetypes | |
Use the app package name | |
Use the app description | |
Use the app comment | |
Use the app name | |
Use the app keyword | |
Use the app application ID | |
Use the app origin |
AsApp * as_app_new (void
);
Creates a new AsApp.
Returns : |
a AsApp. [transfer full] |
Since 0.1.0
const gchar * as_app_state_to_string (AsAppState state
);
Converts the enumerated value to an text representation.
|
the AsAppState. |
Returns : |
string version of state , or NULL for unknown |
Since 0.2.2
const gchar * as_app_kind_to_string (AsAppKind kind
);
Converts the enumerated value to an text representation.
|
the AsAppKind. |
Returns : |
string version of kind
|
Since 0.5.10
AsAppKind as_app_kind_from_string (const gchar *kind
);
Converts the text representation to an enumerated value.
|
the string. |
Returns : |
a AsAppKind or AS_APP_KIND_UNKNOWN for unknown |
Since 0.5.10
AsAppScope as_app_scope_from_string (const gchar *scope
);
Converts the text representation to an enumerated value.
|
a source kind string |
Returns : |
A AsAppScope, e.g. AS_APP_SCOPE_SYSTEM . |
Since 0.6.1
const gchar * as_app_scope_to_string (AsAppScope scope
);
Converts the enumerated value to an text representation.
|
the AsAppScope, e.g. AS_APP_SCOPE_SYSTEM
|
Returns : |
string version of scope , or NULL for unknown |
Since 0.6.1
AsAppMergeKind as_app_merge_kind_from_string (const gchar *merge_kind
);
Converts the text representation to an enumerated value.
|
a source kind string |
Returns : |
A AsAppMergeKind, e.g. AS_APP_MERGE_KIND_REPLACE . |
Since 0.6.1
const gchar * as_app_merge_kind_to_string (AsAppMergeKind merge_kind
);
Converts the enumerated value to an text representation.
|
the AsAppMergeKind, e.g. AS_APP_MERGE_KIND_REPLACE
|
Returns : |
string version of merge_kind , or NULL for unknown |
Since 0.6.1
AsAppKind as_app_get_kind (AsApp *app
);
Gets the ID kind.
|
a AsApp instance. |
Returns : |
enumerated value |
Since 0.5.10
AsAppScope as_app_get_scope (AsApp *app
);
Gets the scope of the application.
|
a AsApp instance. |
Returns : |
enumerated value |
Since 0.6.1
AsAppMergeKind as_app_get_merge_kind (AsApp *app
);
Gets the merge_kind of the application.
|
a AsApp instance. |
Returns : |
enumerated value |
Since 0.6.1
AsAppState as_app_get_state (AsApp *app
);
Gets the application state.
|
a AsApp instance. |
Returns : |
enumerated value |
Since 0.2.2
guint32 as_app_get_trust_flags (AsApp *app
);
Gets the trust flags, i.e. how trusted the incoming data is.
|
a AsApp instance. |
Returns : |
bitfield |
Since 0.2.2
guint16 as_app_get_search_match (AsApp *app
);
Gets the token match fields. The bitfield given here is used to choose what is included in the token cache.
|
a AsApp instance. |
Returns : |
a AsAppSearchMatch, e.g. AS_APP_SEARCH_MATCH_PKGNAME
|
Since 0.6.13
GList * as_app_get_languages (AsApp *app
);
Get a list of all languages.
|
a AsApp instance. |
Returns : |
list of language values. [transfer container][element-type utf8] |
Since 0.1.0
GPtrArray * as_app_get_addons (AsApp *app
);
Gets all the addons the application has.
|
a AsApp instance. |
Returns : |
an array. [element-type AsApp][transfer none] |
Since 0.1.7
GPtrArray * as_app_get_categories (AsApp *app
);
Get the application categories.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.1.0
GPtrArray * as_app_get_compulsory_for_desktops (AsApp *app
);
Returns the desktops where this application is compulsory.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.1.0
GPtrArray * as_app_get_extends (AsApp *app
);
Gets the IDs that are extended from the addon.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.1.7
GPtrArray * as_app_get_keywords (AsApp *app
,const gchar *locale
);
Gets any keywords the application should match against.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
Returns : |
an array, or NULL . [element-type utf8][transfer none]
|
Since 0.3.0
GPtrArray * as_app_get_kudos (AsApp *app
);
Gets any kudos the application has obtained.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.2.2
GPtrArray * as_app_get_permissions (AsApp *app
);
Gets any permissions the application has obtained.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.3.5
GPtrArray * as_app_get_formats (AsApp *app
);
Gets any formats that make up the application.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.6.9
GPtrArray * as_app_get_mimetypes (AsApp *app
);
Gets any mimetypes the application will register.
|
a AsApp instance. |
Returns : |
an array. [transfer none][element-type utf8] |
Since 0.2.0
GPtrArray * as_app_get_pkgnames (AsApp *app
);
Gets the package names (if any) for the application.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.1.0
GPtrArray * as_app_get_architectures (AsApp *app
);
Gets the supported architectures for the application, or an empty list if all architectures are supported.
|
a AsApp instance. |
Returns : |
an array. [element-type utf8][transfer none] |
Since 0.1.1
GPtrArray * as_app_get_releases (AsApp *app
);
Gets all the releases the application has had.
|
a AsApp instance. |
Returns : |
an array. [element-type AsRelease][transfer none] |
Since 0.1.0
GPtrArray * as_app_get_provides (AsApp *app
);
Gets all the provides the application has.
|
a AsApp instance. |
Returns : |
an array. [element-type AsProvide][transfer none] |
Since 0.1.6
GPtrArray * as_app_get_launchables (AsApp *app
);
Gets all the launchables the application has.
|
a AsApp instance. |
Returns : |
an array. [element-type AsLaunchable][transfer none] |
Since 0.6.13
GPtrArray * as_app_get_screenshots (AsApp *app
);
Gets any screenshots the application has defined.
|
a AsApp instance. |
Returns : |
an array. [element-type AsScreenshot][transfer none] |
Since 0.1.0
GPtrArray * as_app_get_reviews (AsApp *app
);
Gets any reviews the application has defined.
|
a AsApp instance. |
Returns : |
an array. [element-type AsScreenshot][transfer none] |
Since 0.6.1
GPtrArray * as_app_get_content_ratings (AsApp *app
);
Gets any content_ratings the application has defined.
|
a AsApp instance. |
Returns : |
an array. [element-type AsContentRating][transfer none] |
Since 0.5.12
GPtrArray * as_app_get_icons (AsApp *app
);
Gets any icons the application has defined.
|
a AsApp instance. |
Returns : |
an array. [element-type AsIcon][transfer none] |
Since 0.3.1
GPtrArray * as_app_get_bundles (AsApp *app
);
Gets any bundles the application has defined.
|
a AsApp instance. |
Returns : |
an array. [element-type AsBundle][transfer none] |
Since 0.3.5
GPtrArray * as_app_get_translations (AsApp *app
);
Gets any translations the application has defined.
|
a AsApp instance. |
Returns : |
an array. [element-type AsTranslation][transfer none] |
Since 0.5.8
GPtrArray * as_app_get_suggests (AsApp *app
);
Gets any suggests the application has defined.
|
a AsApp instance. |
Returns : |
an array. [element-type AsSuggest][transfer none] |
Since 0.6.1
GPtrArray * as_app_get_requires (AsApp *app
);
Gets any requires the application has defined. A rquirement could be that a firmware version has to be below a defined version or that another application is required to be installed.
|
a AsApp instance. |
Returns : |
an array. [element-type AsRequire][transfer none] |
Since 0.6.7
GHashTable * as_app_get_names (AsApp *app
);
Gets the names set for the application.
|
a AsApp instance. |
Returns : |
hash table of names. [transfer none] |
Since 0.1.6
GHashTable * as_app_get_comments (AsApp *app
);
Gets the comments set for the application.
|
a AsApp instance. |
Returns : |
hash table of comments. [transfer none] |
Since 0.1.6
GHashTable * as_app_get_developer_names (AsApp *app
);
Gets the developer_names set for the application.
|
a AsApp instance. |
Returns : |
hash table of developer_names. [transfer none] |
Since 0.1.8
GHashTable * as_app_get_metadata (AsApp *app
);
Gets the metadata set for the application.
|
a AsApp instance. |
Returns : |
hash table of metadata. [transfer none][element-type utf8 utf8] |
Since 0.1.6
GHashTable * as_app_get_descriptions (AsApp *app
);
Gets the descriptions set for the application.
|
a AsApp instance. |
Returns : |
hash table of descriptions. [transfer none] |
Since 0.1.6
GHashTable * as_app_get_urls (AsApp *app
);
Gets the URLs set for the application.
|
a AsApp instance. |
Returns : |
hash table of URLs. [transfer none] |
Since 0.1.0
GPtrArray * as_app_get_vetos (AsApp *app
);
Gets the list of vetos.
|
A AsApp |
Returns : |
A list of vetos. [transfer none][element-type utf8] |
Since 0.2.5
const gchar * as_app_get_icon_path (AsApp *app
);
Gets the application icon path.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.1.0
const gchar * as_app_get_id_filename (AsApp *app
);
Returns a filename which represents the applications ID, e.g. "gimp.desktop" becomes "gimp" and is used for cache directories.
|
a AsApp instance. |
Returns : |
A utf8 filename |
Since 0.3.0
const gchar * as_app_get_id (AsApp *app
);
Gets the full ID value.
|
a AsApp instance. |
Returns : |
the ID, e.g. "org.gnome.Software.desktop" |
Since 0.1.0
const gchar * as_app_get_id_no_prefix (AsApp *app
);
Gets the full ID value, stripping any prefix.
|
a AsApp instance. |
Returns : |
the ID, e.g. "org.gnome.Software.desktop" |
Since 0.5.12
const gchar * as_app_get_unique_id (AsApp *app
);
Gets the unique ID value to represent the component.
|
a AsApp instance. |
Returns : |
the unique ID, e.g. `system/package/fedora/desktop/gimp.desktop/master` |
Since 0.6.1
const gchar * as_app_get_pkgname_default (AsApp *app
);
Gets the default package name.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.2.0
const gchar * as_app_get_source_pkgname (AsApp *app
);
Gets the source package name that produced the binary package. Only source packages producing more than one binary package will have this entry set.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.2.4
const gchar * as_app_get_origin (AsApp *app
);
Gets the application origin.
|
a AsApp instance. |
Returns : |
the origin string, or NULL if unset |
Since 0.3.2
const gchar * as_app_get_project_group (AsApp *app
);
Gets an application project group.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.1.0
const gchar * as_app_get_project_license (AsApp *app
);
Gets the application project license.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.1.0
const gchar * as_app_get_metadata_license (AsApp *app
);
Gets the application project license.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.1.4
const gchar * as_app_get_update_contact (AsApp *app
);
Gets the application upstream update contact email.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.1.4
const gchar * as_app_get_branch (AsApp *app
);
Gets the branch for the application.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.6.1
const gchar * as_app_get_name (AsApp *app
,const gchar *locale
);
Gets the application name for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
Returns : |
string, or NULL if unset |
Since 0.1.0
const gchar * as_app_get_comment (AsApp *app
,const gchar *locale
);
Gets the application summary for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
Returns : |
string, or NULL if unset |
Since 0.1.0
const gchar * as_app_get_developer_name (AsApp *app
,const gchar *locale
);
Gets the application developer name for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
Returns : |
string, or NULL if unset |
Since 0.1.8
const gchar * as_app_get_description (AsApp *app
,const gchar *locale
);
Gets the application description markup for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
Returns : |
string, or NULL if unset |
Since 0.1.0
gint as_app_get_priority (AsApp *app
);
Gets the application priority. Larger values trump smaller values.
|
a AsApp instance. |
Returns : |
priority value |
Since 0.1.0
gint as_app_get_language (AsApp *app
,const gchar *locale
);
Gets the language coverage for the specific language.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
Returns : |
a percentage value where 0 is unspecified, or -1 for not found |
Since 0.1.0
const gchar * as_app_get_metadata_item (AsApp *app
,const gchar *key
);
Gets some metadata item.
|
a AsApp instance. |
|
the metadata key. |
Returns : |
string, or NULL if unset |
Since 0.1.0
const gchar * as_app_get_url_item (AsApp *app
,AsUrlKind url_kind
);
Gets a URL.
|
a AsApp instance. |
|
the URL kind, e.g. AS_URL_KIND_HOMEPAGE . |
Returns : |
string, or NULL if unset |
Since 0.1.0
gboolean as_app_has_category (AsApp *app
,const gchar *category
);
Searches the category list for a specific item.
|
a AsApp instance. |
|
a category string, e.g. "DesktopSettings" |
Returns : |
TRUE if the application has got the specified category |
Since 0.1.5
gboolean as_app_has_kudo (AsApp *app
,const gchar *kudo
);
Searches the kudo list for a specific item.
|
a AsApp instance. |
|
a kudo string, e.g. "SearchProvider" |
Returns : |
TRUE if the application has got the specified kudo |
Since 0.2.2
gboolean as_app_has_kudo_kind (AsApp *app
,AsKudoKind kudo
);
Searches the kudo list for a specific item.
|
a AsApp instance. |
|
a AsKudoKind, e.g. AS_KUDO_KIND_SEARCH_PROVIDER
|
Returns : |
TRUE if the application has got the specified kudo |
Since 0.2.2
gboolean as_app_has_permission (AsApp *app
,const gchar *permission
);
Searches the permission list for a specific item.
|
a AsApp instance. |
|
a permission string, e.g. "Network" |
Returns : |
TRUE if the application has got the specified permission |
Since 0.3.5
AsFormat * as_app_get_format_default (AsApp *app
);
Returns the default format.
|
a AsApp instance. |
Returns : |
A AsFormat, or NULL if not found. [transfer none]
|
Since 0.6.9
AsFormat * as_app_get_format_by_kind (AsApp *app
,AsFormatKind kind
);
Searches the list of formats for a specific format kind.
|
a AsApp instance. |
|
a AsFormatKind, e.g. AS_FORMAT_KIND_APPDATA
|
Returns : |
A AsFormat, or NULL if not found. [transfer none]
|
Since 0.6.9
AsFormat * as_app_get_format_by_filename (AsApp *app
,const gchar *filename
);
Searches the list of formats for a specific filename.
|
a AsApp instance. |
|
a filename, e.g. "/home/hughsie/dave.desktop" |
Returns : |
A AsFormat, or NULL if not found. [transfer none]
|
Since 0.6.9
gboolean as_app_has_compulsory_for_desktop (AsApp *app
,const gchar *desktop
);
Searches the compulsory for desktop list for a specific item.
|
a AsApp instance. |
|
a desktop string, e.g. "GNOME" |
Returns : |
TRUE if the application is compulsory for a specific desktop |
Since 0.5.12
gboolean as_app_has_quirk (AsApp *app
,AsAppQuirk quirk
);
Queries to see if an application has a specific attribute.
|
a AsApp instance. |
|
the AsAppQuirk, e.g. AS_APP_QUIRK_PROVENANCE
|
Returns : |
TRUE if the application has the attribute |
Since 0.5.10
AsLaunchable * as_app_get_launchable_default (AsApp *app
);
Returns the default launchable.
|
a AsApp instance. |
Returns : |
A AsLaunchable, or NULL if not found. [transfer none]
|
Since 0.6.13
AsLaunchable * as_app_get_launchable_by_kind (AsApp *app
,AsLaunchableKind kind
);
Searches the list of launchables for a specific launchable kind.
|
a AsApp instance. |
|
a AsLaunchableKind, e.g. AS_FORMAT_KIND_APPDATA
|
Returns : |
A AsLaunchable, or NULL if not found. [transfer none]
|
Since 0.6.13
void as_app_set_id (AsApp *app
,const gchar *id
);
Sets a new application ID. Any invalid characters will be automatically replaced.
|
a AsApp instance. |
|
the new _full_ application ID, e.g. "org.gnome.Software.desktop". |
Since 0.1.0
void as_app_set_kind (AsApp *app
,AsAppKind kind
);
Sets the application kind.
|
a AsApp instance. |
|
the AsAppKind. |
Since 0.5.10
void as_app_set_scope (AsApp *app
,AsAppScope scope
);
Sets the scope of the application.
|
a AsApp instance. |
|
the AsAppScope. |
Since 0.6.1
void as_app_set_merge_kind (AsApp *app
,AsAppMergeKind merge_kind
);
Sets the merge kind of the application.
|
a AsApp instance. |
|
the AsAppMergeKind. |
Since 0.6.1
void as_app_set_state (AsApp *app
,AsAppState state
);
Sets the application state.
|
a AsApp instance. |
|
the AsAppState. |
Since 0.2.2
void as_app_set_trust_flags (AsApp *app
,guint32 trust_flags
);
Sets the check flags, where AS_APP_TRUST_FLAG_COMPLETE
is completely
trusted input.
|
a AsApp instance. |
|
the AsAppTrustFlags. |
Since 0.2.2
void as_app_set_search_match (AsApp *app
,guint16 search_match
);
Sets the token match fields. The bitfield given here is used to choose what is included in the token cache.
|
a AsApp instance. |
|
the AsAppSearchMatch, e.g. AS_APP_SEARCH_MATCH_PKGNAME
|
Since 0.6.13
void as_app_set_origin (AsApp *app
,const gchar *origin
);
Sets the application origin.
|
a AsApp instance. |
|
the origin, e.g. "fedora-21" |
Since 0.3.2
void as_app_set_project_group (AsApp *app
,const gchar *project_group
);
Set any project affiliation.
|
a AsApp instance. |
|
the project group, e.g. "GNOME". |
Since 0.1.0
void as_app_set_project_license (AsApp *app
,const gchar *project_license
);
Set the project license.
|
a AsApp instance. |
|
the project license string. |
Since 0.1.0
void as_app_set_metadata_license (AsApp *app
,const gchar *metadata_license
);
Set the project license.
|
a AsApp instance. |
|
the project license string. |
Since 0.1.4
void as_app_set_source_pkgname (AsApp *app
,const gchar *source_pkgname
);
Set the project license.
|
a AsApp instance. |
|
the project license string. |
Since 0.2.4
void as_app_set_update_contact (AsApp *app
,const gchar *update_contact
);
Set the project license.
|
a AsApp instance. |
|
the project license string. |
Since 0.1.4
void as_app_set_icon_path (AsApp *app
,const gchar *icon_path
);
Sets the icon path, where local icons would be found.
|
a AsApp instance. |
|
the local path. |
Since 0.1.0
void as_app_set_name (AsApp *app
,const gchar *locale
,const gchar *name
);
Sets the application name for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
|
the application name. |
Since 0.1.0
void as_app_set_comment (AsApp *app
,const gchar *locale
,const gchar *comment
);
Sets the application summary for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
|
the application summary. |
Since 0.1.0
void as_app_set_developer_name (AsApp *app
,const gchar *locale
,const gchar *developer_name
);
Sets the application developer name for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
|
the application developer name. |
Since 0.1.0
void as_app_set_description (AsApp *app
,const gchar *locale
,const gchar *description
);
Sets the application descrption markup for a specific locale.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
|
the application description. |
Since 0.1.0
void as_app_set_branch (AsApp *app
,const gchar *branch
);
Set the branch that the instance was sourced from.
|
a AsApp instance. |
|
the branch, e.g. "master" or "3-16". |
Since 0.6.1
void as_app_set_priority (AsApp *app
,gint priority
);
Sets the application priority, where 0 is default and positive numbers are better than negative numbers.
|
a AsApp instance. |
|
the priority. |
Since 0.1.0
void as_app_add_category (AsApp *app
,const gchar *category
);
Adds a menu category to the application.
|
a AsApp instance. |
|
the category. |
Since 0.1.0
void as_app_remove_category (AsApp *app
,const gchar *category
);
Removed a menu category from the application.
|
a AsApp instance. |
|
the category. |
Since 0.6.13
void as_app_add_keyword (AsApp *app
,const gchar *locale
,const gchar *keyword
);
Add a keyword the application should match against.
|
a AsApp instance. |
|
the locale. e.g. "en_GB". [nullable] |
|
the keyword. |
Since 0.3.0
void as_app_add_kudo (AsApp *app
,const gchar *kudo
);
Add a kudo the application has obtained.
|
a AsApp instance. |
|
the kudo. |
Since 0.2.2
void as_app_remove_kudo (AsApp *app
,const gchar *kudo
);
Remove a kudo the application has obtained.
|
a AsApp instance. |
|
the kudo. |
Since 0.6.13
void as_app_add_kudo_kind (AsApp *app
,AsKudoKind kudo_kind
);
Add a kudo the application has obtained.
|
a AsApp instance. |
|
the AsKudoKind. |
Since 0.2.2
void as_app_add_permission (AsApp *app
,const gchar *permission
);
Add a permission the application has obtained.
|
a AsApp instance. |
|
the permission. |
Since 0.3.5
void as_app_add_format (AsApp *app
,AsFormat *format
);
Add a format the application has been built from.
|
a AsApp instance. |
|
the AsFormat. |
Since 0.6.9
void as_app_remove_format (AsApp *app
,AsFormat *format
);
Removes a format the application has been built from.
|
a AsApp instance. |
|
the AsFormat. |
Since 0.6.9
void as_app_add_mimetype (AsApp *app
,const gchar *mimetype
);
Adds a mimetype the application can process.
|
a AsApp instance. |
|
the mimetype. |
Since 0.1.0
void as_app_add_pkgname (AsApp *app
,const gchar *pkgname
);
Adds a package name to an application.
|
a AsApp instance. |
|
the package name. |
Since 0.1.0
void as_app_add_arch (AsApp *app
,const gchar *arch
);
Adds a package name to an application.
|
a AsApp instance. |
|
the package name. |
Since 0.1.1
void as_app_add_release (AsApp *app
,AsRelease *release
);
Adds a release to an application.
|
a AsApp instance. |
|
a AsRelease instance. |
Since 0.1.0
void as_app_add_provide (AsApp *app
,AsProvide *provide
);
Adds a provide to an application.
|
a AsApp instance. |
|
a AsProvide instance. |
Since 0.1.6
void as_app_add_launchable (AsApp *app
,AsLaunchable *launchable
);
Adds a launchable to an application.
|
a AsApp instance. |
|
a AsLaunchable instance. |
Since 0.6.13
void as_app_add_screenshot (AsApp *app
,AsScreenshot *screenshot
);
Adds a screenshot to an application.
|
a AsApp instance. |
|
a AsScreenshot instance. |
Since 0.1.0
void as_app_add_review (AsApp *app
,AsReview *review
);
Adds a review to an application.
|
a AsApp instance. |
|
a AsReview instance. |
Since 0.6.1
void as_app_add_content_rating (AsApp *app
,AsContentRating *content_rating
);
Adds a content_rating to an application.
|
a AsApp instance. |
|
a AsContentRating instance. |
Since 0.5.12
void as_app_add_agreement (AsApp *app
,AsAgreement *agreement
);
Adds a agreement to an application.
|
a AsApp instance. |
|
a AsAgreement instance. |
Since 0.7.8
void as_app_add_icon (AsApp *app
,AsIcon *icon
);
Adds a icon to an application.
|
a AsApp instance. |
|
a AsIcon instance. |
Since 0.3.1
void as_app_add_bundle (AsApp *app
,AsBundle *bundle
);
Adds a bundle to an application.
|
a AsApp instance. |
|
a AsBundle instance. |
Since 0.3.5
void as_app_add_translation (AsApp *app
,AsTranslation *translation
);
Adds a translation to an application.
|
a AsApp instance. |
|
a AsTranslation instance. |
Since 0.5.8
void as_app_add_suggest (AsApp *app
,AsSuggest *suggest
);
Adds a suggest to an application.
|
a AsApp instance. |
|
a AsSuggest instance. |
Since 0.6.1
void as_app_add_require (AsApp *app
,AsRequire *require
);
Adds a require to an application.
|
a AsApp instance. |
|
a AsRequire instance. |
Since 0.6.7
void as_app_add_language (AsApp *app
,gint percentage
,const gchar *locale
);
Adds a language to the application.
|
a AsApp instance. |
|
the percentage completion of the translation, or 0 for unknown |
|
the locale. e.g. "en_GB". [nullable] |
Since 0.1.0
void as_app_add_compulsory_for_desktop (AsApp *app
,const gchar *compulsory_for_desktop
);
Adds a desktop that requires this application to be installed.
|
a AsApp instance. |
|
the desktop string, e.g. "GNOME". |
Since 0.1.0
void as_app_add_url (AsApp *app
,AsUrlKind url_kind
,const gchar *url
);
Adds some URL data to the application.
|
a AsApp instance. |
|
the URL kind, e.g. AS_URL_KIND_HOMEPAGE
|
|
the full URL. |
Since 0.1.0
void as_app_add_metadata (AsApp *app
,const gchar *key
,const gchar *value
);
Adds a metadata entry to the application.
|
a AsApp instance. |
|
the metadata key. |
|
the value to store. |
Since 0.1.0
void as_app_remove_metadata (AsApp *app
,const gchar *key
);
Removes a metadata item from the application.
|
a AsApp instance. |
|
the metadata key. |
Since 0.1.0
void as_app_add_addon (AsApp *app
,AsApp *addon
);
Adds a addon to an application.
|
a AsApp instance. |
|
a AsApp instance. |
Since 0.1.7
void as_app_add_extends (AsApp *app
,const gchar *extends
);
Adds a parent ID to the application.
|
a AsApp instance. |
|
the full ID, e.g. "eclipse.desktop". |
Since 0.1.7
void as_app_add_quirk (AsApp *app
,AsAppQuirk quirk
);
Adds a specific attribute to an application.
|
a AsApp instance. |
|
the AsAppQuirk, e.g. AS_APP_QUIRK_PROVENANCE
|
Since 0.5.10
GPtrArray * as_app_validate (AsApp *app
,guint32 flags
,GError **error
);
Validates data in the instance for style and consitency.
|
a AsApp instance. |
|
the AsAppValidateFlags to use, e.g. AS_APP_VALIDATE_FLAG_NONE
|
|
A GError or NULL . |
Returns : |
A list of problems, or NULL . [transfer container][element-type AsProblem]
|
Since 0.1.4
void as_app_subsume (AsApp *app
,AsApp *donor
);
Copies information from the donor to the application object.
|
a AsApp instance. |
|
the donor. |
Since 0.1.0
void as_app_subsume_full (AsApp *app
,AsApp *donor
,guint64 flags
);
Copies information from the donor to the application object.
|
a AsApp instance. |
|
the donor. |
|
any optional AsAppSubsumeFlags, e.g. AS_APP_SUBSUME_FLAG_NO_OVERWRITE
|
Since 0.1.4
void as_app_add_veto (AsApp *app
,const gchar *fmt
,...
);
Adds a reason to not include the application in the metadata.
|
A AsApp |
|
format string |
|
varargs |
Since 0.2.5
void as_app_remove_veto (AsApp *app
,const gchar *description
);
Removes a reason to not include the application in the metadata.
|
A AsApp |
|
veto string |
Since 0.4.1
guint as_app_search_matches_all (AsApp *app
,gchar **search
);
Searches application data for all the specific keywords.
|
a AsApp instance. |
|
the search terms. |
Returns : |
a match scrore, where 0 is no match and larger numbers are better
matches.
It's probably a good idea to use as_utils_search_tokenize() to populate
search as very short or common keywords will return a lot of matches. |
Since 0.1.3
guint as_app_search_matches (AsApp *app
,const gchar *search
);
Searches application data for a specific keyword.
|
a AsApp instance. |
|
the search term. |
Returns : |
a match scrore, where 0 is no match and 100 is the best match. |
Since 0.1.0
gboolean as_app_parse_file (AsApp *app
,const gchar *filename
,guint32 flags
,GError **error
);
Parses a desktop or AppData file and populates the application state.
Applications that are not suitable for the store will have vetos added.
|
a AsApp instance. |
|
file to load. |
|
AsAppParseFlags, e.g. AS_APP_PARSE_FLAG_USE_HEURISTICS
|
|
A GError or NULL . |
Returns : |
TRUE for success |
Since 0.1.2
gboolean as_app_parse_data (AsApp *app
,GBytes *data
,guint32 flags
,GError **error
);
Parses an AppData file and populates the application state.
|
a AsApp instance. |
|
data to parse. |
|
AsAppParseFlags, e.g. AS_APP_PARSE_FLAG_USE_HEURISTICS
|
|
A GError or NULL . |
Returns : |
TRUE for success |
Since 0.7.5
gboolean as_app_to_file (AsApp *app
,GFile *file
,GCancellable *cancellable
,GError **error
);
Exports a DOM tree to an XML file.
|
a AsApp instance. |
|
a GFile |
|
A GCancellable. [nullable] |
|
A GError or NULL
|
Returns : |
TRUE for success |
Since 0.2.0
AsContentRating * as_app_get_content_rating (AsApp *app
,const gchar *kind
);
Gets a content ratings the application has defined of a specific type.
|
a AsApp instance. |
|
a ratings kind, e.g. "oars-1.0" |
Returns : |
a AsContentRating or NULL for not found. [transfer none] |
Since 0.5.12
AsAgreement * as_app_get_agreement_by_kind (AsApp *app
,AsAgreementKind kind
);
Gets a agreement the application has defined of a specific type.
|
a AsApp instance. |
|
an agreement kind, e.g. AS_AGREEMENT_KIND_EULA
|
Returns : |
a AsAgreement or NULL for not found. [transfer none] |
Since 0.7.8
AsAgreement * as_app_get_agreement_default (AsApp *app
);
Gets a privacy policys the application has defined of a specific type.
|
a AsApp instance. |
Returns : |
a AsAgreement or NULL for not found. [transfer none] |
Since 0.7.8
AsScreenshot * as_app_get_screenshot_default (AsApp *app
);
Gets the default screenshot for the component.
|
a AsApp instance. |
Returns : |
a screenshot or NULL . [transfer none]
|
Since 0.7.3
AsIcon * as_app_get_icon_default (AsApp *app
);
Finds the default icon.
|
A AsApp |
Returns : |
a AsIcon, or NULL . [transfer none]
|
Since 0.3.1
AsIcon * as_app_get_icon_for_size (AsApp *app
,guint width
,guint height
);
Finds an icon of a specific size.
|
A AsApp |
|
Size in pixels |
|
Size in pixels |
Returns : |
a AsIcon, or NULL . [transfer none]
|
Since 0.3.1
AsBundle * as_app_get_bundle_default (AsApp *app
);
Finds the default bundle.
|
A AsApp |
Returns : |
a AsBundle, or NULL . [transfer none]
|
Since 0.3.5
AsRelease * as_app_get_release (AsApp *app
,const gchar *version
);
Gets a specific release from the application.
|
a AsApp instance. |
|
a version string |
Returns : |
a release, or NULL . [transfer none]
|
Since 0.3.5
AsRelease * as_app_get_release_default (AsApp *app
);
Gets the default (newest) release from the application.
|
a AsApp instance. |
Returns : |
a release, or NULL . [transfer none]
|
Since 0.3.5
AsRelease * as_app_get_release_by_version (AsApp *app
,const gchar *version
);
Gets a specific release from the application.
|
a AsApp instance. |
|
a release version number, e.g. "1.2.3" |
Returns : |
a release, or NULL . [transfer none]
|
Since 0.7.3
AsRequire * as_app_get_require_by_value (AsApp *app
,AsRequireKind kind
,const gchar *value
);
Gets a specific requirement for the application.
|
a AsApp instance. |
|
a AsRequireKind, e.g. AS_REQUIRE_KIND_FIRMWARE
|
|
a string, or NULL, e.g. `bootloader` |
Returns : |
A AsRequire, or NULL for not found. [transfer none]
|
Since 0.6.7
gboolean as_app_convert_icons (AsApp *app
,AsIconKind kind
,GError **error
);
Converts all the icons in the application to a specific kind.
|
A AsApp. |
|
the AsIconKind, e.g. AS_ICON_KIND_EMBEDDED . |
|
A GError or NULL
|
Returns : |
TRUE for success |
Since 0.3.1
gboolean as_app_equal (AsApp *app1
,AsApp *app2
);
Compare one application with another for equality using the following properties:
1. scope, e.g. `system` or `user` 2. bundle kind, e.g. `package` or `flatpak` 3. origin, e.g. `fedora` or `gnome-apps-nightly` 4. kind, e.g. `app` or `runtime` 5. AppStream ID, e.g. `gimp.desktop` 6. branch, e.g. `stable` or `master`
|
a AsApp instance. |
|
another AsApp instance. |
Returns : |
TRUE if the applications are equal |
Since 0.6.1
AsIdKind as_app_get_id_kind (AsApp *app
);
Gets the ID kind.
|
a AsApp instance. |
Returns : |
enumerated value |
Since 0.1.0
void as_app_set_id_kind (AsApp *app
,AsIdKind id_kind
);
Sets the application kind.
|
a AsApp instance. |
|
the AsAppKind. |
Since 0.1.0
void as_app_set_source_file (AsApp *app
,const gchar *source_file
);
Set the file that the instance was sourced from.
|
a AsApp instance. |
|
the filename. |
Since 0.2.2
const gchar * as_app_get_source_file (AsApp *app
);
Gets the default source filename the instance was populated from.
|
a AsApp instance. |
Returns : |
string, or NULL if unset |
Since 0.2.2
AsFormatKind as_app_get_source_kind (AsApp *app
);
Gets the source kind, i.e. where the AsApp came from.
|
a AsApp instance. |
Returns : |
enumerated value |
Since 0.1.4
void as_app_set_source_kind (AsApp *app
,AsFormatKind source_kind
);
Sets the source kind.
|
a AsApp instance. |
|
the AsFormatKind. |
Since 0.1.4
AsFormatKind as_app_source_kind_from_string (const gchar *source_kind
);
Converts the text representation to an enumerated value.
|
a source kind string |
Returns : |
A AsFormatKind, e.g. AS_FORMAT_KIND_APPSTREAM . |
Since 0.2.2
const gchar * as_app_source_kind_to_string (AsFormatKind source_kind
);
Converts the enumerated value to an text representation.
|
the AsFormatKind. |
Returns : |
string version of source_kind , or NULL for unknown |
Since 0.2.2
AsFormatKind as_app_guess_source_kind (const gchar *filename
);
Guesses the source kind based from the filename.
|
a file name |
Returns : |
A AsFormatKind, e.g. AS_FORMAT_KIND_APPSTREAM . |
Since 0.1.8