ValueListItem

An item of a value list, or an object seen as an item of its object type (for example in lookup results).

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

Fields

Field	Type	Number	Description
`item_info`	`ItemInfo`	1	The item's identity and name: `obj_id.type` is the value list ID, `obj_id.item_id.internal_id` the item ID (unique within the list only), plus `name`, `guid`, `external_id` and flags. `options.is_deleted` marks a deleted item.
`has_parent`	`bool`	2	True if the item has a parent item in the same (hierarchical) list.
`has_owner`	`bool`	3	True if the item belongs to an item of the owner list (`ValueList.owner_object_type`).
`parent_id`	`int32`	4	With `has_parent`, the item ID of the parent item; otherwise ignored.
`owner_id`	`int32`	5	With `has_owner`, the item ID of the owner item in the owner list.
`owner_name`	`string`	6	The name of the owner item.
`automatic_permissions`	`AutomaticPermissions`	7	If set, specifies the automatic permissions for an object for which the user selects this item.
`icon`	`Bytes`	8	If set, contains the icon of this item in .ICO format.

Used by methods

IRPCDataExport.GetExportedValueListItems -- Gets the items of a value list in batches ordered by item ID.
IRPCDataExport.GetExportedValueListItemsByID -- Gets the given items of a value list.
IRPCIndexingDataSource2.GetValueListItemsForIX -- Gets the items of one value list for a search index: all items page by page, or the changes since a known version.
IRPCObjectTypesAdmin.AddObjectTypeItem -- Adds an item to a value list as an administrator.
IRPCObjectTypesAdmin.UpdateObjectTypeItem -- Updates an item of a value list (for example its name, parent or owner) as an administrator.
IRPCSearch.SearchReferencedValueListItems -- Gets value list items that are referenced by one or more documents (possibly limiting the set of documents with conditions) in ID order.
IRPCValueLists.AddValueListItemFromClient -- Adds a new item to a value list, as a user.
IRPCValueLists.CreateOrFindTraditionalFolder -- Creates a traditional folder, or returns an existing folder with the same name.
IRPCValueLists.GetValueListItemProposals -- Gets the values that the calling user has most recently used for a lookup property.
IRPCValueLists.GetValueListItemsWithPermissions -- Gets the items of one value list or object type, or only the changes since a known version.
IRPCValueLists.RenameValueListItemFromClient -- Renames a traditional folder.
IRPCValueLists.SearchValueListItemsWithPermissions -- Searches the items of one value list or object type by item ID, name, owner, parent or deleted state.
IRPCValueLists.UpdateValueListItemFromClient -- Updates an item of a plain value list or a traditional folder, as a user.
IRPCViews.CreateSubFolder -- Creates a traditional folder at a location inside a view, or returns an existing folder with the same name there.

Used by messages

DocClass -- Struct for a document class in a vault.
ObjectClass -- A class: a kind of object within one object type, with the properties its objects have.
ValueListItemData -- A value list item with, on request, its permissions.
ValueListItemDecl -- Value list item structure.