Top |
A FlatpakRemote object provides information about a remote repository (or short: remote) that has been configured.
At its most basic level, a remote has a name and the URL for the repository. In addition, they provide some additional information that can be useful when presenting repositories in a UI, such as a title, a priority or a "don't enumerate" flags.
To obtain FlatpakRemote objects for the configured remotes
on a system, use flatpak_installation_list_remotes()
or
flatpak_installation_get_remote_by_name()
.
FlatpakRemote *
flatpak_remote_new (const char *name
);
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.
FlatpakRemote * flatpak_remote_new_from_file (const char *name
,GBytes *data
,GError **error
);
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.
Since: 1.3.4
const char *
flatpak_remote_get_name (FlatpakRemote *self
);
Returns the name of the remote repository.
GFile * flatpak_remote_get_appstream_dir (FlatpakRemote *self
,const char *arch
);
Returns the directory where this remote will store locally cached
appstream information for the specified arch
.
GFile * flatpak_remote_get_appstream_timestamp (FlatpakRemote *self
,const char *arch
);
Returns the timestamp file that will be updated whenever the appstream information
has been updated (or tried to update) for the specified arch
.
char *
flatpak_remote_get_collection_id (FlatpakRemote *self
);
Returns the repository collection ID of this remote, if set.
void flatpak_remote_set_collection_id (FlatpakRemote *self
,const char *collection_id
);
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.
char *
flatpak_remote_get_default_branch (FlatpakRemote *self
);
Returns the default branch configured for the remote.
Since: 0.6.12
void flatpak_remote_set_default_branch (FlatpakRemote *self
,const char *default_branch
);
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.
Since: 0.6.12
gboolean
flatpak_remote_get_gpg_verify (FlatpakRemote *self
);
Returns whether GPG verification is enabled for the remote.
void flatpak_remote_set_gpg_verify (FlatpakRemote *self
,gboolean gpg_verify
);
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.
void flatpak_remote_set_gpg_key (FlatpakRemote *self
,GBytes *gpg_key
);
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.
gboolean
flatpak_remote_get_nodeps (FlatpakRemote *self
);
Returns whether this remote should be used to find dependencies.
void flatpak_remote_set_nodeps (FlatpakRemote *self
,gboolean nodeps
);
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.
gboolean
flatpak_remote_get_noenumerate (FlatpakRemote *self
);
Returns whether this remote should be used to list applications.
void flatpak_remote_set_noenumerate (FlatpakRemote *self
,gboolean noenumerate
);
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.
int
flatpak_remote_get_prio (FlatpakRemote *self
);
Returns the priority for the remote.
void flatpak_remote_set_prio (FlatpakRemote *self
,int prio
);
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.
FlatpakRemoteType
flatpak_remote_get_remote_type (FlatpakRemote *self
);
Get the value of “type”.
Since: 0.9.8
char *
flatpak_remote_get_title (FlatpakRemote *self
);
Returns the title of the remote.
void flatpak_remote_set_title (FlatpakRemote *self
,const char *title
);
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.
char *
flatpak_remote_get_comment (FlatpakRemote *self
);
Returns the comment of the remote.
Since: 1.4
void flatpak_remote_set_comment (FlatpakRemote *self
,const char *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.
Since: 1.4
char *
flatpak_remote_get_description (FlatpakRemote *self
);
Returns the description of the remote.
Since: 1.4
void flatpak_remote_set_description (FlatpakRemote *self
,const char *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.
Since: 1.4
char *
flatpak_remote_get_homepage (FlatpakRemote *self
);
Returns the homepage url of the remote.
Since: 1.4
void flatpak_remote_set_homepage (FlatpakRemote *self
,const char *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.
Since: 1.4
char *
flatpak_remote_get_icon (FlatpakRemote *self
);
Returns the icon url of the remote.
Since: 1.4
void flatpak_remote_set_icon (FlatpakRemote *self
,const char *icon
);
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.
Since: 1.4
char *
flatpak_remote_get_url (FlatpakRemote *self
);
Returns the repository URL of this remote.
void flatpak_remote_set_url (FlatpakRemote *self
,const char *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.
gboolean
flatpak_remote_get_disabled (FlatpakRemote *self
);
Returns whether this remote is disabled.
void flatpak_remote_set_disabled (FlatpakRemote *self
,gboolean disabled
);
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.
char *
flatpak_remote_get_filter (FlatpakRemote *self
);
Returns the filter file of the remote.
Since: 1.4
void flatpak_remote_set_filter (FlatpakRemote *self
,const char *filter_path
);
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.
Since: 1.4
char *
flatpak_remote_get_main_ref (FlatpakRemote *self
);
Returns the main ref of this remote, if set. The main ref is the ref that an origin remote is created for.
Since: 1.1.1
void flatpak_remote_set_main_ref (FlatpakRemote *self
,const char *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.
Since: 1.1.1
“name”
property “name” char *
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.
Owner: FlatpakRemote
Flags: Read / Write
Default value: NULL
“type”
property“type” FlatpakRemoteType
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.
Owner: FlatpakRemote
Flags: Read / Write / Construct Only
Default value: FLATPAK_REMOTE_TYPE_STATIC
Since: 0.9.8