GetInteract method

Overview

Retrieves information on the user interaction that is requested by the engine.

Engine can request user interactions only during script reload and when the reload is performed in debug mode (qDebug is set to true when using the DoReload method).

When running reload in debug mode, the engine pauses the script execution to receive data about user interaction. The engine can pause:

- before executing a new script statement

- when an error occurs while executing the script

- when the script execution is finished.

To know if the engine is paused and waits for a response to an interaction request, the GetProgress method should be used. The engine waits for a response if the property qUserInteractionWanted is set to true in the response of the GetProgress request.

Parameters

Name	Description	Type
qRequestId	Identifier of the request. Corresponds to the identifier of the DoReload request.	Integer

Name

Description

Type

qRequestId

Identifier of the request.

Corresponds to the identifier of the DoReload request.

Integer

Outputs

The following is returned in the output:

Name	Description	Type
qDef	Information to set up the user interaction. Indicates which kind of interaction is wanted.	InteractDef

Name

Description

Type

qDef

Information to set up the user interaction.

Indicates which kind of interaction is wanted.

InteractDef

Name	Description	Type
qType	Interaction type.	One of: IT_SCRIPTLINE; the engine returns the statement that will be executed next. IT_MSGBOX; the engine returns a script execution error message. This type can only be returned if the parameter qInteractOnError was set to true when calling the ConfigureReload method. IT_BREAK; the engine breaks and waits for a response on what to do next. IT_END; the engine has finished to execute all statements in the script.
qTitle	Title used in the message box dialog. This property is relevant if qType is IT_MSGBOX.	String
qMsg	Message used in the message box dialog. This property is relevant if qType is IT_MSGBOX.	String
qButtons	Buttons displayed in the message box dialog. This property is relevant if qType is IT_MSGBOX. One of: 0 means that the qButtons property is not relevant. 17 means that the message box contains the OK and Cancel buttons or the stop-sign icon.	Integer
qLine	Next script statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.	String
qOldLineNr	First line number of the previously executed statement. This property is used if the type of interaction is IT_SCRIPTLINE.	Integer
qNewLineNr	First line number of the next statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.	Integer
qPath	Path specified by the Include script variable. This property is used if the type of interaction is IT_SCRIPTLINE. Example of an Include variable: $(Include=lib:\\MyDataFiles\abc.txt);	String
qHidden	This property is set to true if the returned statement is an hidden script statement.	Boolean
qResult	Not relevant for describing the requested user interaction.	Integer
qInput	Is not used in Qlik Sense.	String

Learn more

InteractDone method

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here