AppStreamCompose.Compose
Description: Reference for AppStreamCompose.Compose

### Class

# AppStreamComposeCompose

#### Description

    class AppStreamCompose.Compose : GObject.Object
    {
      /* No available fields */
    }

No description available.

#### Ancestors

- GObject

#### Constructors

###### asc_compose_new

Creates a new `AscCompose`.

since: 0.14.5

#### Instance methods

###### asc_compose_add_allowed_cid

Adds a component ID to the allowlist. If the list is not empty, only components in the list will be added to the metadata output.

since: 0.14.5

###### asc_compose_add_custom_allowed

Add a key to the allowlist that is used to filter custom tag values.

since: 0.15.1

###### asc_compose_add_flags

Add compose flags.

since: 0.15.1

###### asc_compose_add_unit

Add an `AscUnit` as data source for metadata processing.

since: 0.14.5

###### asc_compose_fetch_components

Get the results components extracted in the last data processing run.

since: 0.14.5

###### asc_compose_finalize_result

Perform final validation of generated data for the specified result container.

since: 0.15.1

###### asc_compose_finalize_results

Perform final validation of generated data. Calling this function is not necessary, unless the final check was explicitly disabled using the `ASC_COMPOSE_FLAG_NO_FINAL_CHECK` flag.

since: 0.15.1

###### asc_compose_get_cainfo

Get the CA file used to verify peers with, or `NULL` for default.

since: 0.15.2

###### asc_compose_get_data_result_dir

Get the data result directory.

since: 0.14.5

###### asc_compose_get_flags

Get the flags controlling compose behavior.

since: 0.14.5

###### asc_compose_get_format

Get the format type we are generating.

since: 0.14.5

###### asc_compose_get_hints_result_dir

Get hints report output directory.

since: 0.14.5

###### asc_compose_get_icon_policy

Get the policy for how icons should be distributed to any AppStream clients.

since: 0.15.1

###### asc_compose_get_icons_result_dir

Get the icon result directory.

since: 0.14.5

###### asc_compose_get_image_format

Get the file format that generated icons and screenshots are stored in. This is unrelated to %asc_compose_get_format, which selects the format of the generated catalog metadata.

since: 1.2.0

###### asc_compose_get_locale_unit

Get the unit we use for locale processing.

since: 0.15.1

###### asc_compose_get_max_screenshot_size

Get the maximum size a screenshot video or image can have. A size < 0 may be returned for no limit, setting a limit of 0 will disable screenshots.

since: 0.15.1

###### asc_compose_get_media_baseurl

Get the media base URL to be used for the generated data, or `NULL` if no media is cached.

since: 0.14.5

###### asc_compose_get_media_result_dir

Get the media result directory, that can be served on a webserver.

since: 0.14.5

###### asc_compose_get_origin

Get the metadata origin field.

since: 0.14.5

###### asc_compose_get_prefix

Get the directory prefix used for processing.

since: 0.14.5

###### asc_compose_get_results

Get the results of the last processing run.

since: 0.14.5

###### asc_compose_has_errors

Check if the last run generated any errors (which will cause metadata to be ignored).

since: 0.14.5

###### asc_compose_remove_custom_allowed

Remove a key from the allowlist used to filter the `<custom/>` tag entries.

since: 0.15.1

###### asc_compose_remove_flags

Remove compose flags.

since: 0.15.1

###### asc_compose_reset

Drop the results, the registered units and the allowed component-ID list of the last run, so the instance can be reused for another metadata generation run. Everything else - flags, result directories, icon policy, media instance, locale unit, allowed custom keys and the callbacks - is retained.

since: 0.14.5

###### asc_compose_run

Process the registered units and generate catalog metadata from found components.

since: 0.14.5

###### asc_compose_set_cainfo

Set a CA file holding one or more certificates to verify peers with for download operations performed by this `AscCompose`.

since: 0.15.2

###### asc_compose_set_check_metadata_early_func

Set an custom callback to be run when most of the metadata has been loaded, but no expensive operations (like downloads or icon rendering) have been done yet. This can be used to ignore unwanted components early on.

since: 0.15.1

###### asc_compose_set_data_result_dir

Set an output location where generated metadata should be saved. If this is set to `NULL`, no metadata will be saved.

since: 0.14.5

###### asc_compose_set_desktop_entry_l10n_func

Set a custom desktop-entry field localization functions to be run for specialized desktop-entry localization schemes such as used in Ubuntu.

since: 0.15.1

###### asc_compose_set_flags

Set compose flags bitfield that controls the enabled features for this `AscCompose`.

since: 0.14.5

###### asc_compose_set_format

Set the format kind of the catalog metadata that we should generate.

since: 0.14.5

###### asc_compose_set_hints_result_dir

Set an output location for HTML reports of issues generated during a compose run.

since: 0.14.5

###### asc_compose_set_icon_policy

Set an icon policy object, overriding the existing one.

since: 0.15.1

###### asc_compose_set_icons_result_dir

Set an output location where plain icons for the processed metadata are stored.

since: 0.14.5

###### asc_compose_set_image_format

Set the file format that generated icons and screenshots should be stored in. We only support `ASC_IMAGE_FORMAT_JXL` (the default) and `ASC_IMAGE_FORMAT_PNG` here, any other format is rejected.

since: 1.2.0

###### asc_compose_set_locale_unit

Set a specific unit that is used for fetching locale information. This may be useful in case a special language pack layout is used, but is generally not necessary to be set explicitly, as locale will be found in the unit where the metadata is by default.

since: 0.15.1

###### asc_compose_set_max_screenshot_size

Set the maximum size a screenshot video or image can have. A size < 0 may be set to allow unlimited sizes, setting a limit of 0 will disable screenshot caching entirely.

since: 0.15.1

###### asc_compose_set_media

Set a media processing interface to use for every unit that this compose object processes (otherwise it will create a fresh one per unit/thread that it uses). This allows a caller that wants to use an `AscMedia` itself or that composes many units in sequence to amortize the cost of starting a second media worker.

since: 1.2.0

###### asc_compose_set_media_baseurl

Set the media base URL for the generated metadata. Can be `NULL` if no media should be cached and the original URLs should be kept.

since: 0.14.5

###### asc_compose_set_media_result_dir

Set an output location to store media (screenshots, icons, …) that will be served on a webserver via the URL set as media baseurl.

since: 0.14.5

###### asc_compose_set_origin

Set the metadata origin field (e.g. “debian” or “flathub”).

since: 0.14.5

###### asc_compose_set_prefix

Set the directory prefix the to-be-processed units are using.

since: 0.14.5

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct AppStreamComposeComposeClass {
      GObjectClass parent_class;
      void (* _as_reserved1) (
    void
      );
      void (* _as_reserved2) (
    void
      );
      void (* _as_reserved3) (
    void
      );
      void (* _as_reserved4) (
    void
      );

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.

`_as_reserved1: void (* _as_reserved1) ( void )`

  No description available.

`_as_reserved2: void (* _as_reserved2) ( void )`

  No description available.

`_as_reserved3: void (* _as_reserved3) ( void )`

  No description available.

`_as_reserved4: void (* _as_reserved4) ( void )`

  No description available.