Remote

class Remote(**properties: Any)

Superclasses: Object

Constructors:

Remote(**properties)
new(name:str) -> Flatpak.Remote
new_from_file(name:str, data:GLib.Bytes) -> Flatpak.Remote

Constructors

class Remote

classmethod new(name: str) → 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 modify_remote() or add_remote() for the changes to take effect.

Parameters:

name – a name

classmethod new_from_file(name: str, data: Bytes) → 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 modify_remote() or add_remote() for the changes to take effect.

Added in version 1.3.4.

Parameters:

• name – a name

• data – The content of a flatpakrepo file

Methods

class Remote

get_appstream_dir(arch: str | None = None) → File

Returns the directory where this remote will store locally cached appstream information for the specified arch.

Parameters:

arch – which architecture to fetch (default: current architecture)

get_appstream_timestamp(arch: str | None = None) → File

Returns the timestamp file that will be updated whenever the appstream information has been updated (or tried to update) for the specified arch.

Parameters:

arch – which architecture to fetch (default: current architecture)

get_collection_id() → str | None

Returns the repository collection ID of this remote, if set.

get_comment() → str

Returns the comment of the remote.

Added in version 1.4.

get_default_branch() → str

Returns the default branch configured for the remote.

Added in version 0.6.12.

get_description() → str

Returns the description of the remote.

Added in version 1.4.

get_disabled() → bool

Returns whether this remote is disabled.

get_filter() → str

Returns the filter file of the remote.

Added in version 1.4.

get_gpg_verify() → bool

Returns whether GPG verification is enabled for the remote.

get_homepage() → str

Returns the homepage url of the remote.

Added in version 1.4.

get_icon() → str

Returns the icon url of the remote.

Added in version 1.4.

get_name() → str

Returns the name of the remote repository.

get_nodeps() → bool

Returns whether this remote should be used to find dependencies.

get_noenumerate() → bool

Returns whether this remote should be used to list applications.

get_prio() → int

Returns the priority for the remote.

get_remote_type() → RemoteType

Get the value of Remote:type.

Added in version 0.9.8.

get_title() → str

Returns the title of the remote.

get_url() → str

Returns the repository URL of this remote.

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 modify_remote() for the changes to take effect.

Parameters:

collection_id – The new collection ID, or None to unset

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 modify_remote() for the changes to take effect.

Added in version 1.4.

Parameters:

comment – The new comment

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 modify_remote() for the changes to take effect.

Added in version 0.6.12.

Parameters:

default_branch – The new default_branch, or None to unset

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 modify_remote() for the changes to take effect.

Added in version 1.4.

Parameters:

description – The new description

set_disabled(disabled: bool) → None

Sets the disabled config of this remote. See get_disabled().

Note: This is a local modification of this object, you must commit changes using modify_remote() for the changes to take effect.

Parameters:

disabled – a bool

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 modify_remote() for the changes to take effect.

Added in version 1.4.

Parameters:

filter_path – The pathname of the new filter file

set_gpg_key(gpg_key: Bytes) → None

Sets the trusted gpg key for this remote.

Note: This is a local modification of this object, you must commit changes using modify_remote() for the changes to take effect.

Parameters:

gpg_key – a Bytes with gpg binary key data

set_gpg_verify(gpg_verify: bool) → None

Sets the gpg_verify config of this remote. See get_gpg_verify().

Note: This is a local modification of this object, you must commit changes using modify_remote() for the changes to take effect.

Parameters:

gpg_verify – a bool

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 modify_remote() for the changes to take effect.

Added in version 1.4.

Parameters:

homepage – The new homepage

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 modify_remote() for the changes to take effect.

Added in version 1.4.

Parameters:

icon – The new homepage

set_nodeps(nodeps: bool) → None

Sets the nodeps config of this remote. See get_nodeps().

Note: This is a local modification of this object, you must commit changes using modify_remote() for the changes to take effect.

Parameters:

nodeps – a bool

set_noenumerate(noenumerate: bool) → None

Sets the noenumeration config of this remote. See get_noenumerate().

Note: This is a local modification of this object, you must commit changes using modify_remote() for the changes to take effect.

Parameters:

noenumerate – a bool

set_prio(prio: int) → None

Sets the prio config of this remote. See get_prio().

Note: This is a local modification of this object, you must commit changes using modify_remote() for the changes to take effect.

Parameters:

prio – a bool

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 modify_remote() for the changes to take effect.

Parameters:

title – The new title, or None to unset

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 modify_remote() for the changes to take effect.

Parameters:

url – The new url

Properties

class Remote

props.name: str

Name of the remote, as used in configuration files and when interfacing with OSTree. This is typically human readable, but could be generated, and must conform to ostree_validate_remote_name(). It should typically not be presented in the UI.

props.type: RemoteType

The type of the remote: whether it comes from static configuration files (FLATPAK_REMOTE_TYPE_STATIC) or has been dynamically found from the local network or a mounted USB drive (FLATPAK_REMOTE_TYPE_LAN, FLATPAK_REMOTE_TYPE_USB). Dynamic remotes may be added and removed over time.

Added in version 0.9.8.

Fields

class Remote

parent