Skip to main content

onListVariableFolders

Last updated 23/07/2026

Definition​

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

The host application is responsible for retrieving all stored

DIQ_VariableFolder
records for the requested project.

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 variable folders for the requested project.

Function Signature​

TypeScript
Function Signature
onListVariableFolders: (
    projectKey: string,
    onResponse: (
        result: DIQ_Result,
        folders: Array<DIQ_VariableFolder> | null
    ) => void
) => void;

Callback Parameters​

projectKey
Type: string
Description: The unique key identifying the project whose variable folders should be retrieved.

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

DIQ_VariableFolder
objects. If no variable folders exist, return an empty array.

Examples​

onListVariableFolders