Top | ![]() |
![]() |
![]() |
![]() |
enum | AsAppParseFlags |
enum | AsAppSubsumeFlags |
enum | AsAppError |
enum | AsAppValidateFlags |
enum | AsAppTrustFlags |
enum | AsAppSourceKind |
enum | AsAppState |
#define | AS_APP_ERROR |
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
AsAppSourceKind
as_app_guess_source_kind (const gchar *filename
);
Guesses the source kind based from the filename.
Since 0.1.8
AsAppSourceKind
as_app_source_kind_from_string (const gchar *source_kind
);
Converts the text representation to an enumerated value.
Since 0.2.2
const gchar *
as_app_source_kind_to_string (AsAppSourceKind source_kind
);
Converts the enumerated value to an text representation.
Since 0.2.2
const gchar *
as_app_state_to_string (AsAppState state
);
Converts the enumerated value to an text representation.
Since 0.2.2
AsIconKind
as_app_get_icon_kind (AsApp *app
);
Gets the icon kind.
Since 0.1.0
AsAppSourceKind
as_app_get_source_kind (AsApp *app
);
Gets the source kind, i.e. where the AsApp came from.
Since 0.1.4
AsAppState
as_app_get_state (AsApp *app
);
Gets the application state.
Since 0.2.2
AsAppTrustFlags
as_app_get_trust_flags (AsApp *app
);
Gets the trust flags, i.e. how trusted the incoming data is.
Since 0.2.2
GList *
as_app_get_languages (AsApp *app
);
Get a list of all languages.
Since 0.1.0
GPtrArray *
as_app_get_addons (AsApp *app
);
Gets all the addons the application has.
Since 0.1.7
GPtrArray *
as_app_get_categories (AsApp *app
);
Get the application categories.
Since 0.1.0
GPtrArray *
as_app_get_compulsory_for_desktops (AsApp *app
);
Returns the desktops where this application is compulsory.
Since 0.1.0
GPtrArray *
as_app_get_extends (AsApp *app
);
Gets the IDs that are extended from the addon.
Since 0.1.7
GPtrArray * as_app_get_keywords (AsApp *app
,const gchar *locale
);
Gets any keywords the application should match against.
Since 0.3.0
GPtrArray *
as_app_get_kudos (AsApp *app
);
Gets any kudos the application has obtained.
Since 0.2.2
GPtrArray *
as_app_get_mimetypes (AsApp *app
);
Gets any mimetypes the application will register.
Since 0.2.0
GPtrArray *
as_app_get_pkgnames (AsApp *app
);
Gets the package names (if any) for the application.
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.
Since 0.1.1
GPtrArray *
as_app_get_releases (AsApp *app
);
Gets all the releases the application has had.
Since 0.1.0
GPtrArray *
as_app_get_provides (AsApp *app
);
Gets all the provides the application has.
Since 0.1.6
GPtrArray *
as_app_get_screenshots (AsApp *app
);
Gets any screenshots the application has defined.
Since 0.1.0
GHashTable *
as_app_get_names (AsApp *app
);
Gets the names set for the application.
Since 0.1.6
GHashTable *
as_app_get_comments (AsApp *app
);
Gets the comments set for the application.
Since 0.1.6
GHashTable *
as_app_get_developer_names (AsApp *app
);
Gets the developer_names set for the application.
Since 0.1.8
GHashTable *
as_app_get_metadata (AsApp *app
);
Gets the metadata set for the application.
Since 0.1.6
GHashTable *
as_app_get_descriptions (AsApp *app
);
Gets the descriptions set for the application.
Since 0.1.6
GHashTable *
as_app_get_urls (AsApp *app
);
Gets the URLs set for the application.
Since 0.1.0
const gchar *
as_app_get_icon (AsApp *app
);
Gets the application icon. Use as_app_get_icon_path()
if you need the create
a full filename.
Since 0.1.0
const gchar *
as_app_get_icon_path (AsApp *app
);
Gets the application icon path.
Since 0.1.0
const gchar *
as_app_get_pkgname_default (AsApp *app
);
Gets the default package name.
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.
Since 0.2.4
const gchar *
as_app_get_project_group (AsApp *app
);
Gets an application project group.
Since 0.1.0
const gchar *
as_app_get_project_license (AsApp *app
);
Gets the application project license.
Since 0.1.0
const gchar *
as_app_get_metadata_license (AsApp *app
);
Gets the application project license.
Since 0.1.4
const gchar *
as_app_get_update_contact (AsApp *app
);
Gets the application upstream update contact email.
Since 0.1.4
const gchar *
as_app_get_source_file (AsApp *app
);
Gets the source filename the instance was populated from.
NOTE: this is not set for AS_APP_SOURCE_KIND_APPSTREAM
entries.
Since 0.2.2
const gchar * as_app_get_name (AsApp *app
,const gchar *locale
);
Gets the application name for a specific locale.
Since 0.1.0
const gchar * as_app_get_comment (AsApp *app
,const gchar *locale
);
Gets the application summary for a specific locale.
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.
Since 0.1.8
const gchar * as_app_get_description (AsApp *app
,const gchar *locale
);
Gets the application description markup for a specific locale.
Since 0.1.0
gint
as_app_get_priority (AsApp *app
);
Gets the application priority. Larger values trump smaller values.
Since 0.1.0
gint as_app_get_language (AsApp *app
,const gchar *locale
);
Gets the language coverage for the specific language.
Since 0.1.0
const gchar * as_app_get_metadata_item (AsApp *app
,const gchar *key
);
Gets some metadata item.
Since 0.1.0
const gchar * as_app_get_url_item (AsApp *app
,AsUrlKind url_kind
);
Gets a URL.
Since 0.1.0
gboolean as_app_has_category (AsApp *app
,const gchar *category
);
Searches the category list for a specific item.
Since 0.1.5
gboolean as_app_has_kudo (AsApp *app
,const gchar *kudo
);
Searches the kudo list for a specific item.
Since 0.2.2
gboolean as_app_has_kudo_kind (AsApp *app
,AsKudoKind kudo
);
Searches the kudo list for a specific item.
Since 0.2.2
void as_app_set_id_kind (AsApp *app
,AsIdKind id_kind
);
Sets the application kind.
Since 0.1.0
void as_app_set_source_kind (AsApp *app
,AsAppSourceKind source_kind
);
Sets the source kind.
Since 0.1.4
void as_app_set_state (AsApp *app
,AsAppState state
);
Sets the application state.
Since 0.2.2
void as_app_set_trust_flags (AsApp *app
,AsAppTrustFlags trust_flags
);
Sets the check flags, where AS_APP_TRUST_FLAG_COMPLETE
is completely
trusted input.
Since 0.2.2
void as_app_set_project_group (AsApp *app
,const gchar *project_group
,gssize project_group_len
);
Set any project affiliation.
app |
a AsApp instance. |
|
project_group |
the project group, e.g. "GNOME". |
|
project_group_len |
the size of |
Since 0.1.0
void as_app_set_project_license (AsApp *app
,const gchar *project_license
,gssize project_license_len
);
Set the project license.
app |
a AsApp instance. |
|
project_license |
the project license string. |
|
project_license_len |
the size of |
Since 0.1.0
void as_app_set_metadata_license (AsApp *app
,const gchar *metadata_license
,gssize metadata_license_len
);
Set the project license.
app |
a AsApp instance. |
|
metadata_license |
the project license string. |
|
metadata_license_len |
the size of |
Since 0.1.4
void as_app_set_source_pkgname (AsApp *app
,const gchar *source_pkgname
,gssize source_pkgname_len
);
Set the project license.
app |
a AsApp instance. |
|
source_pkgname |
the project license string. |
|
source_pkgname_len |
the size of |
Since 0.2.4
void as_app_set_update_contact (AsApp *app
,const gchar *update_contact
,gssize update_contact_len
);
Set the project license.
app |
a AsApp instance. |
|
update_contact |
the project license string. |
|
update_contact_len |
the size of |
Since 0.1.4
void as_app_set_icon (AsApp *app
,const gchar *icon
,gssize icon_len
);
Set the application icon.
app |
a AsApp instance. |
|
icon |
the icon filename or URL. |
|
icon_len |
the size of |
Since 0.1.0
void as_app_set_icon_path (AsApp *app
,const gchar *icon_path
,gssize icon_path_len
);
Sets the icon path, where local icons would be found.
app |
a AsApp instance. |
|
icon_path |
the local path. |
|
icon_path_len |
the size of |
Since 0.1.0
void as_app_set_icon_kind (AsApp *app
,AsIconKind icon_kind
);
Sets the icon kind.
Since 0.1.0
void as_app_set_name (AsApp *app
,const gchar *locale
,const gchar *name
,gssize name_len
);
Sets the application name for a specific locale.
app |
a AsApp instance. |
|
locale |
the locale, or |
|
name |
the application name. |
|
name_len |
the size of |
Since 0.1.0
void as_app_set_comment (AsApp *app
,const gchar *locale
,const gchar *comment
,gssize comment_len
);
Sets the application summary for a specific locale.
app |
a AsApp instance. |
|
locale |
the locale, or |
|
comment |
the application summary. |
|
comment_len |
the size of |
Since 0.1.0
void as_app_set_developer_name (AsApp *app
,const gchar *locale
,const gchar *developer_name
,gssize developer_name_len
);
Sets the application developer name for a specific locale.
app |
a AsApp instance. |
|
locale |
the locale, or |
|
developer_name |
the application developer name. |
|
developer_name_len |
the size of |
Since 0.1.0
void as_app_set_description (AsApp *app
,const gchar *locale
,const gchar *description
,gssize description_len
);
Sets the application descrption markup for a specific locale.
app |
a AsApp instance. |
|
locale |
the locale, or |
|
description |
the application description. |
|
description_len |
the size of |
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.
Since 0.2.2
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.
Since 0.1.0
void as_app_add_category (AsApp *app
,const gchar *category
,gssize category_len
);
Adds a menu category to the application.
app |
a AsApp instance. |
|
category |
the category. |
|
category_len |
the size of |
Since 0.1.0
void as_app_add_keyword (AsApp *app
,const gchar *locale
,const gchar *keyword
,gssize keyword_len
);
Add a keyword the application should match against.
app |
a AsApp instance. |
|
locale |
the locale, or |
|
keyword |
the keyword. |
|
keyword_len |
the size of |
Since 0.3.0
void as_app_add_kudo (AsApp *app
,const gchar *kudo
,gssize kudo_len
);
Add a kudo the application has obtained.
app |
a AsApp instance. |
|
kudo |
the kudo. |
|
kudo_len |
the size of |
Since 0.2.2
void as_app_add_kudo_kind (AsApp *app
,AsKudoKind kudo_kind
);
Add a kudo the application has obtained.
Since 0.2.2
void as_app_add_mimetype (AsApp *app
,const gchar *mimetype
,gssize mimetype_len
);
Adds a mimetype the application can process.
app |
a AsApp instance. |
|
mimetype |
the mimetype. |
|
mimetype_len |
the size of |
Since 0.1.0
void as_app_add_pkgname (AsApp *app
,const gchar *pkgname
,gssize pkgname_len
);
Adds a package name to an application.
app |
a AsApp instance. |
|
pkgname |
the package name. |
|
pkgname_len |
the size of |
Since 0.1.0
void as_app_add_arch (AsApp *app
,const gchar *arch
,gssize arch_len
);
Adds a package name to an application.
app |
a AsApp instance. |
|
arch |
the package name. |
|
arch_len |
the size of |
Since 0.1.1
void as_app_add_release (AsApp *app
,AsRelease *release
);
Adds a release to an application.
Since 0.1.0
void as_app_add_provide (AsApp *app
,AsProvide *provide
);
Adds a provide to an application.
Since 0.1.6
void as_app_add_screenshot (AsApp *app
,AsScreenshot *screenshot
);
Adds a screenshot to an application.
Since 0.1.0
void as_app_add_language (AsApp *app
,gint percentage
,const gchar *locale
,gssize locale_len
);
Adds a language to the application.
app |
a AsApp instance. |
|
percentage |
the percentage completion of the translation, or 0 for unknown |
|
locale |
the locale, or |
|
locale_len |
the size of |
Since 0.1.0
void as_app_add_compulsory_for_desktop (AsApp *app
,const gchar *compulsory_for_desktop
,gssize compulsory_for_desktop_len
);
Adds a desktop that requires this application to be installed.
app |
a AsApp instance. |
|
compulsory_for_desktop |
the desktop string, e.g. "GNOME". |
|
compulsory_for_desktop_len |
the size of |
Since 0.1.0
void as_app_add_url (AsApp *app
,AsUrlKind url_kind
,const gchar *url
,gssize url_len
);
Adds some URL data to the application.
app |
a AsApp instance. |
|
url_kind |
the URL kind, e.g. |
|
url |
the full URL. |
|
url_len |
the size of |
Since 0.1.0
void as_app_add_metadata (AsApp *app
,const gchar *key
,const gchar *value
,gssize value_len
);
Adds a metadata entry to the application.
app |
a AsApp instance. |
|
key |
the metadata key. |
|
value |
the value to store. |
|
value_len |
the size of |
Since 0.1.0
void as_app_remove_metadata (AsApp *app
,const gchar *key
);
Removes a metadata item from the application.
Since 0.1.0
void as_app_add_addon (AsApp *app
,AsApp *addon
);
Adds a addon to an application.
Since 0.1.7
void as_app_add_extends (AsApp *app
,const gchar *extends
,gssize extends_len
);
Adds a parent ID to the application.
app |
a AsApp instance. |
|
extends |
the full ID, e.g. "eclipse.desktop". |
|
extends_len |
the size of |
Since 0.1.7
GPtrArray * as_app_validate (AsApp *app
,AsAppValidateFlags flags
,GError **error
);
Validates data in the instance for style and consitency.
app |
a AsApp instance. |
|
flags |
the AsAppValidateFlags to use, e.g. |
|
error |
A GError or |
Since 0.1.4
void as_app_subsume (AsApp *app
,AsApp *donor
);
Copies information from the donor to the application object.
Since 0.1.0
void as_app_subsume_full (AsApp *app
,AsApp *donor
,AsAppSubsumeFlags flags
);
Copies information from the donor to the application object.
app |
a AsApp instance. |
|
donor |
the donor. |
|
flags |
any optional flags, e.g. |
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.
Since 0.2.5
guint as_app_search_matches_all (AsApp *app
,gchar **search
);
Searches application data for all the specific keywords.
Since 0.1.3
guint as_app_search_matches (AsApp *app
,const gchar *search
);
Searches application data for a specific keyword.
Since 0.1.0
gboolean as_app_parse_file (AsApp *app
,const gchar *filename
,AsAppParseFlags 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.
Since 0.1.2
The flags to use when parsing resources.
The application state.