Secret.Collection
Description: Reference for Secret.Collection

### Class

# SecretCollection

#### Description [src]

    class Secret.Collection : Gio.DBusProxy {
      parent: GDBusProxy
    }

A proxy object representing a collection of secrets in the Secret Service.

`SecretCollection` represents a collection of secret items stored in the Secret Service.

A collection can be in a locked or unlocked state. Use `secret_service_lock()` or `secret_service_unlock()` to lock or unlock the collection.

Use the `SecretCollection:items` property or `secret_collection_get_items()` to lookup the items in the collection. There may not be any items exposed when the collection is locked.

Stability: Stable

#### Hierarchy

#### Ancestors

- GDBusProxy
- GObject

#### Implements

- GAsyncInitable
- GDBusInterface
- GInitable

#### Constructors

###### secret_collection_new_for_dbus_path_finish

Finish asynchronous operation to get a new collection proxy for a collection in the secret service.

###### secret_collection_new_for_dbus_path_sync

Get a new collection proxy for a collection in the secret service.

#### Functions

###### secret_collection_create

Create a new collection in the secret service.

###### secret_collection_create_finish

Finish operation to create a new collection in the secret service.

###### secret_collection_create_sync

Create a new collection in the secret service.

###### secret_collection_for_alias

Lookup which collection is assigned to this alias. Aliases help determine well known collections, such as ‘default’.

###### secret_collection_for_alias_finish

Finish an asynchronous operation to lookup which collection is assigned to an alias.

###### secret_collection_for_alias_sync

Lookup which collection is assigned to this alias. Aliases help determine well known collections, such as `default`.

###### secret_collection_new_for_dbus_path

Get a new collection proxy for a collection in the secret service.

#### Instance methods

###### secret_collection_delete

Delete this collection.

###### secret_collection_delete_finish

Complete operation to delete this collection.

###### secret_collection_delete_sync

Delete this collection.

###### secret_collection_get_created

Get the created date and time of the collection.

###### secret_collection_get_flags

Get the flags representing what features of the `SecretCollection` proxy have been initialized.

###### secret_collection_get_items

Get the list of items in this collection.

###### secret_collection_get_label

Get the label of this collection.

###### secret_collection_get_locked

Get whether the collection is locked or not.

###### secret_collection_get_modified

Get the modified date and time of the collection.

###### secret_collection_get_service

Get the Secret Service object that this collection was created with.

###### secret_collection_load_items

Ensure that the `SecretCollection` proxy has loaded all the items present in the Secret Service.

###### secret_collection_load_items_finish

Complete an asynchronous operation to ensure that the `SecretCollection` proxy has loaded all the items present in the Secret Service.

###### secret_collection_load_items_sync

Ensure that the `SecretCollection` proxy has loaded all the items present in the Secret Service. This affects the result of `secret_collection_get_items()`.

###### secret_collection_refresh

Refresh the properties on this collection. This fires off a request to refresh, and the properties will be updated later.

###### secret_collection_search

Search for items matching the `attributes` in the `collection`. The `attributes` should be a table of string keys and string values.

###### secret_collection_search_finish

Complete asynchronous operation to search for items in a collection.

###### secret_collection_search_for_dbus_paths

Search for items in `collection` matching the `attributes`, and return their DBus object paths.

###### secret_collection_search_for_dbus_paths_finish

Complete asynchronous operation to search for items in a collection.

###### secret_collection_search_for_dbus_paths_sync

Search for items matching the `attributes` in `collection`, and return their DBus object paths.

###### secret_collection_search_sync

Search for items matching the `attributes` in the `collection`. The `attributes` should be a table of string keys and string values.

###### secret_collection_set_label

Set the label of this collection.

###### secret_collection_set_label_finish

Complete asynchronous operation to set the label of this collection.

###### secret_collection_set_label_sync

Set the label of this collection.

##### Methods inherited from GDBusProxy (19)

###### g_dbus_proxy_call

Asynchronously invokes the `method_name` method on `proxy`.

unstable since: 2.26

###### g_dbus_proxy_call_finish

Finishes an operation started with g_dbus_proxy_call().

unstable since: 2.26

###### g_dbus_proxy_call_sync

Synchronously invokes the `method_name` method on `proxy`.

unstable since: 2.26

###### g_dbus_proxy_call_with_unix_fd_list

Like `g_dbus_proxy_call()` but also takes a `GUnixFDList` object.

unstable since: 2.30

###### g_dbus_proxy_call_with_unix_fd_list_finish

Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list().

unstable since: 2.30

###### g_dbus_proxy_call_with_unix_fd_list_sync

Like `g_dbus_proxy_call_sync()` but also takes and returns `GUnixFDList` objects.

unstable since: 2.30

###### g_dbus_proxy_get_cached_property

Looks up the value for a property from the cache. This call does no blocking IO.

unstable since: 2.26

###### g_dbus_proxy_get_cached_property_names

Gets the names of all cached properties on `proxy`.

unstable since: 2.26

###### g_dbus_proxy_get_connection

Gets the connection `proxy` is for.

unstable since: 2.26

###### g_dbus_proxy_get_default_timeout

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.

unstable since: 2.26

