Optionalproperties: Partial<Xdp.Portal.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeRequest access to a camera.
When the request is done, callback will be called.
You can then call Portal.access_camera_finish
to get the results.
parent window information
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Request access to a camera.
When the request is done, callback will be called.
You can then call Portal.access_camera_finish
to get the results.
parent window information
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Request access to a camera.
When the request is done, callback will be called.
You can then call Portal.access_camera_finish
to get the results.
parent window information
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes a camera acess request.
Returns the result as a boolean.
If the access was granted, you can then call Portal.open_pipewire_remote_for_camera to obtain a pipewire remote.
TRUE if access to a camera was granted
Sends a desktop notification.
The following keys may be present in notification:
s: a user-visible string to display as titles: a user-visible string to display as bodyv: a serialized icon (in the format produced by Gio.Icon.serialize)s: "low", "normal", "high" or "urgent"s: name of an action that
will be activated when the user clicks on the notificationv: target parameter to send along when
activating the default action.aa{sv}: array of serialized buttonsEach serialized button is a dictionary with the following supported keys:
s: user-visible lable for the button. Mandatorys: name of an action that will be activated when
the user clicks on the button. Mandatoryv: target parameter to send along when activating
the buttonActions with a prefix of "app." are assumed to be exported by the
application and will be activated via the org.freedesktop.Application
interface, others are activated by emitting the
Xdp.Portal::notification-action-invoked signal.
It is the callers responsibility to ensure that the ID is unique among all notifications.
To withdraw a notification, use Portal.remove_notification.
unique ID for the notification
a GLib.Variant dictionary with the content of the notification
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Sends a desktop notification.
The following keys may be present in notification:
s: a user-visible string to display as titles: a user-visible string to display as bodyv: a serialized icon (in the format produced by Gio.Icon.serialize)s: "low", "normal", "high" or "urgent"s: name of an action that
will be activated when the user clicks on the notificationv: target parameter to send along when
activating the default action.aa{sv}: array of serialized buttonsEach serialized button is a dictionary with the following supported keys:
s: user-visible lable for the button. Mandatorys: name of an action that will be activated when
the user clicks on the button. Mandatoryv: target parameter to send along when activating
the buttonActions with a prefix of "app." are assumed to be exported by the
application and will be activated via the org.freedesktop.Application
interface, others are activated by emitting the
Xdp.Portal::notification-action-invoked signal.
It is the callers responsibility to ensure that the ID is unique among all notifications.
To withdraw a notification, use Portal.remove_notification.
unique ID for the notification
a GLib.Variant dictionary with the content of the notification
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Sends a desktop notification.
The following keys may be present in notification:
s: a user-visible string to display as titles: a user-visible string to display as bodyv: a serialized icon (in the format produced by Gio.Icon.serialize)s: "low", "normal", "high" or "urgent"s: name of an action that
will be activated when the user clicks on the notificationv: target parameter to send along when
activating the default action.aa{sv}: array of serialized buttonsEach serialized button is a dictionary with the following supported keys:
s: user-visible lable for the button. Mandatorys: name of an action that will be activated when
the user clicks on the button. Mandatoryv: target parameter to send along when activating
the buttonActions with a prefix of "app." are assumed to be exported by the
application and will be activated via the org.freedesktop.Application
interface, others are activated by emitting the
Xdp.Portal::notification-action-invoked signal.
It is the callers responsibility to ensure that the ID is unique among all notifications.
To withdraw a notification, use Portal.remove_notification.
unique ID for the notification
a GLib.Variant dictionary with the content of the notification
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the notification request.
Returns the result as a boolean.
TRUE if the notification was added
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Presents a window that lets the user compose an email, with some pre-filled information.
When the request is done, callback will be called. You can then
call Portal.compose_email_finish to get the results.
parent window information
the email addresses to send to
the email addresses to cc
the email addresses to bcc
the subject for the email
the body for the email
an array of paths for files to attach
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Presents a window that lets the user compose an email, with some pre-filled information.
When the request is done, callback will be called. You can then
call Portal.compose_email_finish to get the results.
parent window information
the email addresses to send to
the email addresses to cc
the email addresses to bcc
the subject for the email
the body for the email
an array of paths for files to attach
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Presents a window that lets the user compose an email, with some pre-filled information.
When the request is done, callback will be called. You can then
call Portal.compose_email_finish to get the results.
parent window information
the email addresses to send to
the email addresses to cc
the email addresses to bcc
the subject for the email
the body for the email
an array of paths for files to attach
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the compose-email request.
TRUE if the request was handled successfully
SignalconnectSignalconnect_Creates a session for remote desktop.
When the request is done, callback will be called. You can then
call Portal.create_remote_desktop_session_finish to get the results.
which kinds of input devices to ofer in the new dialog
which kinds of source to offer in the dialog
options for this call
the cursor mode of the session
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Creates a session for remote desktop.
When the request is done, callback will be called. You can then
call Portal.create_remote_desktop_session_finish to get the results.
which kinds of input devices to ofer in the new dialog
which kinds of source to offer in the dialog
options for this call
the cursor mode of the session
optional Gio.Cancellable
a callback to call when the request is done
Creates a session for remote desktop.
When the request is done, callback will be called. You can then
call Portal.create_remote_desktop_session_finish to get the results.
which kinds of input devices to ofer in the new dialog
which kinds of source to offer in the dialog
options for this call
the cursor mode of the session
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Creates a session for a screencast.
When the request is done, callback will be called. You can then
call Portal.create_screencast_session_finish to get the results.
which kinds of source to offer in the dialog
options for this call
the cursor mode of the session
the persist mode of the session
Optionalrestore_token: stringthe token of a previous screencast session to restore
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Creates a session for a screencast.
When the request is done, callback will be called. You can then
call Portal.create_screencast_session_finish to get the results.
which kinds of source to offer in the dialog
options for this call
the cursor mode of the session
the persist mode of the session
the token of a previous screencast session to restore
optional Gio.Cancellable
a callback to call when the request is done
Creates a session for a screencast.
When the request is done, callback will be called. You can then
call Portal.create_screencast_session_finish to get the results.
which kinds of source to offer in the dialog
options for this call
the cursor mode of the session
the persist mode of the session
Optionalrestore_token: stringthe token of a previous screencast session to restore
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function gets the contents of a .desktop file that was previously installed by the dynamic launcher portal.
The desktop_file_id must be prefixed with the caller's app ID followed by a
"." and suffixed with ".desktop".
the .desktop file name
the contents of the desktop file, or null with error set
This function gets the icon associated with a .desktop file that was previously installed by the dynamic launcher portal.
The desktop_file_id must be prefixed with the caller's app ID followed by a
"." and suffixed with ".desktop".
the .desktop file name
Optionalout_icon_format: stringreturn location for icon format string, one of "png", "jpeg", "svg"
Optionalout_icon_size: numberreturn location for icon size
the icon in a format recognized by g_icon_deserialize(), or null with error set
This function completes installation of a launcher so that the icon and name given in previous method calls will show up in the desktop environment's menu.
The desktop_file_id must be prefixed with the caller's app ID followed by a
"." and suffixed with ".desktop".
The desktop_entry data need not include Icon= or Name= entries since these
will be added by the portal, and the Exec= entry will be rewritten to call
the application with e.g. "flatpak run" depending on the sandbox status of
the app.
a token acquired via a Portal.dynamic_launcher_request_install_token or Portal.dynamic_launcher_prepare_install call
the .desktop file name to be used
the key-file to be used for the contents of the .desktop file
true if the installation was successful, false with error set otherwise
Presents a dialog to the user so they can confirm they want to install a launcher to their desktop.
When the request is done, callback will be called. You can then
call Portal.dynamic_launcher_prepare_install_finish to get the results.
parent window information
the name for the launcher
a Gio.BytesIcon as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg
the type of the launcher
the URL if the launcher is for a web app, or null
if true, the user will be able to edit the name of the launcher
if true, the user will be able to edit the icon of the launcher, if the implementation supports this
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Presents a dialog to the user so they can confirm they want to install a launcher to their desktop.
When the request is done, callback will be called. You can then
call Portal.dynamic_launcher_prepare_install_finish to get the results.
parent window information
the name for the launcher
a Gio.BytesIcon as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg
the type of the launcher
the URL if the launcher is for a web app, or null
if true, the user will be able to edit the name of the launcher
if true, the user will be able to edit the icon of the launcher, if the implementation supports this
optional Gio.Cancellable
a callback to call when the request is done
Presents a dialog to the user so they can confirm they want to install a launcher to their desktop.
When the request is done, callback will be called. You can then
call Portal.dynamic_launcher_prepare_install_finish to get the results.
parent window information
the name for the launcher
a Gio.BytesIcon as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg
the type of the launcher
the URL if the launcher is for a web app, or null
if true, the user will be able to edit the name of the launcher
if true, the user will be able to edit the icon of the launcher, if the implementation supports this
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the prepare-install-launcher request, and returns GLib.Variant dictionary with the following information:
a GLib.Variant dictionary with launcher information
Requests a token which can be passed to Portal.dynamic_launcher_install to complete installation of the launcher without user interaction.
This function only works when the caller's app ID is in the allowlist for the portal backend being used. It's intended for software centers such as GNOME Software or KDE Discover.
the name for the launcher
a Gio.BytesIcon as returned by g_icon_serialize(). Must be a png or jpeg no larger than 512x512, or an svg
a token that can be passed to Portal.dynamic_launcher_install, or null with error set
This function uninstalls a launcher that was previously installed using the dynamic launcher portal, resulting in the .desktop file and icon being deleted.
The desktop_file_id must be prefixed with the caller's app ID followed by a
"." and suffixed with ".desktop".
the .desktop file name
true if the uninstallation was successful, false with error set otherwise
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets information about the user.
When the request is done, callback will be called. You can then
call Portal.get_user_information_finish to get the results.
parent window information
a string that can be shown in the dialog to explain why the information is needed
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Gets information about the user.
When the request is done, callback will be called. You can then
call Portal.get_user_information_finish to get the results.
parent window information
a string that can be shown in the dialog to explain why the information is needed
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Gets information about the user.
When the request is done, callback will be called. You can then
call Portal.get_user_information_finish to get the results.
parent window information
a string that can be shown in the dialog to explain why the information is needed
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the get-user-information request.
Returns the result in the form of a GLib.Variant dictionary containing the following fields:
s: the user IDs: the users real names: the uri of an image file for the users avatar picturea GLib.Variant dictionary with user information
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Returns whether any camera are present.
TRUE if the system has cameras
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Makes Xdp.Portal start monitoring location changes.
When the location changes, the Xdp.Portal::location-updated.
signal is emitted.
Use Portal.location_monitor_stop to stop monitoring.
Note that Portal only maintains a single location monitor
at a time. If you want to change the distance_threshold,
time_threshold or accuracy of the current monitor, you
first have to call Portal.location_monitor_stop to
stop monitoring.
a Parent, or NULL
distance threshold, in meters
time threshold, in seconds
desired accuracy
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Makes Xdp.Portal start monitoring location changes.
When the location changes, the Xdp.Portal::location-updated.
signal is emitted.
Use Portal.location_monitor_stop to stop monitoring.
Note that Portal only maintains a single location monitor
at a time. If you want to change the distance_threshold,
time_threshold or accuracy of the current monitor, you
first have to call Portal.location_monitor_stop to
stop monitoring.
a Parent, or NULL
distance threshold, in meters
time threshold, in seconds
desired accuracy
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Makes Xdp.Portal start monitoring location changes.
When the location changes, the Xdp.Portal::location-updated.
signal is emitted.
Use Portal.location_monitor_stop to stop monitoring.
Note that Portal only maintains a single location monitor
at a time. If you want to change the distance_threshold,
time_threshold or accuracy of the current monitor, you
first have to call Portal.location_monitor_stop to
stop monitoring.
a Parent, or NULL
distance threshold, in meters
time threshold, in seconds
desired accuracy
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes a location-monitor request.
Returns result in the form of boolean.
TRUE if the request succeeded
Stops location monitoring that was started with Portal.location_monitor_start.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Opens the directory containing the file specified by the uri.
which must be a file: uri pointing to a file that the application has access to.
parent window information
the URI to open
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Opens the directory containing the file specified by the uri.
which must be a file: uri pointing to a file that the application has access to.
parent window information
the URI to open
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Opens the directory containing the file specified by the uri.
which must be a file: uri pointing to a file that the application has access to.
parent window information
the URI to open
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the open-directory request.
Returns the result in the form of a boolean.
TRUE if the call succeeded
Asks the user to open one or more files.
The format for the filters argument is a(sa(us)).
Each item in the array specifies a single filter to offer to the user.
The first string is a user-visible name for the filter. The a(us)
specifies a list of filter strings, which can be either a glob pattern
(indicated by 0) or a mimetype (indicated by 1).
Example: [('Images', [(0, '*.ico'), (1, 'image/png')]), ('Text', [(0, '*.txt')])]
The format for the choices argument is a(ssa(ss)s).
For each element, the first string is an ID that will be returned
with the response, te second string is a user-visible label. The
a(ss) is the list of choices, each being a is an ID and a
user-visible label. The final string is the initial selection,
or "", to let the portal decide which choice will be initially selected.
None of the strings, except for the initial selection, should be empty.
As a special case, passing an empty array for the list of choices
indicates a boolean choice that is typically displayed as a check
button, using "true" and "false" as the choices.
Example: [('encoding', 'Encoding', [('utf8', 'Unicode (UTF-8)'), ('latin15', 'Western')], 'latin15'), ('reencode', 'Reencode', [], 'false')]
When the request is done, callback will be called. You can then
call Portal.open_file_finish to get the results.
parent window information
title for the file chooser dialog
a GLib.Variant describing file filters
a GLib.Variant describing the current file filter
a GLib.Variant describing extra widgets
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Asks the user to open one or more files.
The format for the filters argument is a(sa(us)).
Each item in the array specifies a single filter to offer to the user.
The first string is a user-visible name for the filter. The a(us)
specifies a list of filter strings, which can be either a glob pattern
(indicated by 0) or a mimetype (indicated by 1).
Example: [('Images', [(0, '*.ico'), (1, 'image/png')]), ('Text', [(0, '*.txt')])]
The format for the choices argument is a(ssa(ss)s).
For each element, the first string is an ID that will be returned
with the response, te second string is a user-visible label. The
a(ss) is the list of choices, each being a is an ID and a
user-visible label. The final string is the initial selection,
or "", to let the portal decide which choice will be initially selected.
None of the strings, except for the initial selection, should be empty.
As a special case, passing an empty array for the list of choices
indicates a boolean choice that is typically displayed as a check
button, using "true" and "false" as the choices.
Example: [('encoding', 'Encoding', [('utf8', 'Unicode (UTF-8)'), ('latin15', 'Western')], 'latin15'), ('reencode', 'Reencode', [], 'false')]
When the request is done, callback will be called. You can then
call Portal.open_file_finish to get the results.
parent window information
title for the file chooser dialog
a GLib.Variant describing file filters
a GLib.Variant describing the current file filter
a GLib.Variant describing extra widgets
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Asks the user to open one or more files.
The format for the filters argument is a(sa(us)).
Each item in the array specifies a single filter to offer to the user.
The first string is a user-visible name for the filter. The a(us)
specifies a list of filter strings, which can be either a glob pattern
(indicated by 0) or a mimetype (indicated by 1).
Example: [('Images', [(0, '*.ico'), (1, 'image/png')]), ('Text', [(0, '*.txt')])]
The format for the choices argument is a(ssa(ss)s).
For each element, the first string is an ID that will be returned
with the response, te second string is a user-visible label. The
a(ss) is the list of choices, each being a is an ID and a
user-visible label. The final string is the initial selection,
or "", to let the portal decide which choice will be initially selected.
None of the strings, except for the initial selection, should be empty.
As a special case, passing an empty array for the list of choices
indicates a boolean choice that is typically displayed as a check
button, using "true" and "false" as the choices.
Example: [('encoding', 'Encoding', [('utf8', 'Unicode (UTF-8)'), ('latin15', 'Western')], 'latin15'), ('reencode', 'Reencode', [], 'false')]
When the request is done, callback will be called. You can then
call Portal.open_file_finish to get the results.
parent window information
title for the file chooser dialog
a GLib.Variant describing file filters
a GLib.Variant describing the current file filter
a GLib.Variant describing extra widgets
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the open-file request
Returns the result in the form of a GLib.Variant dictionary containing the following fields:
as: an array of strings containing the uris of selected filesa(ss): an array of pairs of strings, the first string being the
ID of a combobox that was passed into this call, the second string
being the selected option.a GLib.Variant dictionary with the results
Opens a file descriptor to the pipewire remote where the camera nodes are available.
The file descriptor should be used to create a pw_core object, by using
pw_context_connect_fd(). Only the camera nodes will be available from this
pipewire node.
the file descriptor
Opens uri with an external handler.
parent window information
the URI to open
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Opens uri with an external handler.
parent window information
the URI to open
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Opens uri with an external handler.
parent window information
the URI to open
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the open-uri request.
Returns the result in the form of a boolean.
TRUE if the call succeeded
Lets the user pick a color from the screen.
When the request is done, callback will be called. You can then
call Portal.pick_color_finish to get the results.
Optionalparent: Parentparent window information
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Lets the user pick a color from the screen.
When the request is done, callback will be called. You can then
call Portal.pick_color_finish to get the results.
parent window information
optional Gio.Cancellable
a callback to call when the request is done
Lets the user pick a color from the screen.
When the request is done, callback will be called. You can then
call Portal.pick_color_finish to get the results.
Optionalparent: Parentparent window information
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes a pick-color request.
Returns the result in the form of a GVariant of the form (ddd), containing red, green and blue components in the range [0,1].
GVariant containing the color
Presents a print dialog to the user and returns print settings and page setup.
When the request is done, callback will be called. You can then
call Portal.prepare_print_finish to get the results.
parent window information
tile for the print dialog
Serialized print settings
Serialized page setup
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Presents a print dialog to the user and returns print settings and page setup.
When the request is done, callback will be called. You can then
call Portal.prepare_print_finish to get the results.
parent window information
tile for the print dialog
Serialized print settings
Serialized page setup
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Presents a print dialog to the user and returns print settings and page setup.
When the request is done, callback will be called. You can then
call Portal.prepare_print_finish to get the results.
parent window information
tile for the print dialog
Serialized print settings
Serialized page setup
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the prepare-print request.
Returns a GLib.Variant dictionary with the following information:
a{sv}: print settings as set up by the user in the print dialoga GLib.Variant dictionary with print information
Prints a file.
If a valid token is present in the options, then this call will print
with the settings from the Print call that the token refers to. If
no token is present, then a print dialog will be presented to the user.
When the request is done, callback will be called. You can then
call Portal.print_file_finish to get the results.
parent window information
tile for the print dialog
token that was returned by a previous Portal.prepare_print call, or 0
path of the document to print
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Prints a file.
If a valid token is present in the options, then this call will print
with the settings from the Print call that the token refers to. If
no token is present, then a print dialog will be presented to the user.
When the request is done, callback will be called. You can then
call Portal.print_file_finish to get the results.
parent window information
tile for the print dialog
token that was returned by a previous Portal.prepare_print call, or 0
path of the document to print
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Prints a file.
If a valid token is present in the options, then this call will print
with the settings from the Print call that the token refers to. If
no token is present, then a print dialog will be presented to the user.
When the request is done, callback will be called. You can then
call Portal.print_file_finish to get the results.
parent window information
tile for the print dialog
token that was returned by a previous Portal.prepare_print call, or 0
path of the document to print
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the print request.
TRUE if the request was successful
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Withdraws a desktop notification.
the ID of an notification
Requests background permissions.
When the request is done, callback will be called. You can then
call Portal.request_background_finish to get the results.
parent window information
reason to present to user for request
command line to autostart
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Requests background permissions.
When the request is done, callback will be called. You can then
call Portal.request_background_finish to get the results.
parent window information
reason to present to user for request
command line to autostart
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Requests background permissions.
When the request is done, callback will be called. You can then
call Portal.request_background_finish to get the results.
parent window information
reason to present to user for request
command line to autostart
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the request.
Returns TRUE if successful.
TRUE if successful.
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Asks the user for a location to save a file.
The format for the filters argument is the same as for Portal.open_file.
The format for the choices argument is the same as for Portal.open_file.
When the request is done, callback will be called. You can then
call Portal.save_file_finish to get the results.
parent window information
title for the file chooser dialog
suggested filename
suggested folder to save the file in
the current file (when saving an existing file)
a GLib.Variant describing file filters
a GLib.Variant describing the current file filter
a GLib.Variant describing extra widgets
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Asks the user for a location to save a file.
The format for the filters argument is the same as for Portal.open_file.
The format for the choices argument is the same as for Portal.open_file.
When the request is done, callback will be called. You can then
call Portal.save_file_finish to get the results.
parent window information
title for the file chooser dialog
suggested filename
suggested folder to save the file in
the current file (when saving an existing file)
a GLib.Variant describing file filters
a GLib.Variant describing the current file filter
a GLib.Variant describing extra widgets
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Asks the user for a location to save a file.
The format for the filters argument is the same as for Portal.open_file.
The format for the choices argument is the same as for Portal.open_file.
When the request is done, callback will be called. You can then
call Portal.save_file_finish to get the results.
parent window information
title for the file chooser dialog
suggested filename
suggested folder to save the file in
the current file (when saving an existing file)
a GLib.Variant describing file filters
a GLib.Variant describing the current file filter
a GLib.Variant describing extra widgets
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the save-file request.
Returns the result in the form of a GLib.Variant dictionary containing the following fields:
(as): an array of strings containing the uri of the selected filea(ss): an array of pairs of strings, the first string being the
ID of a combobox that was passed into this call, the second string
being the selected option.a GLib.Variant dictionary with the results
Asks for a folder as a location to save one or more files.
The names of the files will be used as-is and appended to the selected folder's path in the list of returned files. If the selected folder already contains a file with one of the given names, the portal may prompt or take some other action to construct a unique file name and return that instead.
The format for the choices argument is the same as for Portal.open_file.
When the request is done, callback will be called. You can then
call Portal.save_file_finish to get the results.
parent window information
title for the file chooser dialog
suggested filename
suggested folder to save the file in
An array of file names to be saved
a GLib.Variant describing extra widgets
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Asks for a folder as a location to save one or more files.
The names of the files will be used as-is and appended to the selected folder's path in the list of returned files. If the selected folder already contains a file with one of the given names, the portal may prompt or take some other action to construct a unique file name and return that instead.
The format for the choices argument is the same as for Portal.open_file.
When the request is done, callback will be called. You can then
call Portal.save_file_finish to get the results.
parent window information
title for the file chooser dialog
suggested filename
suggested folder to save the file in
An array of file names to be saved
a GLib.Variant describing extra widgets
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Asks for a folder as a location to save one or more files.
The names of the files will be used as-is and appended to the selected folder's path in the list of returned files. If the selected folder already contains a file with one of the given names, the portal may prompt or take some other action to construct a unique file name and return that instead.
The format for the choices argument is the same as for Portal.open_file.
When the request is done, callback will be called. You can then
call Portal.save_file_finish to get the results.
parent window information
title for the file chooser dialog
suggested filename
suggested folder to save the file in
An array of file names to be saved
a GLib.Variant describing extra widgets
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the save-files request.
Returns the result in the form of a GLib.Variant dictionary containing the following fields:
(as): an array of strings containing the uri corresponding to each
file passed to the save-files request, in the same order. Note that the
file names may have changed, for example if a file with the same name in
the selected folder already exists.a(ss): an array of pairs of strings, the first string being the
ID of a combobox that was passed into this call, the second string
being the selected option.a GLib.Variant dictionary with the results
Inhibits various session status changes.
To obtain an ID that can be used to undo the inhibition, use Portal.session_inhibit_finish in the callback.
To remove an active inhibitor, call Portal.session_uninhibit with the same ID.
parent window information
user-visible reason for the inhibition
information about what to inhibit
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Inhibits various session status changes.
To obtain an ID that can be used to undo the inhibition, use Portal.session_inhibit_finish in the callback.
To remove an active inhibitor, call Portal.session_uninhibit with the same ID.
parent window information
user-visible reason for the inhibition
information about what to inhibit
optional Gio.Cancellable
a callback to call when the request is done
Inhibits various session status changes.
To obtain an ID that can be used to undo the inhibition, use Portal.session_inhibit_finish in the callback.
To remove an active inhibitor, call Portal.session_uninhibit with the same ID.
parent window information
user-visible reason for the inhibition
information about what to inhibit
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the inhbit request.
Returns the ID of the inhibition as a positive integer. The ID can be passed to Portal.session_uninhibit to undo the inhibition.
the ID of the inhibition, or -1 if there was an error
This method should be called within one second of
receiving a Xdp.Portal::session-state-changed signal
with the 'Query End' state, to acknowledge that they
have handled the state change.
Possible ways to handle the state change are either to call Portal.session_inhibit to prevent the session from ending, or to save your state and get ready for the session to end.
Makes Portal start monitoring the login session state.
When the state changes, the Xdp.Portal::session-state-changed
signal is emitted.
Use Portal.session_monitor_stop to stop monitoring.
a XdpParent, or NULL
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Makes Portal start monitoring the login session state.
When the state changes, the Xdp.Portal::session-state-changed
signal is emitted.
Use Portal.session_monitor_stop to stop monitoring.
a XdpParent, or NULL
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Makes Portal start monitoring the login session state.
When the state changes, the Xdp.Portal::session-state-changed
signal is emitted.
Use Portal.session_monitor_stop to stop monitoring.
a XdpParent, or NULL
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes a session-monitor request.
Returns the result in the form of boolean.
TRUE if the request succeeded
Stops session state monitoring that was started with Portal.session_monitor_start.
Removes an inhibitor that was created by a call to Portal.session_inhibit.
unique ID for an active inhibition
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Sets the status information of the application, for when it's running in background.
Optionalstatus_message: stringstatus message when running in background
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Sets the status information of the application, for when it's running in background.
status message when running in background
optional Gio.Cancellable
a callback to call when the request is done
Sets the status information of the application, for when it's running in background.
Optionalstatus_message: stringstatus message when running in background
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes setting the background status of the application.
true if successfully set status, false otherwise
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Sets a desktop background image, given by a uri.
parent window information
the URI to use
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Sets a desktop background image, given by a uri.
parent window information
the URI to use
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Sets a desktop background image, given by a uri.
parent window information
the URI to use
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the open-uri request.
Returns the result in the form of a boolean.
TRUE if the call succeeded
Creates a new copy of the applications sandbox, and runs a process in, with the given arguments.
The learn when the spawned process exits, connect to the
Xdp.Portal::spawn-exited signal.
the cwd for the new process
the argv for the new process
an array of open fds to pass to the new process, or NULL
an array of integers to map the fds to, or NULL. Must be the same length as fds
an array of KEY=VALUE environment settings, or NULL
flags influencing the spawn operation
Optionalsandbox_expose: string[]paths to expose rw in the new sandbox, or NULL
Optionalsandbox_expose_ro: string[]paths to expose ro in the new sandbox, or NULL
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Creates a new copy of the applications sandbox, and runs a process in, with the given arguments.
The learn when the spawned process exits, connect to the
Xdp.Portal::spawn-exited signal.
the cwd for the new process
the argv for the new process
an array of open fds to pass to the new process, or NULL
an array of integers to map the fds to, or NULL. Must be the same length as fds
an array of KEY=VALUE environment settings, or NULL
flags influencing the spawn operation
paths to expose rw in the new sandbox, or NULL
paths to expose ro in the new sandbox, or NULL
optional Gio.Cancellable
a callback to call when the request is done
Creates a new copy of the applications sandbox, and runs a process in, with the given arguments.
The learn when the spawned process exits, connect to the
Xdp.Portal::spawn-exited signal.
the cwd for the new process
the argv for the new process
an array of open fds to pass to the new process, or NULL
an array of integers to map the fds to, or NULL. Must be the same length as fds
an array of KEY=VALUE environment settings, or NULL
flags influencing the spawn operation
Optionalsandbox_expose: string[]paths to expose rw in the new sandbox, or NULL
Optionalsandbox_expose_ro: string[]paths to expose ro in the new sandbox, or NULL
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the spawn request.
Returns the pid of the newly spawned process.
the pid of the spawned process.
Sends a Unix signal to a process that has been spawned by Portal.spawn.
the pid of the process to send a signal to
the Unix signal to send (see signal(7))
whether to send the signal to the process group of the process
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Takes a screenshot.
When the request is done, callback will be called. You can then
call Portal.take_screenshot_finish to get the results.
parent window information
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Takes a screenshot.
When the request is done, callback will be called. You can then
call Portal.take_screenshot_finish to get the results.
parent window information
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Takes a screenshot.
When the request is done, callback will be called. You can then
call Portal.take_screenshot_finish to get the results.
parent window information
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes a screenshot request.
Returns the result in the form of a URI pointing to an image file.
URI pointing to an image file
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Sends the file at path to the trash can.
the path for a local file
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Sends the file at path to the trash can.
the path for a local file
optional Gio.Cancellable
a callback to call when the request is done
Sends the file at path to the trash can.
the path for a local file
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes the trash-file request.
Returns the result in the form of a boolean.
TRUE if the call succeeded
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Installs an available software update.
This should be called in response to a Xdp.Portal::update-available
signal.
During the update installation, the Xdp.Portal::update-progress
signal will be emitted to provide progress information.
a Parent
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Installs an available software update.
This should be called in response to a Xdp.Portal::update-available
signal.
During the update installation, the Xdp.Portal::update-progress
signal will be emitted to provide progress information.
a Parent
options for this call
optional Gio.Cancellable
a callback to call when the request is done
Installs an available software update.
This should be called in response to a Xdp.Portal::update-available
signal.
During the update installation, the Xdp.Portal::update-progress
signal will be emitted to provide progress information.
a Parent
options for this call
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes an update-installation request.
Returns the result in the form of boolean.
Note that the update may not be completely installed
by the time this function is called. You need to
listen to the Xdp.Portal::update-progress signal
to learn when the installation is complete.
TRUE if the update is being installed
Makes Xdp.Portal start monitoring for available software updates.
When a new update is available, the Xdp.Portal::update-available.
signal is emitted.
Use Portal.update_monitor_stop to stop monitoring.
options for this cal..
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Makes Xdp.Portal start monitoring for available software updates.
When a new update is available, the Xdp.Portal::update-available.
signal is emitted.
Use Portal.update_monitor_stop to stop monitoring.
options for this cal..
optional Gio.Cancellable
a callback to call when the request is done
Makes Xdp.Portal start monitoring for available software updates.
When a new update is available, the Xdp.Portal::update-available.
signal is emitted.
Use Portal.update_monitor_stop to stop monitoring.
options for this cal..
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable
Optionalcallback: AsyncReadyCallback<Xdp.Portal>a callback to call when the request is done
Finishes an update-monitor request.
Returns the result in the form of boolean.
TRUE if the request succeeded
Stops update monitoring that was started with Portal.update_monitor_start.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Staticinitable_StaticnewStaticrunning_Detects if running inside of a Flatpak or WebKit sandbox.
See also: Portal.running_under_sandbox.
Staticrunning_This function tries to determine if the current process is running under a sandbox that requires the use of portals.
If you need to check error conditions see Portal.running_under_snap.
Note that these functions are all cached and will always return the same result.
Staticrunning_Detects if you are running inside of a Snap sandbox.
See also: Portal.running_under_sandbox.
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Context for portal calls.
The XdpPortal object provides the main context object for the portal operations of libportal.
Typically, an application will create a single XdpPortal object with Portal.new and use it throughout its lifetime.