GetInteractAsync Method
Overloads
| GetInteractAsync(AsyncHandle) |
Engine can request user interactions only during script reload and when the reload is performed in debug mode (Debug 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:
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 UserInteractionWanted is set to true in the response of the GetProgress request. |
|
| GetInteractAsync(Int32) |
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 ( 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 |
|
| GetInteractAsync(AsyncHandle, Int32) |
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 ( 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 |
|
| GetInteractAsync<T>(AsyncHandle, Func<Response, T>, Int32) |
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 ( 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 |
GetInteractAsync(AsyncHandle)
Engine can request user interactions only during script reload and when the reload is performed in debug mode (Debug 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 UserInteractionWanted is set to true in the response of the GetProgress request.
Declaration
Task<GetInteractResult> GetInteractAsync(AsyncHandle asyncHandle)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Corresponds to the identifier for the call. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GetInteractResult> |
GetInteractAsync(Int32)
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.
Declaration
Task<GetInteractResult> GetInteractAsync([QixName("qRequestId")] int requestId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | requestId |
Identifier of the request.
Corresponds to the identifier of the |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GetInteractResult> |
GetInteractAsync(AsyncHandle, Int32)
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.
Declaration
Task<GetInteractResult> GetInteractAsync(AsyncHandle asyncHandle, [QixName("qRequestId")] int requestId)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Int32 | requestId |
Identifier of the request.
Corresponds to the identifier of the |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GetInteractResult> |
GetInteractAsync<T>(AsyncHandle, Func<Response, T>, Int32)
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.
Declaration
Task<T> GetInteractAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qRequestId")] int requestId)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.Int32 | requestId |
Identifier of the request.
Corresponds to the identifier of the |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
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!