summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMaximiliano Sandoval R <msandova@gnome.org>2022-02-05 20:28:34 +0100
committerMaximiliano Sandoval R <msandova@gnome.org>2022-02-07 13:02:09 +0100
commit868a88ffe851df3eaf65f10b39d50e58d3bd9f36 (patch)
tree85996a05208634ac3033d2fa72099edbda62e4d3 /docs
parente762e39dfcccbbad39b4cbd0cae1cd919757301b (diff)
downloadlibsecret-868a88ffe851df3eaf65f10b39d50e58d3bd9f36.tar.gz
secret-schema: Add missind docs
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/libsecret/libsecret-simple-api.md55
1 files changed, 0 insertions, 55 deletions
diff --git a/docs/reference/libsecret/libsecret-simple-api.md b/docs/reference/libsecret/libsecret-simple-api.md
index b6fda5e..11cf8fe 100644
--- a/docs/reference/libsecret/libsecret-simple-api.md
+++ b/docs/reference/libsecret/libsecret-simple-api.md
@@ -20,61 +20,6 @@ the [struct@Schema] structure.
Each of the functions accept a variable list of attributes names and their
values. Include a `NULL` to terminate the list of attributes.
-## SecretSchema
-
-Represents a set of attributes that are stored with an item. These schemas are
-used for interoperability between various services storing the same types of
-items.
-
-Each schema has a name like `org.gnome.keyring.NetworkPassword`, and defines a
-set of attributes, and types (string, integer, boolean) for those attributes.
-
-Attributes are stored as strings in the Secret Service, and the attribute types
-simply define standard ways to store integer and boolean values as strings.
-Attributes are represented in libsecret via a [struct@GLib.HashTable] with
-string keys and values. Even for values that defined as an integer or boolean in
-the schema, the attribute values in the [struct@GLib.HashTable] are strings.
-Boolean values are stored as the strings 'true' and 'false'. Integer values are
-stored in decimal, with a preceding negative sign for negative integers.
-
-Schemas are handled entirely on the client side by this library. The name of the
-schema is automatically stored as an attribute on the item.
-
-Normally when looking up passwords only those with matching schema names are
-returned. If the schema @flags contain the `SECRET_SCHEMA_DONT_MATCH_NAME` flag,
-then lookups will not check that the schema name matches that on the item, only
-the schema's attributes are matched. This is useful when you are looking up
-items that are not stored by the libsecret library. Other libraries such as
-libgnome-keyring don't store the schema name.
-
-Additional schemas can be defined via the %SecretSchema structure like this:
-
-```c
-// in a header:
-
-const SecretSchema * example_get_schema (void) G_GNUC_CONST;
-
-#define EXAMPLE_SCHEMA example_get_schema ()
-
-
-// in a .c file
-
-const SecretSchema *
-example_get_schema (void)
-{
- static const SecretSchema the_schema = {
- "org.example.Password", SECRET_SCHEMA_NONE,
- {
- { "number", SECRET_SCHEMA_ATTRIBUTE_INTEGER },
- { "string", SECRET_SCHEMA_ATTRIBUTE_STRING },
- { "even", SECRET_SCHEMA_ATTRIBUTE_BOOLEAN },
- { NULL, 0 },
- }
- };
- return &the_schema;
-}
-```
-
## Secret Attributes
Each item has a set of attributes, which are used to locate the item later.