:right-sidebar: True

InstalledRef
===================================================================

.. currentmodule:: gi.repository.Flatpak





.. class:: InstalledRef(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Flatpak.Ref`, :class:`~gi.repository.GObject.Object`





:Constructors:

::

    InstalledRef(**properties)





Methods
-------

.. rst-class:: interim-class

.. class:: InstalledRef
   :no-index:


   .. method:: get_appdata_content_rating() -> dict[str, str] | None

      Returns the content rating field from the appdata. This is a potentially
      empty mapping of content rating attribute IDs to values, to be interpreted
      by the semantics of the content rating type (see
      :func:`~gi.repository.Flatpak.InstalledRef.get_appdata_content_rating_type`).


      .. versionadded:: 1.4.2








   .. method:: get_appdata_content_rating_type() -> str | None

      Returns the content rating type from the appdata. For example, ``oars-1.0`` or
      ``oars-1.1``\.


      .. versionadded:: 1.4.2








   .. method:: get_appdata_license() -> str

      Returns the license field from the appdata.


      .. versionadded:: 1.1.2








   .. method:: get_appdata_name() -> str

      Returns the name field from the appdata.

      The returned string is localized.


      .. versionadded:: 1.1.2








   .. method:: get_appdata_summary() -> str

      Returns the summary field from the appdata.

      The returned string is localized.


      .. versionadded:: 1.1.2








   .. method:: get_appdata_version() -> str

      Returns the default version field from the appdata.


      .. versionadded:: 1.1.2








   .. method:: get_deploy_dir() -> str

      Gets the deploy dir of the ref.









   .. method:: get_eol() -> str

      Returns the end-of-life reason string, or :const:`None` if the
      ref is not end-of-lifed.









   .. method:: get_eol_rebase() -> str

      Returns the end-of-life rebased ref, or :const:`None` if the
      ref is not end-of-lifed.









   .. method:: get_installed_size() -> int

      Returns the installed size of the ref.









   .. method:: get_is_current() -> bool

      Returns whether the ref is current.









   .. method:: get_latest_commit() -> str | None

      Gets the latest commit of the ref.









   .. method:: get_origin() -> str

      Gets the origin of the ref.









   .. method:: get_subpaths() -> list[str]

      Returns the subpaths that are installed, or :const:`None` if all files installed.









   .. method:: load_appdata(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.GLib.Bytes

      Loads the compressed xml appdata for this ref (if it exists).


      .. versionadded:: 1.1.2





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`




   .. method:: load_metadata(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.GLib.Bytes

      Loads the metadata file for this ref.






      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`








Properties
----------

.. rst-class:: interim-class

.. class:: InstalledRef
   :no-index:
   

   .. attribute:: props.appdata_content_rating
      :type: dict[~typing.Any, ~typing.Any]

      The type of the None singleton.







   .. attribute:: props.appdata_content_rating_type
      :type: str

      The type of the None singleton.







   .. attribute:: props.appdata_license
      :type: str

      The type of the None singleton.







   .. attribute:: props.appdata_name
      :type: str

      The type of the None singleton.







   .. attribute:: props.appdata_summary
      :type: str

      The type of the None singleton.







   .. attribute:: props.appdata_version
      :type: str

      The type of the None singleton.







   .. attribute:: props.deploy_dir
      :type: str

      The type of the None singleton.







   .. attribute:: props.end_of_life
      :type: str

      The type of the None singleton.







   .. attribute:: props.end_of_life_rebase
      :type: str

      The type of the None singleton.







   .. attribute:: props.installed_size
      :type: int

      The type of the None singleton.







   .. attribute:: props.is_current
      :type: bool

      The type of the None singleton.







   .. attribute:: props.latest_commit
      :type: str

      The type of the None singleton.







   .. attribute:: props.origin
      :type: str

      The type of the None singleton.







   .. attribute:: props.subpaths
      :type: list[str]

      The type of the None singleton.















Fields
------

.. rst-class:: interim-class

.. class:: InstalledRef
   :no-index:
   

   .. attribute:: parent