Declarative metadata structure (protobuf) (IRPCDeclarativeMetadataStructureAsProtobuf)

View as Markdown

Reads and replaces the whole metadata structure of a vault as one typed message. Preview feature, off by default; for the declarative configuration converter.

Overview

For M-Files components only. It is meant for the declarative configuration converter that is installed with M-Files Server, which reads and deploys the vault's structure through it. Applications should not call it.

• Not available by default. On a server where the declarative metadata structure feature is not enabled, every method fails with "Not implemented." (gRPC status UNKNOWN, error code 0x80004001) before any rights check. SetDeclarativeMetadataStructureBeginSessionAsProtobuf and SetDeclarativeMetadataStructureEndSessionAsProtobuf are not implemented even when it is on.
• Relation to the JSON service. This service exchanges the structure as a DeclarativeMetadataStructure message that uses the vault's IDs. IRPCDeclarativeMetadataStructure exchanges the same structure as a declarative JSON document in which elements refer to each other by name; the server converts between the two forms. See that service for the format.
• Session and rights. Every method requires a vault session and the vault right change_metadata_structure, reads included.
• Every method sends the mfiles-metadata-version-bin trailer when it succeeds.

Methods