Skip to main content

onListConstantFolders

Last updated 23/07/2026

Definition​

onListConstantFolders
is a host callback invoked by
DimensionIQWidget
 when the widget requires the complete list of constant folders and the host application must retrieve them from persistent storage.

Once processing is complete, please refer to the

onResponse
contract in the Widget Callback Introduction.

This callback ensures the widget and the host application remain synchronized by providing the current collection of constant folders available to the widget.

Function Signature​

TypeScript
Function Signature
onListConstantFolders: (
    onResponse: (
        result: DIQ_Result,
        folders: Array<DIQ_ConstantFolder> | null
    ) => void
) => void;

Callback Parameters​

onResponse
Type: (result: DIQ_Result, folders: Array<DIQ_ConstantFolder> | null) => void
Description: Callback function that must be called by the host to complete the operation, and return an array of

DIQ_ConstantFolder
objects.

Examples​

onListConstantFolders