Class groups (IRPCDocClassGroupsAdmin)

View as Markdown

Administers class groups: reads, adds, modifies and removes the groups that organize document classes.

Use this interface to add, modify and delete document class groups in a vault.

Overview

A class group bundles document classes. Class groups are items of the built-in value list 2. M-Files Admin calls this service; applications read class groups with GetObjectClassesAndGroups, which needs no special rights and also returns the classes with the caller's permissions.

• Session and rights. Every method requires a vault session. GetDocClassGroups needs the vault right read_all_metadata_structure (a normal user gets "Access denied."). The write methods need change_metadata_structure and license_allows_modifications.
• Calls: GetDocClassGroups, AddDocClassGroup, ModifyDocClassGroup, RemoveDocClassGroup. The classes themselves are in IRPCPropertyDefsAdmin; value list 2 cannot be edited with the item methods of IRPCObjectTypesAdmin.
• Metadata structure version. Every successful add, modify and remove increments the vault's metadata version when it commits. The methods do not send the mfiles-metadata-version-bin trailer; see Metadata structure version and caching.

Methods