Skip to main content

onRevisionGet

Last updated 8/05/2026

Definition

is a host callback invoked by
DimensionIQWidget
when the widget needs to retrieve a specific revision. The host application is responsible for locating the revision using the provided key and returning it to the widget.

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 regarding the retrieval and availability of revision data.

Function Signature

TypeScript
Function Signature
onRevisionGet: (
revisionKey: string,
onResponse: (result: DIQ_Result, revision: DIQ_Revision | null) => void
) => void;

Callback Parameters

revisionKey
Type: string
Description: A unique identifier for the revision that the widget is requesting. The host should use this key to locate the corresponding revision in its data store.

onResponse
Type: (result: DIQ_Result, revision: DIQ_Revision | null) => void
Description: Callback function that must be called by the host to complete the operation.

Examples

onRevisionGet