Optionalproperties: Partial<Secret.Service.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$gtypeA set of flags describing which parts of the secret backend have been initialized.
If this property is not Gio.BusType.NONE, then
Gio.DBusProxy.g_connection must be null and will be set to the
Gio.DBusConnection obtained by calling g_bus_get() with the value
of this property.
The timeout to use if -1 (specifying default timeout) is passed
as timeout_msec in the g_dbus_proxy_call() and
g_dbus_proxy_call_sync() functions.
This allows applications to set a proxy-wide timeout for all
remote method invocations on the proxy. If this property is -1,
the default timeout (typically 25 seconds) is used. If set to
G_MAXINT, then no timeout is used.
Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given Gio.DBusInterfaceInfo is said to be the "expected interface".
The checks performed are:
When completing a method call, if the type signature of the reply message isn't what's expected, the reply is discarded and the GLib.Error is set to Gio.IOErrorEnum.INVALID_ARGUMENT.
Received signals that have a type signature mismatch are dropped and
a warning is logged via g_warning().
Properties received via the initial GetAll() call or via the
::PropertiesChanged signal (on the
org.freedesktop.DBus.Properties
interface) or set using g_dbus_proxy_set_cached_property()
with a type signature mismatch are ignored and a warning is
logged via g_warning().
Note that these checks are never done on methods, signals and properties that are not referenced in the given Gio.DBusInterfaceInfo, since extending a D-Bus interface on the service-side is not considered an ABI break.
The unique name that owns Gio.DBusProxy.g_name or null if no-one
currently owns that name. You may connect to GObject.Object::notify signal to
track changes to this property.
If this property is not Gio.BusType.NONE, then
Gio.DBusProxy.g_connection must be null and will be set to the
Gio.DBusConnection obtained by calling g_bus_get() with the value
of this property.
The timeout to use if -1 (specifying default timeout) is passed
as timeout_msec in the g_dbus_proxy_call() and
g_dbus_proxy_call_sync() functions.
This allows applications to set a proxy-wide timeout for all
remote method invocations on the proxy. If this property is -1,
the default timeout (typically 25 seconds) is used. If set to
G_MAXINT, then no timeout is used.
Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given Gio.DBusInterfaceInfo is said to be the "expected interface".
The checks performed are:
When completing a method call, if the type signature of the reply message isn't what's expected, the reply is discarded and the GLib.Error is set to Gio.IOErrorEnum.INVALID_ARGUMENT.
Received signals that have a type signature mismatch are dropped and
a warning is logged via g_warning().
Properties received via the initial GetAll() call or via the
::PropertiesChanged signal (on the
org.freedesktop.DBus.Properties
interface) or set using g_dbus_proxy_set_cached_property()
with a type signature mismatch are ignored and a warning is
logged via g_warning().
Note that these checks are never done on methods, signals and properties that are not referenced in the given Gio.DBusInterfaceInfo, since extending a D-Bus interface on the service-side is not considered an ABI break.
The unique name that owns Gio.DBusProxy.g_name or null if no-one
currently owns that name. You may connect to GObject.Object::notify signal to
track changes to this property.
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
Remove unlocked items which match the attributes from the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the schema for the attributes
the attribute keys and values
Optionalcancellable: Gio.Cancellableoptional cancellation object
Remove unlocked items which match the attributes from the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the schema for the attributes
the attribute keys and values
optional cancellation object
called when the operation completes
Remove unlocked items which match the attributes from the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the schema for the attributes
the attribute keys and values
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Finish asynchronous operation to remove items from the secret service.
the asynchronous result passed to the callback
whether items were removed or not
Remove unlocked items which match the attributes from the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get_sync will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads.
the schema for the attributes
the attribute keys and values
Optionalcancellable: Gio.Cancellableoptional cancellation object
whether items were removed or not
SignalconnectSignalconnect_Create a new item in a secret service collection and return its D-Bus object path.
It is often easier to use password_store_sync or Item.create_sync
rather than using this function. Using this method requires that you setup
a correct hash table of D-Bus properties for the new collection.
If the flags contains Secret.ItemCreateFlags.REPLACE, then the secret
service will search for an item matching the attributes, and update that item
instead of creating a new one.
properties is a set of properties for the new collection. The keys in the
hash table should be interface.property strings like
org.freedesktop.Secret.Item.Label. The values
in the hash table should be GLib.Variant values of the properties.
This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. Service.prompt will be used to handle any prompts that are required.
the D-Bus path of the collection in which to create item
hash table of D-Bus properties for the new collection
the secret value to store in the item
flags for the creation of the new item
Optionalcancellable: Gio.Cancellableoptional cancellation object
a new string containing the D-Bus object path of the item
Decode a Value into GLib.Variant received with the Secret Service DBus API.
The GLib.Variant should have a (oayays) signature.
A session must have already been established by the Service, and the encoded secret must be valid for that session.
the decoded secret value
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
SignalemitEncodes a Value into GLib.Variant for use with the Secret Service DBus API.
The resulting GLib.Variant will have a (oayays) signature.
A session must have already been established by the Service.
the encoded secret
Ensure that the Secret.Service proxy has established a session with the Secret Service.
This session is used to transfer secrets.
It is not normally necessary to call this method, as the session is established as necessary. You can also pass the Secret.ServiceFlags.OPEN_SESSION to Service.get in order to ensure that a session has been established by the time you get the Secret.Service proxy.
This method will return immediately and complete asynchronously.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Ensure that the Secret.Service proxy has established a session with the Secret Service.
This session is used to transfer secrets.
It is not normally necessary to call this method, as the session is established as necessary. You can also pass the Secret.ServiceFlags.OPEN_SESSION to Service.get in order to ensure that a session has been established by the time you get the Secret.Service proxy.
This method will return immediately and complete asynchronously.
optional cancellation object
called when the operation completes
Ensure that the Secret.Service proxy has established a session with the Secret Service.
This session is used to transfer secrets.
It is not normally necessary to call this method, as the session is established as necessary. You can also pass the Secret.ServiceFlags.OPEN_SESSION to Service.get in order to ensure that a session has been established by the time you get the Secret.Service proxy.
This method will return immediately and complete asynchronously.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Finish an asynchronous operation to ensure that the Secret.Service proxy has established a session with the Secret Service.
the asynchronous result passed to the callback
whether a session is established or not
Ensure that the Secret.Service proxy has established a session with the Secret Service.
This session is used to transfer secrets.
It is not normally necessary to call this method, as the session is established as necessary. You can also pass the Secret.ServiceFlags.OPEN_SESSION to Service.get_sync in order to ensure that a session has been established by the time you get the Secret.Service proxy.
This method may block indefinitely and should not be used in user interface threads.
Optionalcancellable: Gio.Cancellableoptional cancellation object
whether a session is established or not
This 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.
Get the GObject type for collections instantiated by this service.
This will always be either Collection or derived from it.
the gobject type for collections
Get a list of Collection objects representing all the collections in the secret service.
If the Secret.ServiceFlags.LOAD_COLLECTIONS flag was not specified when
initializing Secret.Service proxy object, then this method will return
null. Use Service.load_collections to load the collections.
a list of the collections in the secret service
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.
Get the flags representing what features of the Secret.Service proxy have been initialized.
Use Service.ensure_session or Service.load_collections to initialize further features and change the flags.
the flags for features initialized
Gets D-Bus introspection information for the D-Bus interface
implemented by interface_.
A Gio.DBusInterfaceInfo. Do not free.
Gets the Gio.DBusObject that interface_ belongs to, if any.
A Gio.DBusObject or null. The returned reference should be freed with g_object_unref().
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
Get the set of algorithms being used to transfer secrets between this secret service proxy and the Secret Service itself.
This will be null if no session has been established. Use
Service.ensure_session to establish a session.
a string representing the algorithms for transferring secrets
Get the D-Bus object path of the session object being used to transfer secrets between this secret service proxy and the Secret Service itself.
This will be null if no session has been established. Use
Service.ensure_session to establish a session.
a string representing the D-Bus object path of the session
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.
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
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.
As with Gio.Initable, 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. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
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.
As with Gio.Initable, 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. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback to call when the request is satisfied
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
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.
As with Gio.Initable, 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. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Secret.Service>a Gio.AsyncReadyCallback to call when the request is satisfied
Finishes asynchronous initialization and returns the result.
See g_async_initable_init_async().
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Ensure that the Secret.Service proxy has loaded all the collections present in the Secret Service.
This affects the result of Service.get_collections.
You can also pass the Secret.ServiceFlags.LOAD_COLLECTIONS to Service.get_sync in order to ensure that the collections have been loaded by the time you get the Secret.Service proxy.
This method will return immediately and complete asynchronously.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Ensure that the Secret.Service proxy has loaded all the collections present in the Secret Service.
This affects the result of Service.get_collections.
You can also pass the Secret.ServiceFlags.LOAD_COLLECTIONS to Service.get_sync in order to ensure that the collections have been loaded by the time you get the Secret.Service proxy.
This method will return immediately and complete asynchronously.
optional cancellation object
called when the operation completes
Ensure that the Secret.Service proxy has loaded all the collections present in the Secret Service.
This affects the result of Service.get_collections.
You can also pass the Secret.ServiceFlags.LOAD_COLLECTIONS to Service.get_sync in order to ensure that the collections have been loaded by the time you get the Secret.Service proxy.
This method will return immediately and complete asynchronously.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Complete an asynchronous operation to ensure that the Secret.Service proxy has loaded all the collections present in the Secret Service.
the asynchronous result passed to the callback
whether the load was successful or not
Ensure that the Secret.Service proxy has loaded all the collections present in the Secret Service.
This affects the result of Service.get_collections.
You can also pass the Secret.ServiceFlags.LOAD_COLLECTIONS to Service.get_sync in order to ensure that the collections have been loaded by the time you get the Secret.Service proxy.
This method may block indefinitely and should not be used in user interface threads.
Optionalcancellable: Gio.Cancellableoptional cancellation object
whether the load was successful or not
Lock items or collections in the secret service.
The secret service may not be able to lock items individually, and may lock an entire collection instead.
If service is null, then Service.get will be called to get
the default Service proxy.
This method returns immediately and completes asynchronously. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to lock
Optionalcancellable: Gio.Cancellableoptional cancellation object
Lock items or collections in the secret service.
The secret service may not be able to lock items individually, and may lock an entire collection instead.
If service is null, then Service.get will be called to get
the default Service proxy.
This method returns immediately and completes asynchronously. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to lock
optional cancellation object
called when the operation completes
Lock items or collections in the secret service.
The secret service may not be able to lock items individually, and may lock an entire collection instead.
If service is null, then Service.get will be called to get
the default Service proxy.
This method returns immediately and completes asynchronously. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to lock
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Complete asynchronous operation to lock items or collections in the secret service.
The secret service may not be able to lock items individually, and may lock an entire collection instead.
asynchronous result passed to the callback
the number of items or collections that were locked
Lock items or collections in the secret service.
The secret service may not be able to lock items individually, and may lock an entire collection instead.
If service is null, then Service.get_sync will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to lock
Optionalcancellable: Gio.Cancellableoptional cancellation object
the number of items or collections that were locked
Lookup a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the schema for the attributes
the attribute keys and values
Optionalcancellable: Gio.Cancellableoptional cancellation object
Lookup a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the schema for the attributes
the attribute keys and values
optional cancellation object
called when the operation completes
Lookup a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the schema for the attributes
the attribute keys and values
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Finish asynchronous operation to lookup a secret value in the secret service.
If no secret is found then null is returned.
the asynchronous result passed to the callback
a newly allocated Value, which should be released with Value.unref, or null if no secret found
Lookup a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If service is null, then Service.get_sync will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads.
the schema for the attributes
the attribute keys and values
Optionalcancellable: Gio.Cancellableoptional cancellation object
a newly allocated Value, which should be released with Value.unref, or null if no secret found
Finishes the async construction for the various g_async_initable_new
calls, returning the created object or null on error.
the Gio.AsyncResult from the callback
a newly created GObject.Object, or null on error. Free with g_object_unref().
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.
Perform prompting for a Prompt.
This function is called by other parts of this library to handle prompts for the various actions that can require prompting.
Override the Secret.ServiceClass Service.prompt_async virtual method to change the behavior of the prompting. The default behavior is to simply run Prompt.perform on the prompt.
the prompt
Optionalreturn_type: GLib.VariantType<any>the variant type of the prompt result
Optionalcancellable: Gio.Cancellableoptional cancellation object
Perform prompting for a Prompt.
This function is called by other parts of this library to handle prompts for the various actions that can require prompting.
Override the Secret.ServiceClass Service.prompt_async virtual method to change the behavior of the prompting. The default behavior is to simply run Prompt.perform on the prompt.
the prompt
the variant type of the prompt result
optional cancellation object
called when the operation completes
Perform prompting for a Prompt.
This function is called by other parts of this library to handle prompts for the various actions that can require prompting.
Override the Secret.ServiceClass Service.prompt_async virtual method to change the behavior of the prompting. The default behavior is to simply run Prompt.perform on the prompt.
the prompt
Optionalreturn_type: GLib.VariantType<any>the variant type of the prompt result
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Complete asynchronous operation to perform prompting for a Prompt.
Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.
the asynchronous result passed to the callback
null if the prompt was dismissed or an error occurred, a variant result if the prompt was successful
Perform prompting for a Prompt.
Runs a prompt and performs the prompting. Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.
This function is called by other parts of this library to handle prompts for the various actions that can require prompting.
Override the Secret.ServiceClass Service.prompt_sync virtual method
to change the behavior of the prompting. The default behavior is to simply
run Prompt.perform_sync on the prompt with a null window_id.
the prompt
optional cancellation object
the variant type of the prompt result
null if the prompt was dismissed or an error occurred, a variant result if the prompt 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
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Search for items matching the attributes.
All collections are searched. The attributes should be a table of string
keys and string values.
If service is null, then Service.get will be called to get
the default Service proxy.
If Secret.SearchFlags.ALL is set in flags, then all the items matching the
search will be returned. Otherwise only the first item will be returned.
This is almost always the unlocked item that was most recently stored.
If Secret.SearchFlags.UNLOCK is set in flags, then items will be unlocked
if necessary. In either case, locked and unlocked items will match the
search and be returned. If the unlock fails, the search does not fail.
If Secret.SearchFlags.LOAD_SECRETS is set in flags, then the items will have
their secret values loaded and available via Item.get_secret.
This function returns immediately and completes asynchronously.
the schema for the attributes
search for items matching these attributes
search option flags
Optionalcancellable: Gio.Cancellableoptional cancellation object
Search for items matching the attributes.
All collections are searched. The attributes should be a table of string
keys and string values.
If service is null, then Service.get will be called to get
the default Service proxy.
If Secret.SearchFlags.ALL is set in flags, then all the items matching the
search will be returned. Otherwise only the first item will be returned.
This is almost always the unlocked item that was most recently stored.
If Secret.SearchFlags.UNLOCK is set in flags, then items will be unlocked
if necessary. In either case, locked and unlocked items will match the
search and be returned. If the unlock fails, the search does not fail.
If Secret.SearchFlags.LOAD_SECRETS is set in flags, then the items will have
their secret values loaded and available via Item.get_secret.
This function returns immediately and completes asynchronously.
the schema for the attributes
search for items matching these attributes
search option flags
optional cancellation object
called when the operation completes
Search for items matching the attributes.
All collections are searched. The attributes should be a table of string
keys and string values.
If service is null, then Service.get will be called to get
the default Service proxy.
If Secret.SearchFlags.ALL is set in flags, then all the items matching the
search will be returned. Otherwise only the first item will be returned.
This is almost always the unlocked item that was most recently stored.
If Secret.SearchFlags.UNLOCK is set in flags, then items will be unlocked
if necessary. In either case, locked and unlocked items will match the
search and be returned. If the unlock fails, the search does not fail.
If Secret.SearchFlags.LOAD_SECRETS is set in flags, then the items will have
their secret values loaded and available via Item.get_secret.
This function returns immediately and completes asynchronously.
the schema for the attributes
search for items matching these attributes
search option flags
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Complete asynchronous operation to search for items.
asynchronous result passed to callback
a list of items that matched the search
Search for items matching the attributes.
All collections are searched. The attributes should be a table of string
keys and string values.
If service is null, then Service.get_sync will be called to get
the default Service proxy.
If Secret.SearchFlags.ALL is set in flags, then all the items matching the
search will be returned. Otherwise only the first item will be returned.
This is almost always the unlocked item that was most recently stored.
If Secret.SearchFlags.UNLOCK is set in flags, then items will be unlocked
if necessary. In either case, locked and unlocked items will match the
search and be returned. If the unlock fails, the search does not fail.
If Secret.SearchFlags.LOAD_SECRETS is set in flags, then the items' secret
values will be loaded for any unlocked items. Loaded item secret values
are available via Item.get_secret. If the load of a secret values
fail, then the
This function may block indefinitely. Use the asynchronous version in user interface threads.
the schema for the attributes
search for items matching these attributes
search option flags
Optionalcancellable: Gio.Cancellableoptional cancellation object
a list of items that matched the search
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
Assign a collection to this alias.
Aliases help determine well known collections, such as 'default'.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the alias to assign the collection to
Optionalcollection: Secret.Collectionthe collection to assign to the alias
Optionalcancellable: Gio.Cancellableoptional cancellation object
Assign a collection to this alias.
Aliases help determine well known collections, such as 'default'.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the alias to assign the collection to
the collection to assign to the alias
optional cancellation object
called when the operation completes
Assign a collection to this alias.
Aliases help determine well known collections, such as 'default'.
If service is null, then Service.get will be called to get
the default Service proxy.
This method will return immediately and complete asynchronously.
the alias to assign the collection to
Optionalcollection: Secret.Collectionthe collection to assign to the alias
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Finish an asynchronous operation to assign a collection to an alias.
asynchronous result passed to callback
true if successful
Assign a collection to this alias. Aliases help determine well known collections, such as 'default'.
If service is null, then Service.get_sync will be called to get
the default Service proxy.
This method may block and should not be used in user interface threads.
the alias to assign the collection to
Optionalcollection: Secret.Collectionthe collection to assign to the alias
Optionalcancellable: Gio.Cancellableoptional cancellation object
true if successful
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 the Gio.DBusObject for interface_ to object.
Note that interface_ will hold a weak reference to object.
Optionalobject: Gio.DBusObjectA Gio.DBusObject or null.
Sets a property on an object.
The name of the property to set
The value to set the property to
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
Store a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.
If service is null, then Service.get will be called to get
the default Service proxy.
If collection is not specified, then the default collection will be
used. Use COLLECTION_SESSION to store the password in the session
collection, which doesn't get stored across login sessions.
This method will return immediately and complete asynchronously.
the schema to use to check attributes
the attribute keys and values
a collection alias, or D-Bus object path of the collection where to store the secret
label for the secret
the secret value
Optionalcancellable: Gio.Cancellableoptional cancellation object
Store a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.
If service is null, then Service.get will be called to get
the default Service proxy.
If collection is not specified, then the default collection will be
used. Use COLLECTION_SESSION to store the password in the session
collection, which doesn't get stored across login sessions.
This method will return immediately and complete asynchronously.
the schema to use to check attributes
the attribute keys and values
a collection alias, or D-Bus object path of the collection where to store the secret
label for the secret
the secret value
optional cancellation object
called when the operation completes
Store a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.
If service is null, then Service.get will be called to get
the default Service proxy.
If collection is not specified, then the default collection will be
used. Use COLLECTION_SESSION to store the password in the session
collection, which doesn't get stored across login sessions.
This method will return immediately and complete asynchronously.
the schema to use to check attributes
the attribute keys and values
a collection alias, or D-Bus object path of the collection where to store the secret
label for the secret
the secret value
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Finish asynchronous operation to store a secret value in the secret service.
the asynchronous result passed to the callback
whether the storage was successful or not
Store a secret value in the secret service.
The attributes should be a set of key and value string pairs.
If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.
If collection is null, then the default collection will be
used. Use COLLECTION_SESSION to store the password in the session
collection, which doesn't get stored across login sessions.
If service is null, then Service.get_sync will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads.
the schema for the attributes
the attribute keys and values
a collection alias, or D-Bus object path of the collection where to store the secret
label for the secret
the secret value
Optionalcancellable: Gio.Cancellableoptional cancellation object
whether the storage was successful or not
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.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Unlock items or collections in the secret service.
The secret service may not be able to unlock items individually, and may unlock an entire collection instead.
If service is null, then Service.get will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to unlock
Optionalcancellable: Gio.Cancellableoptional cancellation object
Unlock items or collections in the secret service.
The secret service may not be able to unlock items individually, and may unlock an entire collection instead.
If service is null, then Service.get will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to unlock
optional cancellation object
called when the operation completes
Unlock items or collections in the secret service.
The secret service may not be able to unlock items individually, and may unlock an entire collection instead.
If service is null, then Service.get will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to unlock
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Complete asynchronous operation to unlock items or collections in the secret service.
The secret service may not be able to unlock items individually, and may unlock an entire collection instead.
asynchronous result passed to the callback
the number of items or collections that were unlocked
Unlock items or collections in the secret service.
The secret service may not be able to unlock items individually, and may unlock an entire collection instead.
If service is null, then Service.get_sync will be called to get
the default Service proxy.
This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. Service.prompt will be used to handle any prompts that show up.
the items or collections to unlock
Optionalcancellable: Gio.Cancellableoptional cancellation object
the number of items or collections that were unlocked
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.
Virtualvfunc_implementation of password_clear, required
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Secret.Service>Virtualvfunc_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_Gets the Gio.DBusObject that interface_ belongs to, if any.
Virtualvfunc_implementation of reinitialization step in constructor, optional
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Secret.Service>Virtualvfunc_implementation of reinitialization step in constructor, optional
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_Get the GObject type for collections instantiated by this service.
This will always be either Collection or derived from it.
Virtualvfunc_Gets D-Bus introspection information for the D-Bus interface
implemented by interface_.
Virtualvfunc_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_Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
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.
As with Gio.Initable, 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. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Secret.Service>a Gio.AsyncReadyCallback to call when the request is satisfied
Virtualvfunc_Finishes asynchronous initialization and returns the result.
See g_async_initable_init_async().
Virtualvfunc_implementation of password_lookup, required
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Secret.Service>Virtualvfunc_implementation of password_lookup_finish, required
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_called to perform asynchronous prompting when necessary
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Secret.Service>Virtualvfunc_Complete asynchronous operation to perform prompting for a Prompt.
Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.
the asynchronous result passed to the callback
Virtualvfunc_Perform prompting for a Prompt.
Runs a prompt and performs the prompting. Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.
This function is called by other parts of this library to handle prompts for the various actions that can require prompting.
Override the Secret.ServiceClass Service.prompt_sync virtual method
to change the behavior of the prompting. The default behavior is to simply
run Prompt.perform_sync on the prompt with a null window_id.
the prompt
optional cancellation object
the variant type of the prompt result
Virtualvfunc_implementation of password_search, required
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Secret.Service>Virtualvfunc_Sets the Gio.DBusObject for interface_ to object.
Note that interface_ will hold a weak reference to object.
Optionalobject: Gio.DBusObjectA Gio.DBusObject or null.
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.
Virtualvfunc_implementation of password_store, required
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Secret.Service>Virtualvfunc_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
StaticdisconnectDisconnect the default Secret.Service proxy returned by Service.get and Service.get_sync.
It is not necessary to call this function, but you may choose to do so at program exit. It is useful for testing that memory is not leaked.
This function is safe to call at any time. But if other objects in this library are still referenced, then this will not result in all memory being freed.
StaticgetGet a Secret.Service proxy for the Secret Service.
If such a proxy object already exists, then the same proxy is returned.
If flags contains any flags of which parts of the secret service to
ensure are initialized, then those will be initialized before completing.
This method will return immediately and complete asynchronously.
flags for which service functionality to ensure is initialized
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Staticget_Complete an asynchronous operation to get a Secret.Service proxy for the Secret Service.
the asynchronous result passed to the callback
Staticget_Get a Secret.Service proxy for the Secret Service.
If such a proxy object already exists, then the same proxy is returned.
If flags contains any flags of which parts of the secret service to
ensure are initialized, then those will be initialized before returning.
This method may block indefinitely and should not be used in user interface threads.
flags for which service functionality to ensure is initialized
Optionalcancellable: Gio.Cancellableoptional cancellation object
StaticopenCreate a new Secret.Service proxy for the Secret Service.
This function is rarely used, see Service.get instead.
The service_gtype argument should be set to SECRET_TYPE_SERVICE or a the type
of a derived class.
If flags contains any flags of which parts of the secret service to
ensure are initialized, then those will be initialized before returning.
If service_bus_name is null then the default is used.
This method will return immediately and complete asynchronously.
the GType of the new secret service
the D-Bus service name of the secret service
flags for which service functionality to ensure is initialized
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Secret.Service>called when the operation completes
Staticopen_Complete an asynchronous operation to create a new Secret.Service proxy for the Secret Service.
the asynchronous result passed to the callback
Staticopen_Create a new Secret.Service proxy for the Secret Service.
This function is rarely used, see Service.get_sync instead.
The service_gtype argument should be set to SECRET_TYPE_SERVICE or a the
type of a derived class.
If flags contains any flags of which parts of the secret service to
ensure are initialized, then those will be initialized before returning.
If service_bus_name is null then the default is used.
This method may block indefinitely and should not be used in user interface threads.
the GType of the new secret service
the D-Bus service name of the secret service
flags for which service functionality to ensure is initialized
Optionalcancellable: Gio.Cancellableoptional cancellation object
Asynchronously invokes the method_name method on proxy.
If method_name contains any dots, then name is split into interface and
method name parts. This allows using proxy for invoking methods on
other interfaces.
If the Gio.DBusConnection associated with proxy is closed then
the operation will fail with Gio.IOErrorEnum.CLOSED. If
cancellable is canceled, the operation will fail with
Gio.IOErrorEnum.CANCELLED. If parameters contains a value not
compatible with the D-Bus protocol, the operation fails with
Gio.IOErrorEnum.INVALID_ARGUMENT.
If the parameters GLib.Variant is floating, it is consumed. This allows
convenient 'inline' use of g_variant_new(), e.g.:
g_dbus_proxy_call (proxy,
"TwoStrings",
g_variant_new ("(ss)",
"Thing One",
"Thing Two"),
G_DBUS_CALL_FLAGS_NONE,
-1,
NULL,
(GAsyncReadyCallback) two_strings_done,
&data);
If proxy has an expected interface (see
Gio.DBusProxy.g_interface_info) and method_name is referenced by it,
then the return value is checked against the return type.
This is an asynchronous method. When the operation is finished,
callback will be invoked in the thread-default main context
(see GLib.MainContext.push_thread_default)
of the thread you are calling this method from.
You can then call g_dbus_proxy_call_finish() to get the result of
the operation. See g_dbus_proxy_call_sync() for the synchronous
version of this method.
If callback is null then the D-Bus method call message will be sent with
the Gio.DBusMessageFlags.NO_REPLY_EXPECTED flag set.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
Asynchronously invokes the method_name method on proxy.
If method_name contains any dots, then name is split into interface and
method name parts. This allows using proxy for invoking methods on
other interfaces.
If the Gio.DBusConnection associated with proxy is closed then
the operation will fail with Gio.IOErrorEnum.CLOSED. If
cancellable is canceled, the operation will fail with
Gio.IOErrorEnum.CANCELLED. If parameters contains a value not
compatible with the D-Bus protocol, the operation fails with
Gio.IOErrorEnum.INVALID_ARGUMENT.
If the parameters GLib.Variant is floating, it is consumed. This allows
convenient 'inline' use of g_variant_new(), e.g.:
g_dbus_proxy_call (proxy,
"TwoStrings",
g_variant_new ("(ss)",
"Thing One",
"Thing Two"),
G_DBUS_CALL_FLAGS_NONE,
-1,
NULL,
(GAsyncReadyCallback) two_strings_done,
&data);
If proxy has an expected interface (see
Gio.DBusProxy.g_interface_info) and method_name is referenced by it,
then the return value is checked against the return type.
This is an asynchronous method. When the operation is finished,
callback will be invoked in the thread-default main context
(see GLib.MainContext.push_thread_default)
of the thread you are calling this method from.
You can then call g_dbus_proxy_call_finish() to get the result of
the operation. See g_dbus_proxy_call_sync() for the synchronous
version of this method.
If callback is null then the D-Bus method call message will be sent with
the Gio.DBusMessageFlags.NO_REPLY_EXPECTED flag set.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
A Gio.Cancellable or null.
A Gio.AsyncReadyCallback to call when the request is satisfied or null if you don't care about the result of the method invocation.
Asynchronously invokes the method_name method on proxy.
If method_name contains any dots, then name is split into interface and
method name parts. This allows using proxy for invoking methods on
other interfaces.
If the Gio.DBusConnection associated with proxy is closed then
the operation will fail with Gio.IOErrorEnum.CLOSED. If
cancellable is canceled, the operation will fail with
Gio.IOErrorEnum.CANCELLED. If parameters contains a value not
compatible with the D-Bus protocol, the operation fails with
Gio.IOErrorEnum.INVALID_ARGUMENT.
If the parameters GLib.Variant is floating, it is consumed. This allows
convenient 'inline' use of g_variant_new(), e.g.:
g_dbus_proxy_call (proxy,
"TwoStrings",
g_variant_new ("(ss)",
"Thing One",
"Thing Two"),
G_DBUS_CALL_FLAGS_NONE,
-1,
NULL,
(GAsyncReadyCallback) two_strings_done,
&data);
If proxy has an expected interface (see
Gio.DBusProxy.g_interface_info) and method_name is referenced by it,
then the return value is checked against the return type.
This is an asynchronous method. When the operation is finished,
callback will be invoked in the thread-default main context
(see GLib.MainContext.push_thread_default)
of the thread you are calling this method from.
You can then call g_dbus_proxy_call_finish() to get the result of
the operation. See g_dbus_proxy_call_sync() for the synchronous
version of this method.
If callback is null then the D-Bus method call message will be sent with
the Gio.DBusMessageFlags.NO_REPLY_EXPECTED flag set.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
Optionalcallback: AsyncReadyCallback<Secret.Service>A Gio.AsyncReadyCallback to call when the request is satisfied or null if you don't care about the result of the method invocation.
Finishes an operation started with g_dbus_proxy_call().
A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to g_dbus_proxy_call().
null if error is set. Otherwise a GLib.Variant tuple with return values. Free with g_variant_unref().
Synchronously invokes the method_name method on proxy.
If method_name contains any dots, then name is split into interface and
method name parts. This allows using proxy for invoking methods on
other interfaces.
If the Gio.DBusConnection associated with proxy is disconnected then
the operation will fail with Gio.IOErrorEnum.CLOSED. If
cancellable is canceled, the operation will fail with
Gio.IOErrorEnum.CANCELLED. If parameters contains a value not
compatible with the D-Bus protocol, the operation fails with
Gio.IOErrorEnum.INVALID_ARGUMENT.
If the parameters GLib.Variant is floating, it is consumed. This allows
convenient 'inline' use of g_variant_new(), e.g.:
g_dbus_proxy_call_sync (proxy,
"TwoStrings",
g_variant_new ("(ss)",
"Thing One",
"Thing Two"),
G_DBUS_CALL_FLAGS_NONE,
-1,
NULL,
&error);
The calling thread is blocked until a reply is received. See
g_dbus_proxy_call() for the asynchronous version of this
method.
If proxy has an expected interface (see
Gio.DBusProxy.g_interface_info) and method_name is referenced by it,
then the return value is checked against the return type.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
null if error is set. Otherwise a GLib.Variant tuple with return values. Free with g_variant_unref().
Like g_dbus_proxy_call() but also takes a Gio.UnixFDList object.
This method is only available on UNIX.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
Optionalfd_list: Gio.UnixFDListA Gio.UnixFDList or null.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
Like g_dbus_proxy_call() but also takes a Gio.UnixFDList object.
This method is only available on UNIX.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
A Gio.UnixFDList or null.
A Gio.Cancellable or null.
A Gio.AsyncReadyCallback to call when the request is satisfied or null if you don't care about the result of the method invocation.
Like g_dbus_proxy_call() but also takes a Gio.UnixFDList object.
This method is only available on UNIX.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
Optionalfd_list: Gio.UnixFDListA Gio.UnixFDList or null.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
Optionalcallback: AsyncReadyCallback<Secret.Service>A Gio.AsyncReadyCallback to call when the request is satisfied or null if you don't care about the result of the method invocation.
Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list().
A Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list().
null if error is set. Otherwise a GLib.Variant tuple with return values. Free with g_variant_unref().
Like g_dbus_proxy_call_sync() but also takes and returns Gio.UnixFDList objects.
This method is only available on UNIX.
Name of method to invoke.
A GLib.Variant tuple with parameters for the signal or null if not passing parameters.
Flags from the Gio.DBusCallFlags enumeration.
The timeout in milliseconds (with G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
Optionalfd_list: Gio.UnixFDListA Gio.UnixFDList or null.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
null if error is set. Otherwise a GLib.Variant tuple with return values. Free with g_variant_unref().
Looks up the value for a property from the cache. This call does no blocking IO.
If proxy has an expected interface (see
Gio.DBusProxy.g_interface_info) and property_name is referenced by
it, then value is checked against the type of the property.
Property name.
A reference to the GLib.Variant instance that holds the value for property_name or null if the value is not in the cache. The returned reference must be freed with g_variant_unref().
Gets the names of all cached properties on proxy.
A null-terminated array of strings or null if proxy has no cached properties. Free the returned array with g_strfreev().
Gets the connection proxy is for.
A Gio.DBusConnection owned by proxy. Do not free.
Gets the timeout to use if -1 (specifying default timeout) is
passed as timeout_msec in the g_dbus_proxy_call() and
g_dbus_proxy_call_sync() functions.
See the Gio.DBusProxy.g_default_timeout property for more details.
Timeout to use for proxy.
Returns the Gio.DBusInterfaceInfo, if any, specifying the interface
that proxy conforms to. See the Gio.DBusProxy.g_interface_info
property for more details.
A Gio.DBusInterfaceInfo or null. Do not unref the returned object, it is owned by proxy.
Gets the D-Bus interface name proxy is for.
A string owned by proxy. Do not free.
Gets the name that proxy was constructed for.
When connected to a message bus, this will usually be non-null.
However, it may be null for a proxy that communicates using a peer-to-peer
pattern.
A string owned by proxy. Do not free.
The unique name that owns the name that proxy is for or null if
no-one currently owns that name. You may connect to the
GObject.Object::notify signal to track changes to the
Gio.DBusProxy.g_name_owner property.
The name owner or null if no name owner exists. Free with g_free().
Gets the object path proxy is for.
A string owned by proxy. Do not free.
If value is not null, sets the cached value for the property with
name property_name to the value in value.
If value is null, then the cached value is removed from the
property cache.
If proxy has an expected interface (see
Gio.DBusProxy.g_interface_info) and property_name is referenced by
it, then value is checked against the type of the property.
If the value GLib.Variant is floating, it is consumed. This allows
convenient 'inline' use of g_variant_new(), e.g.
g_dbus_proxy_set_cached_property (proxy,
"SomeProperty",
g_variant_new ("(si)",
"A String",
42));
Normally you will not need to use this method since proxy
is tracking changes using the
org.freedesktop.DBus.Properties.PropertiesChanged
D-Bus signal. However, for performance reasons an object may
decide to not use this signal for some properties and instead
use a proprietary out-of-band mechanism to transmit changes.
As a concrete example, consider an object with a property
ChatroomParticipants which is an array of strings. Instead of
transmitting the same (long) array every time the property changes,
it is more efficient to only transmit the delta using e.g. signals
ChatroomParticipantJoined(String name) and
ChatroomParticipantParted(String name).
Sets the timeout to use if -1 (specifying default timeout) is
passed as timeout_msec in the g_dbus_proxy_call() and
g_dbus_proxy_call_sync() functions.
See the Gio.DBusProxy.g_default_timeout property for more details.
Timeout in milliseconds.
Ensure that interactions with proxy conform to the given
interface. See the Gio.DBusProxy.g_interface_info property for more
details.
Optionalinfo: DBusInterfaceInfoMinimum interface this proxy conforms to or null to unset.
Virtualvfunc_Virtualvfunc_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_StaticmakeStaticnewCreates a proxy for accessing interface_name on the remote object
at object_path owned by name at connection and asynchronously
loads D-Bus properties unless the
Gio.DBusProxyFlags.DO_NOT_LOAD_PROPERTIES flag is used. Connect to
the Gio.DBusProxy.SignalSignatures.g_properties_changed | Gio.DBusProxy::g-properties-changed signal to get notified about
property changes.
If the Gio.DBusProxyFlags.DO_NOT_CONNECT_SIGNALS flag is not set, also sets up match rules for signals. Connect to the Gio.DBusProxy.SignalSignatures.g_signal | Gio.DBusProxy::g-signal signal to handle signals from the remote object.
If both Gio.DBusProxyFlags.DO_NOT_LOAD_PROPERTIES and Gio.DBusProxyFlags.DO_NOT_CONNECT_SIGNALS are set, this constructor is guaranteed to complete immediately without blocking.
If name is a well-known name and the
Gio.DBusProxyFlags.DO_NOT_AUTO_START and Gio.DBusProxyFlags.DO_NOT_AUTO_START_AT_CONSTRUCTION
flags aren't set and no name owner currently exists, the message bus
will be requested to launch a name owner for the name.
This is a failable asynchronous constructor - when the proxy is
ready, callback will be invoked and you can use
g_dbus_proxy_new_finish() to get the result.
See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
Gio.DBusProxy is used in this [example][class@Gio.DBusProxy#a-watch-proxy-example].
Flags used when constructing the proxy.
A Gio.DBusInterfaceInfo specifying the minimal interface that proxy conforms to or null.
A bus name (well-known or unique) or null if connection is not a message bus connection.
An object path.
A D-Bus interface name.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
Optionalcallback: AsyncReadyCallback<Gio.DBusProxy>Callback function to invoke when the proxy is ready.
Staticnew_Staticnew_Like g_dbus_proxy_new() but takes a Gio.BusType instead of a Gio.DBusConnection.
Gio.DBusProxy is used in this [example][class@Gio.DBusProxy#a-watch-proxy-example].
A Gio.BusType.
Flags used when constructing the proxy.
A Gio.DBusInterfaceInfo specifying the minimal interface that proxy conforms to or null.
A bus name (well-known or unique).
An object path.
A D-Bus interface name.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null.
Optionalcallback: AsyncReadyCallback<Gio.DBusProxy>Callback function to invoke when the proxy is ready.
Staticnew_Staticnew_Optionalcancellable: Gio.CancellableStaticnew_Optionalcancellable: Gio.CancellableStaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
A proxy object representing the Secret Service.
A Secret.Service object either represents an implementation of the
org.freedesktop.SecretD-Bus service or a file that is encrypted using a master secret that was provided by the secret portal.Normally a single Secret.Service object can be shared between multiple callers. The Service.get method is used to access this Secret.Service object. If a new independent Secret.Service object is required, use Service.open.
In order to securely transfer secrets to the Sercret Service, a session is established. This session can be established while initializing a Secret.Service object by passing the Secret.ServiceFlags.OPEN_SESSION flag to the Service.get or Service.open functions. In order to establish a session on an already existing Secret.Service, use the Service.ensure_session function.
To search for items, use the Service.search method.
Multiple collections can exist in the Secret Service, each of which contains secret items. In order to instantiate Collection objects which represent those collections while initializing a Secret.Service then pass the Secret.ServiceFlags.LOAD_COLLECTIONS flag to the Service.get or Service.open functions. In order to establish a session on an already existing Secret.Service, use the Service.load_collections function. To access the list of collections use Service.get_collections.
Certain actions on the Secret Service require user prompting to complete, such as creating a collection, or unlocking a collection. When such a prompt is necessary, then a Prompt object is created by this library, and passed to the Service.prompt method. In this way it is handled automatically.
In order to customize prompt handling, override the Service.prompt_async and Service.prompt_finish virtual methods of the Secret.Service class.