Flatpak.Remote

g Flatpak.Remote Flatpak.Remote GObject.Object GObject.Object GObject.Object->Flatpak.Remote

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new (name)

class

new_from_file (name, data)

get_appstream_dir (arch)

get_appstream_timestamp (arch)

get_collection_id ()

get_comment ()

get_default_branch ()

get_description ()

get_disabled ()

get_filter ()

get_gpg_verify ()

get_homepage ()

get_icon ()

get_main_ref ()

get_name ()

get_nodeps ()

get_noenumerate ()

get_prio ()

get_remote_type ()

get_title ()

get_url ()

set_collection_id (collection_id)

set_comment (comment)

set_default_branch (default_branch)

set_description (description)

set_disabled (disabled)

set_filter (filter_path)

set_gpg_key (gpg_key)

set_gpg_verify (gpg_verify)

set_homepage (homepage)

set_icon (icon)

set_main_ref (main_ref)

set_nodeps (nodeps)

set_noenumerate (noenumerate)

set_prio (prio)

set_title (title)

set_url (url)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

name

str

r/w

The name of the remote

type

Flatpak.RemoteType

r/w/co

The type of the remote

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

GObject.Object

r

Class Details

class Flatpak.Remote(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Flatpak.RemoteClass

classmethod new(name)
Parameters:

name (str) – a name

Returns:

a new Flatpak.Remote

Return type:

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

classmethod new_from_file(name, data)
Parameters:
  • name (str) – a name

  • data (GLib.Bytes) – The content of a flatpakrepo file

Raises:

GLib.Error

Returns:

a new Flatpak.Remote, or None on error

Return type:

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

New in version 1.3.4.

get_appstream_dir(arch)
Parameters:

arch (str or None) – which architecture to fetch (default: current architecture)

Returns:

a Gio.File

Return type:

Gio.File

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

get_appstream_timestamp(arch)
Parameters:

arch (str or None) – which architecture to fetch (default: current architecture)

Returns:

a Gio.File

Return type:

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.

get_collection_id()
Returns:

the collection ID, or None if unset

Return type:

str or None

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

get_comment()
Returns:

the comment

Return type:

str

Returns the comment of the remote.

New in version 1.4.

get_default_branch()
Returns:

the default branch, or None

Return type:

str

Returns the default branch configured for the remote.

New in version 0.6.12.

get_description()
Returns:

the description

Return type:

str

Returns the description of the remote.

New in version 1.4.

get_disabled()
Returns:

whether the remote is marked as disabled

Return type:

bool

Returns whether this remote is disabled.

get_filter()
Returns:

a pathname to a filter file

Return type:

str

Returns the filter file of the remote.

New in version 1.4.

get_gpg_verify()
Returns:

whether GPG verification is enabled

Return type:

bool

Returns whether GPG verification is enabled for the remote.

get_homepage()
Returns:

the homepage url

Return type:

str

Returns the homepage url of the remote.

New in version 1.4.

get_icon()
Returns:

the icon url

Return type:

str

Returns the icon url of the remote.

New in version 1.4.

get_main_ref()
Returns:

the main ref, or None

Return type:

str

Returns the main ref of this remote, if set. The main ref is the ref that an origin remote is created for.

New in version 1.1.1.

get_name()
Returns:

the name

Return type:

str

Returns the name of the remote repository.

get_nodeps()
Returns:

whether the remote is marked as “don’t use for dependencies”

Return type:

bool

Returns whether this remote should be used to find dependencies.

get_noenumerate()
Returns:

whether the remote is marked as “don’t enumerate”

Return type:

bool

Returns whether this remote should be used to list applications.

get_prio()
Returns:

the priority

Return type:

int

Returns the priority for the remote.

get_remote_type()
Returns:

the type of remote this is

Return type:

Flatpak.RemoteType

Get the value of Flatpak.Remote :type.

New in version 0.9.8.

get_title()
Returns:

the title

Return type:

str

Returns the title of the remote.

get_url()
Returns:

the URL

Return type:

str

Returns the repository URL of this remote.

set_collection_id(collection_id)
Parameters:

collection_id (str or None) – The new collection ID, or None to unset

Sets the repository collection ID of this remote.

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

set_comment(comment)
Parameters:

comment (str) – The new comment

Sets the comment of this remote.

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

New in version 1.4.

set_default_branch(default_branch)
Parameters:

default_branch (str) – The new default_branch, or None to unset

Sets the default branch configured for this remote.

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

New in version 0.6.12.

set_description(description)
Parameters:

description (str) – The new description

Sets the description of this remote.

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

New in version 1.4.

set_disabled(disabled)
Parameters:

disabled (bool) – a bool

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

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

set_filter(filter_path)
Parameters:

filter_path (str) – The pathname of the new filter file

Sets a filter for this remote.

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

New in version 1.4.

set_gpg_key(gpg_key)
Parameters:

gpg_key (GLib.Bytes) – a GLib.Bytes with gpg binary key data

Sets the trusted gpg key for this remote.

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

set_gpg_verify(gpg_verify)
Parameters:

gpg_verify (bool) – a bool

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

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

set_homepage(homepage)
Parameters:

homepage (str) – The new homepage

Sets the homepage of this remote.

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

New in version 1.4.

set_icon(icon)
Parameters:

icon (str) – The new homepage

Sets the homepage of this remote.

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

New in version 1.4.

set_main_ref(main_ref)
Parameters:

main_ref (str) – The new main ref

Sets the main ref of this remote. The main ref is the ref that an origin remote is created for.

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

New in version 1.1.1.

set_nodeps(nodeps)
Parameters:

nodeps (bool) – a bool

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

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

set_noenumerate(noenumerate)
Parameters:

noenumerate (bool) – a bool

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

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

set_prio(prio)
Parameters:

prio (int) – a bool

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

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

set_title(title)
Parameters:

title (str) – The new title, or None to unset

Sets the repository title of this remote.

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

set_url(url)
Parameters:

url (str) – The new url

Sets the repository URL of this remote.

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

Property Details

Flatpak.Remote.props.name
Name:

name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

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.

Flatpak.Remote.props.type
Name:

type

Type:

Flatpak.RemoteType

Default Value:

Flatpak.RemoteType.STATIC

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

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

New in version 0.9.8.