GetValueListItemsWithPermissions

Gets items contained in a given value list, the permissions of the items are included.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results =
  await shellUI.Vault.ValueListsOperations.GetValueListItemsWithPermissions({
    call_importance: 2 /* Enum: CallImportance */,
    external_data_source_refresh: 2 /* Enum: ExtDBRefreshType */,
    value_list: 0,
    filtering_property_def: 0,
    known_version: 0,
    allow_delta: false,
    resolve_current_user_placeholders: false,
    include_permissions: false,
  });

Message

Name	Description	Type
call_importance	The importance level of this call. Typically eciNormal.	CallImportance
external_data_source_refresh	The type of refresh that is requested in case the value list or object type is external.	ExtDBRefreshType
value_list	The ID of the value list.	number
filtering_property_def	If not -1, specifies the property definition the filter of which should be applied to the list.	number
known_version	The version ID of this value list's data currently known by the caller. If the contents of the value list have not been updated since, *pi64CurrentVersionOnServer is set to this same number and no data is returned. Specify zero to force the retrieval of all (first N) values. When this is zero, the server never returns an appropriate delta (changes to the list).	number
allow_delta	True if the client allows receiving a delta (changes to the list).	boolean
resolve_current_user_placeholders	Set to true to replace (current user) in ACLForObjects with identity of the caller.	boolean
include_permissions	Set to true to include value list permissions.	boolean

Return type

Name	Description	Type
current_version	Receives the current version of the value list's data on the server. If this is the same as the one specified by the caller, no data is returned.	number
is_delta	Set to true if the server returned an appropriate delta to the list (i.e. just the occurred changes to the list).	boolean
removed_items	Receives the removed items. This contains data only when a delta is returned. Otherwise it must be an empty array.	number[]
items	Receives the items as JSON array (represented by MF_ValueListItem struct). In case of a delta, this specifies the items that were inserted or updated since the client previously contacted the server.	ValueListItem[]
item_acls	The ACLs of the latest versions as JSON (represented by MF_ACLArray struct).	AccessControlList[]
item_current_user_permissions	The permissions of items for current user as JSON array (represented by MF_ObjectPermissionsForClient struct).	ObjectPermissionsForClient[]
has_more_results	Receives true if the results were limited.	boolean

Example

{
  "current_version": 0,
  "is_delta": false,
  "removed_items": [] /* Array of number */,
  "items": [] /* Array of ValueListItem */,
  "item_acls": [] /* Array of AccessControlList */,
  "item_current_user_permissions": [] /* Array of ObjectPermissionsForClient */,
  "has_more_results": false
}