:right-sidebar: True Remote =================================================================== .. currentmodule:: gi.repository.Flatpak .. class:: Remote(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` :Constructors: :: Remote(**properties) new(name:str) -> Flatpak.Remote new_from_file(name:str, data:GLib.Bytes) -> Flatpak.Remote Constructors ------------ .. rst-class:: interim-class .. class:: Remote :no-index: .. classmethod:: new(name: str) -> ~gi.repository.Flatpak.Remote Returns a new remote object which can be used to configure a new remote. Note: This is a local configuration object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` or :func:`~gi.repository.Flatpak.Installation.add_remote` for the changes to take effect. :param name: a name .. classmethod:: new_from_file(name: str, data: ~gi.repository.GLib.Bytes) -> ~gi.repository.Flatpak.Remote Returns a new pre-filled remote object which can be used to configure a new remote. The fields in the remote are filled in according to the values in the passed in flatpakrepo file. Note: This is a local configuration object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` or :func:`~gi.repository.Flatpak.Installation.add_remote` for the changes to take effect. .. versionadded:: 1.3.4 :param name: a name :param data: The content of a flatpakrepo file Methods ------- .. rst-class:: interim-class .. class:: Remote :no-index: .. method:: get_appstream_dir(arch: str | None = None) -> ~gi.repository.Gio.File Returns the directory where this remote will store locally cached appstream information for the specified ``arch``\. :param arch: which architecture to fetch (default: current architecture) .. method:: get_appstream_timestamp(arch: str | None = None) -> ~gi.repository.Gio.File Returns the timestamp file that will be updated whenever the appstream information has been updated (or tried to update) for the specified ``arch``\. :param arch: which architecture to fetch (default: current architecture) .. method:: get_collection_id() -> str | None Returns the repository collection ID of this remote, if set. .. method:: get_comment() -> str Returns the comment of the remote. .. versionadded:: 1.4 .. method:: get_default_branch() -> str Returns the default branch configured for the remote. .. versionadded:: 0.6.12 .. method:: get_description() -> str Returns the description of the remote. .. versionadded:: 1.4 .. method:: get_disabled() -> bool Returns whether this remote is disabled. .. method:: get_filter() -> str Returns the filter file of the remote. .. versionadded:: 1.4 .. method:: get_gpg_verify() -> bool Returns whether GPG verification is enabled for the remote. .. method:: get_homepage() -> str Returns the homepage url of the remote. .. versionadded:: 1.4 .. method:: get_icon() -> str Returns the icon url of the remote. .. versionadded:: 1.4 .. method:: get_name() -> str Returns the name of the remote repository. .. method:: get_nodeps() -> bool Returns whether this remote should be used to find dependencies. .. method:: get_noenumerate() -> bool Returns whether this remote should be used to list applications. .. method:: get_prio() -> int Returns the priority for the remote. .. method:: get_remote_type() -> ~gi.repository.Flatpak.RemoteType Get the value of :obj:`~gi.repository.Flatpak.Remote`\:type. .. versionadded:: 0.9.8 .. method:: get_title() -> str Returns the title of the remote. .. method:: get_url() -> str Returns the repository URL of this remote. .. method:: set_collection_id(collection_id: str | None = None) -> None Sets the repository collection ID of this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param collection_id: The new collection ID, or :const:`None` to unset .. method:: set_comment(comment: str) -> None Sets the comment of this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. .. versionadded:: 1.4 :param comment: The new comment .. method:: set_default_branch(default_branch: str) -> None Sets the default branch configured for this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. .. versionadded:: 0.6.12 :param default_branch: The new default_branch, or :const:`None` to unset .. method:: set_description(description: str) -> None Sets the description of this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. .. versionadded:: 1.4 :param description: The new description .. method:: set_disabled(disabled: bool) -> None Sets the disabled config of this remote. See :func:`~gi.repository.Flatpak.Remote.get_disabled`. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param disabled: a bool .. method:: set_filter(filter_path: str) -> None Sets a filter for this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. .. versionadded:: 1.4 :param filter_path: The pathname of the new filter file .. method:: set_gpg_key(gpg_key: ~gi.repository.GLib.Bytes) -> None Sets the trusted gpg key for this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param gpg_key: a :obj:`~gi.repository.GLib.Bytes` with gpg binary key data .. method:: set_gpg_verify(gpg_verify: bool) -> None Sets the gpg_verify config of this remote. See :func:`~gi.repository.Flatpak.Remote.get_gpg_verify`. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param gpg_verify: a bool .. method:: set_homepage(homepage: str) -> None Sets the homepage of this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. .. versionadded:: 1.4 :param homepage: The new homepage .. method:: set_icon(icon: str) -> None Sets the homepage of this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. .. versionadded:: 1.4 :param icon: The new homepage .. method:: set_nodeps(nodeps: bool) -> None Sets the nodeps config of this remote. See :func:`~gi.repository.Flatpak.Remote.get_nodeps`. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param nodeps: a bool .. method:: set_noenumerate(noenumerate: bool) -> None Sets the noenumeration config of this remote. See :func:`~gi.repository.Flatpak.Remote.get_noenumerate`. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param noenumerate: a bool .. method:: set_prio(prio: int) -> None Sets the prio config of this remote. See :func:`~gi.repository.Flatpak.Remote.get_prio`. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param prio: a bool .. method:: set_title(title: str) -> None Sets the repository title of this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param title: The new title, or :const:`None` to unset .. method:: set_url(url: str) -> None Sets the repository URL of this remote. Note: This is a local modification of this object, you must commit changes using :func:`~gi.repository.Flatpak.Installation.modify_remote` for the changes to take effect. :param url: The new url Properties ---------- .. rst-class:: interim-class .. class:: Remote :no-index: .. attribute:: props.name :type: str The type of the None singleton. .. attribute:: props.type :type: ~gi.repository.Flatpak.RemoteType The type of the None singleton. .. versionadded:: 0.9.8 Fields ------ .. rst-class:: interim-class .. class:: Remote :no-index: .. attribute:: parent