SetPropertiesParams
Struct for a parameter set for SetPropertiesMultiple.
One object's changes in SetPropertiesMultiple. The fields mean the same as the fields of SetPropertiesRequest.
| Full name | MFiles.SetPropertiesParams |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
obj_ver | ObjVer | 1 | The version to change, by number: the checked-out version if the caller has the object checked out, otherwise the latest checked-in version. The LATEST marker is not accepted. |
allow_modifying_checked_in_object | bool | 2 | True to change a checked-in object: the server checks it out, applies the change and checks it in as one new version. |
fail_if_not_latest_checked_in_version | bool | 3 | With allow_modifying_checked_in_object, true to fail if obj_ver is not the latest checked-in version. |
object_version_guid | string | 4 | Optional version_guid of the version in obj_ver, checked together with fail_if_not_latest_checked_in_version. Leave empty normally. |
set_properties | repeated PropertyValue | 5 | Property values to add or replace. Other properties stay unchanged. |
is_full_set | bool | 6 | True to treat set_properties as the full set and remove every other property the class does not list. set_properties must then include Class (100). Leave false. |
remove_properties | repeated int32 | 7 | Property definition IDs to remove. Properties listed by the class cannot be removed; set them empty instead. |
options | OBJECTOPFLAGS | 8 | Flags that control this operation. |
acl_enforcing_mode | ACLEnforcingMode | 9 | Which ACL the server starts from when it updates the permissions; see SetProperties acl_mode. ACLENFORCING_MODE_DISALLOW_CHANGES is rejected.Values: ACLENFORCING_MODE_USE_PREVIOUS (0), ACLENFORCING_MODE_USE_PROVIDED (1), ACLENFORCING_MODE_RESET_TO_DEFAULT (2), ACLENFORCING_MODE_DISALLOW_CHANGES (3). |
acl | AccessControlList | 10 | The permissions to use with ACLENFORCING_MODE_USE_PROVIDED. Unset otherwise. |
Used by methods
- IRPCObjectOperations.PromoteUnmanagedObject -- Promotes objects of an external repository (unmanaged objects) to managed M-Files objects by giving them metadata.
- IRPCObjectOperations.SetPropertiesMultiple -- If the object is currently checked in, a new checked-in version is created. If the object is currently checked out, the changes are applied to the checked-out version.
Used in fields
SetPropertiesMultipleRequest.properties-- One set of changes per object; see SetPropertiesParams. Each object at most once.PromoteUnmanagedObjectRequest.properties-- Parameters (one set of parameters per object).