ObjectDataForIX

View as Markdown

Object data for indexing.

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

Fields

Field	Type	Number	Description
`primary_obj_id`	`ObjID`	1	The primary identity of the object. Also valid when the object has been destroyed.
`is_destroyed`	`bool`	2	True if the object has been destroyed and is no longer available. If true then only the objidPrimary and oim members are valid.
`is_skipped`	`bool`	3	True if the object has been skipped and cannot be indexed. If true then only the objidPrimary and oim members are valid.
`object_version`	`ObjectVersionExWP`	4	Contains the basic object version information, always latest checked-in version.
`version_comment`	`PropertyValue`	5	The version comment history of the object excluding checkedout version.
`updated_files`	repeated `FileID`	6	Identifies the files that have been updated.
`alias_obj_ids`	repeated `ObjID`	7	Additional ID aliases for the object such as the external object ID, if any, in some other system/repository/vault.
`index_metadata`	`ObjectIndexMetadata`	8	Metadata information for storing the object in the index.
`repository_path`	`FolderArray`	9	If not null contains the array of folders describing the repository path to the object version location.
`all_editors_history`	`PropertyValue`	10	Aggregated DISTINCT user IDs (VALUELIST_USERS) from PROPERTYDEF_LASTMODIFIEDBY and PROPERTYDEF_VERSION_EDITORS across every checked-in version, represented as MSLOOKUP from VALUELIST_USERS. Empty when the feature flag is off or for external-repository objects.
`acl_for_indexing`	`SimpleACL`	11	Pre-resolved read-permission projection of this object version's ACL: one entry per component (index 0 is the custom component, the rest are automatic components in stable order), each reduced to concrete allowed/denied actor IDs with additive components merged in, deleted components removed, and pseudo-users resolved. unset if not supplied by this server; set with zero entries if supplied and the ACL resolved to no components. On the checked-out version, the checked-out-to user has already been injected into every component's allowed array; the latest-checked-in version's projection never carries that injection.

Used by methods

IRPCIndexingDataSource.GetNextObjectsForIX -- Gets next objects and their data for indexing.
IRPCIndexingDataSource2.GetObjectForIXById -- Gets the index data of one object by its ID: the same data that GetNextObjectsForIX returns for the latest checked-in version and, if requested, the checked-out version.

Used in fields

GetNextObjectsForIXResponse.data -- The data of the object versions for indexing.
GetObjectForIXByIdResponse.latest_checked_in -- The index data of the latest checked-in version. Unset if the object has no checked-in version.
GetObjectForIXByIdResponse.checked_out -- The index data of the checked-out version. Unset unless include_checked_out is true and the object is checked out.