ExpressionUnion

Union of expressions of different type.

Set exactly one member, the one that matches Expression.type.

Full name	`MFiles.ExpressionUnion`
Proto file	`mfiles/structs.proto`
Nested types	`ExpressionUnion.UninitializedData`, `ExpressionUnion.PropertyValueData`, `ExpressionUnion.IdSegmentData`, `ExpressionUnion.StatusValueData`, `ExpressionUnion.FileValueData`, `ExpressionUnion.TypedValueData`, `ExpressionUnion.AnyFieldData`, `ExpressionUnion.PermissionsData`

Fields

Field	Type	Number	Description
`property_value`	`ExpressionUnion.PropertyValueData` (oneof data)	1	Expression for property values.
`id_segment`	`ExpressionUnion.IdSegmentData` (oneof data)	2	Expression for document ID segments.
`status_value`	`ExpressionUnion.StatusValueData` (oneof data)	3	Expression for status values such as Document ID or CheckedOutToUser.
`file_value`	`ExpressionUnion.FileValueData` (oneof data)	4	Expression for file values such as file size.
`typed_value`	`ExpressionUnion.TypedValueData` (oneof data)	5	Expression for values of specific data type. Lookup-typed values also specify the value list.
`any_field`	`ExpressionUnion.AnyFieldData` (oneof data)	6	Expression for values of any field (any property, file name etc.).
`permissions`	`ExpressionUnion.PermissionsData` (oneof data)	7	Expression for permissions (ACL).

Used in fields

Expression.data -- The expression data. Set the member that matches type.

Nested message UninitializedData

Uninitialized expression, used as default value. This value is never used in actual expressions and serves only as a placeholder for uninitialized expressions.

Full name: MFiles.ExpressionUnion.UninitializedData

No fields.

Nested message PropertyValueData

Expression for property values.

Full name: MFiles.ExpressionUnion.PropertyValueData

Field	Type	Number	Description
`property_def`	`int32`	1	The ID of the property definition whose value is compared, for example 0 (Name or title), 21 (Last modified) or 100 (Class).
`data_function`	`DataFunctionCall`	2	Optional function applied to the value before the comparison, for example `DATA_FUNCTION_DAYS_FROM` to compare the age of a date in days. Unset compares the value as is.
`parent_child_behavior`	`ParentChildBehavior`	3	For hierarchical value lists: whether a match on a parent or child item also counts. Unset requires an exact match.Values: `PARENT_CHILD_BEHAVIOR_NONE` (0), `PARENT_CHILD_BEHAVIOR_INCLUDE_CHILD_VALUES` (1), `PARENT_CHILD_BEHAVIOR_INCLUDE_PARENT_VALUES` (2).

Nested message IdSegmentData

Expression for document ID segments.

Full name: MFiles.ExpressionUnion.IdSegmentData

Field	Type	Number	Description
`segment_size`	`int32`	1	The size of the document ID range of one segment. Typically 1000.

Nested message StatusValueData

Expression for status values such as Document ID or CheckedOutToUser.

Value types that work with CONDITION_TYPE_EQUAL:

STATUS_TYPE_IS_DELETED, STATUS_TYPE_CHECKED_OUT: Boolean.
STATUS_TYPE_OBJECT_TYPE: a lookup (value list -11, item = object type ID), or a multi-select lookup to match any of several object types.
STATUS_TYPE_OBJECT_ID: integer. CONDITION_TYPE_GREATER_THAN also works, for paging by object ID.

Full name: MFiles.ExpressionUnion.StatusValueData

Field	Type	Number	Description
`type`	`StatusType`	1	The type of status information (e.g. check out user).
`data_function`	`DataFunctionCall`	2	Function that modifies the status value.

Nested message FileValueData

Expression for file values such as file size.

Full name: MFiles.ExpressionUnion.FileValueData

Field	Type	Number	Description
`type`	`FileValueType`	1	The type of file information (e.g. file name).Values: `FILE_VALUE_TYPE_HAS_FILES` (0), `FILE_VALUE_TYPE_FILE_NAME` (1), `FILE_VALUE_TYPE_FILE_SIZE` (2), `FILE_VALUE_TYPE_FILE_ID` (3), `FILE_VALUE_TYPE_CREATION_TIME` (4), `FILE_VALUE_TYPE_CHANGE_TIME` (5), `FILE_VALUE_TYPE_LINKED_TO_EXTERNAL_LOCATION` (6), `FILE_VALUE_TYPE_LINKED_EXTERNAL_LOCATION_ID` (7), `FILE_VALUE_TYPE_HAS_DUPLICATES` (8).

Nested message TypedValueData

Expression for values of specific data type. Lookup-typed values also specify the value list.

Matches a value in any property of the given data type. With DATATYPE_MULTI_SELECT_LOOKUP (or DATATYPE_LOOKUP) and value_list, the condition finds objects that refer to the given item in any property, single- or multi-select.

Full name: MFiles.ExpressionUnion.TypedValueData

Field	Type	Number	Description
`datatype`	`Datatype`	1	The data type of the values to match.
`value_list`	`int32`	2	With `DATATYPE_LOOKUP` or `DATATYPE_MULTI_SELECT_LOOKUP`, the value list or object type whose item the objects refer to. Both data types find objects that refer to the item through a lookup or a multi-select lookup property.
`data_function`	`DataFunctionCall`	3	Function that modifies the typed value.
`parent_child_behavior`	`ParentChildBehavior`	4	Parent-child behaviour, used within hierarchic value lists.Values: `PARENT_CHILD_BEHAVIOR_NONE` (0), `PARENT_CHILD_BEHAVIOR_INCLUDE_CHILD_VALUES` (1), `PARENT_CHILD_BEHAVIOR_INCLUDE_PARENT_VALUES` (2).

Nested message AnyFieldData

Expression for values of any field (any property, file name etc.).

A full-text search. Use it with CONDITION_TYPE_CONTAINS and a non-empty text value.

Full name: MFiles.ExpressionUnion.AnyFieldData

Field	Type	Number	Description
`options`	`FTSFLAGS`	1	Full-text search flags. Set `search_metadata`, `search_filedata` or both; with neither, the search fails with "Invalid search condition." See FTSFLAGS.

Nested message PermissionsData

Expression for permissions (ACL).

Full name: MFiles.ExpressionUnion.PermissionsData

Field	Type	Number	Description
`type`	`PermissionsExpressionType`	1	A more detailed type specification of the permissions expression.Values: `PERMISSIONS_EXPRESSION_TYPE_ACL` (0), `PERMISSIONS_EXPRESSION_TYPE_VISIBLE_TO` (1), `PERMISSIONS_EXPRESSION_TYPE_EDITABLE_BY` (2), `PERMISSIONS_EXPRESSION_TYPE_PERMISSIONS_CHANGEABLE_BY` (3), `PERMISSIONS_EXPRESSION_TYPE_FULL_CONTROL_BY` (4), `PERMISSIONS_EXPRESSION_TYPE_DELETABLE_BY` (5), `PERMISSIONS_EXPRESSION_TYPE_OBJECTS_ATTACHABLE_TO_THIS_ITEM_BY` (6).