###### g_dbus_proxy_get_flags

Gets the flags that `proxy` was constructed with.

unstable since: 2.26

###### g_dbus_proxy_get_interface_info

Returns the `GDBusInterfaceInfo`, if any, specifying the interface that `proxy` conforms to. See the `GDBusProxy:g-interface-info` property for more details.

unstable since: 2.26

###### g_dbus_proxy_get_interface_name

Gets the D-Bus interface name `proxy` is for.

unstable since: 2.26

###### g_dbus_proxy_get_name

Gets the name that `proxy` was constructed for.

unstable since: 2.26

###### g_dbus_proxy_get_name_owner

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::notify` signal to track changes to the `GDBusProxy:g-name-owner` property.

unstable since: 2.26

###### g_dbus_proxy_get_object_path

Gets the object path `proxy` is for.

unstable since: 2.26

###### g_dbus_proxy_set_cached_property

If `value` is not `NULL`, sets the cached value for the property with name `property_name` to the value in `value`.

unstable since: 2.26

###### g_dbus_proxy_set_default_timeout

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.

unstable since: 2.26

###### g_dbus_proxy_set_interface_info

Ensure that interactions with `proxy` conform to the given interface. See the `GDBusProxy:g-interface-info` property for more details.

unstable since: 2.26

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GAsyncInitable (3)

###### g_async_initable_init_async

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 `GInitable` you can optionally call `g_initable_init()` instead.

unstable since: 2.22

###### g_async_initable_init_finish

Finishes asynchronous initialization and returns the result. See g_async_initable_init_async().

unstable since: 2.22

###### g_async_initable_new_finish

Finishes the async construction for the various g_async_initable_new calls, returning the created object or `NULL` on error.

unstable since: 2.22

##### Methods inherited from GDBusInterface (4)

###### g_dbus_interface_dup_object

Gets the `GDBusObject` that `interface_` belongs to, if any.

unstable since: 2.32

###### g_dbus_interface_get_info

Gets D-Bus introspection information for the D-Bus interface implemented by `interface_`.

unstable since: 2.30

###### g_dbus_interface_get_object

Gets the `GDBusObject` that `interface_` belongs to, if any.

unstable since: 2.30

###### g_dbus_interface_set_object

Sets the `GDBusObject` for `interface_` to `object`.

unstable since: 2.30

##### Methods inherited from GInitable (1)

###### g_initable_init

Initializes the object implementing the interface.

unstable since: 2.22

#### Properties

###### Secret.Collection:created

The date and time (in seconds since the UNIX epoch) that this collection was created.

###### Secret.Collection:flags

A set of flags describing which parts of the secret collection have been initialized.

###### Secret.Collection:items

A list of `SecretItem` objects representing the items that are in this collection. This list will be empty if the collection is locked.

###### Secret.Collection:label

The human readable label for the collection.

###### Secret.Collection:locked

Whether the collection is locked or not.

###### Secret.Collection:modified

The date and time (in seconds since the UNIX epoch) that this collection was last modified.

###### Secret.Collection:service

The `SecretService` object that this collection is associated with and uses to interact with the actual D-Bus Secret Service.

##### Properties inherited from GDBusProxy (9)

###### Gio.DBusProxy:g-bus-type

If this property is not `G_BUS_TYPE_NONE`, then `GDBusProxy:g-connection` must be `NULL` and will be set to the `GDBusConnection` obtained by calling `g_bus_get()` with the value of this property.

unstable since: 2.26

###### Gio.DBusProxy:g-connection

The `GDBusConnection` the proxy is for.

unstable since: 2.26

###### Gio.DBusProxy:g-default-timeout

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.

unstable since: 2.26

###### Gio.DBusProxy:g-flags

Flags from the `GDBusProxyFlags` enumeration.

unstable since: 2.26

###### Gio.DBusProxy:g-interface-info

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 `GDBusInterfaceInfo` is said to be the “expected interface”.

unstable since: 2.26

###### Gio.DBusProxy:g-interface-name

The D-Bus interface name the proxy is for.

unstable since: 2.26

###### Gio.DBusProxy:g-name

The well-known or unique name that the proxy is for.

unstable since: 2.26

###### Gio.DBusProxy:g-name-owner

The unique name that owns `GDBusProxy:g-name` or `NULL` if no-one currently owns that name. You may connect to `GObject::notify` signal to track changes to this property.

unstable since: 2.26

###### Gio.DBusProxy:g-object-path

The object path the proxy is for.

unstable since: 2.26

#### Signals

##### Signals inherited from GDBusProxy (2)

###### GDBusProxy::g-properties-changed

Emitted when one or more D-Bus properties on `proxy` changes. The local cache has already been updated when this signal fires. Note that both `changed_properties` and `invalidated_properties` are guaranteed to never be `NULL` (either may be empty though).

unstable since: 2.26

###### GDBusProxy::g-signal

Emitted when a signal from the remote object and interface that `proxy` is for, has been received.

unstable since: 2.26

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct SecretCollectionClass {
      GDBusProxyClass parent_class;

    }

The class for `SecretCollection`.

###### Class members

`parent_class: GDBusProxyClass`

  The parent class.