register_metadata_key


Description:

[ Version ( since = "0.3.0" ) ]
public KeyID register_metadata_key (owned ParamSpec param_spec, KeyID bind_key) throws Error

Registers a new metadata key, creating a relation between the new key and bind_key.

Two keys are related when the values of both keys are somehow related.

One example of a relation would be the one between the URI of a media resource and its mime-type: they are both tied together and one does not make sense without the other.

Relations between keys allow the framework to provide all the data that is somehow related when any of the related keys are requested.

Parameters:

this

The plugin registry

param_spec

The definition of the key to register

bind_key

The key the new key is bind to, or INVALID if it is not bound.

Returns:

The KeyID registered.