DocClass

View as Markdown

Struct for a document class in a vault.

Full name	`MFiles.DocClass`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`value_list_item`	`ValueListItem`	1	Value list item representing this document class.
`workflow`	`int32`	2	The default workflow of the document class, or zero if there is no default workflow.
`object_type`	`int32`	3	The object type with which this class is used.
`is_predefined`	`bool`	4	True if this is a predefined class (cannot be deleted, editing is restricted).
`force_workflow`	`bool`	5	True if the use of the workflow with this class is enforced.
`name_property_def`	`int32`	6	The ID of the property definition that represents the name of the document or other object. Typically PROPERTYDEF_TITLE (0).
`object_type_specific_properties`	`ObjectTypeSpecificClassContentUnion`	7	Additional object type specific class content.
`signature_settings_for_new_objects`	`ElectronicSignatureSettings`	8	The electronic signature settings for creating an electronic signature for new objects. Reserved for future improvements.
`aliases`	`string`	9	Semicolon-separated list of semantic aliases.

Used by methods

IRPCPropertyDefsAdmin.AddObjectClass -- Creates a class with its property associations.
IRPCPropertyDefsAdmin.GetObjectClasses -- Gets the administrative definitions of all classes.
IRPCPropertyDefsAdmin.ModifyObjectClass -- Saves a changed class and, optionally, its property associations.

Used in fields

GetObjectClassesResponse.values -- One DocClass per class. The class ID is value_list_item.item_info.obj_id.item_id.internal_id.
AddObjectClassRequest.doc_class -- The new class. The item ID and GUID in value_list_item are ignored and assigned by the server; object_type sets the object type of the class.
ModifyObjectClassRequest.doc_class -- The complete new class; value_list_item.item_info.obj_id.item_id.internal_id identifies it.