IHub Interface

Namespace: Qlik.Engine
Assembly: Qlik.Engine.dll

Syntax

public interface IHub : IQixClassBase, IDisposable, IChangeNotifier

Properties

Name	Description
Session	The Qlik Sense engine session connection.

Methods

Name	Description
AbortAll()	Sets an abort flag on all pending and ongoing requests in the current engine session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
AbortAllAsync()	Sets an abort flag on all pending and ongoing requests in the current engine session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
AbortAllAsync(AsyncHandle)	Sets an abort flag on all pending and ongoing requests in the current engine session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
AbortRequest(Int32)	Sets an abort flag on a specific request in the current engine session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
AbortRequestAsync(AsyncHandle, Int32)	Sets an abort flag on a specific request in the current engine session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
AbortRequestAsync(Int32)	Sets an abort flag on a specific request in the current engine session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
AllowCreateApp()	Indicates whether or not a user is able to create an app.
AllowCreateAppAsync()	Indicates whether or not a user is able to create an app.
AllowCreateAppAsync(AsyncHandle)	Indicates whether or not a user is able to create an app.
AllowCreateAppAsync<T>(AsyncHandle, Func<Response, T>)	Indicates whether or not a user is able to create an app.
CancelReload()	Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and `true` is still the return value of the reload task.
CancelReloadAsync()	Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and `true` is still the return value of the reload task.
CancelReloadAsync(AsyncHandle)	Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and `true` is still the return value of the reload task.
CancelRequest(AsyncHandle)	Cancels an ongoing request. The request is stopped.
CancelRequest(Int32)	Cancels an ongoing request. The request is stopped.
CancelRequestAsync(AsyncHandle)	Cancels an ongoing request. The request is stopped.
CancelRequestAsync(AsyncHandle, Int32)	Cancels an ongoing request. The request is stopped.
CancelRequestAsync(Int32)	Cancels an ongoing request. The request is stopped.
ConfigureReload(Boolean, Boolean, Boolean)	Configures the engine's behavior during a reload.
ConfigureReloadAsync(AsyncHandle, Boolean, Boolean, Boolean)	Configures the engine's behavior during a reload.
ConfigureReloadAsync(Boolean, Boolean, Boolean)	Configures the engine's behavior during a reload.
CopyApp(String, String, IEnumerable<String>)	Copies an app that is in the Qlik Sense repository. The engine copies the app into an app entity that was previously created by the repository.
CopyAppAsync(AsyncHandle, String, String, IEnumerable<String>)	Copies an app that is in the Qlik Sense repository. The engine copies the app into an app entity that was previously created by the repository.
CopyAppAsync(String, String, IEnumerable<String>)	Copies an app that is in the Qlik Sense repository. The engine copies the app into an app entity that was previously created by the repository.
CopyAppAsync<T>(AsyncHandle, Func<Response, T>, String, String, IEnumerable<String>)	Copies an app that is in the Qlik Sense repository. The engine copies the app into an app entity that was previously created by the repository.
CreateApp(String, String, String)	Creates an app. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
CreateAppAsync(AsyncHandle, String, String, String)	Creates an app. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
CreateAppAsync(String, String, String)	Creates an app. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
CreateAppAsync<T>(AsyncHandle, Func<Response, T>, String, String, String)	Creates an app. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
CreateAppEx(String, String, String, String, String)	Creates an app and opens an engine session.
CreateAppExAsync(AsyncHandle, String, String, String, String, String)	Creates an app and opens an engine session.
CreateAppExAsync(String, String, String, String, String)	Creates an app and opens an engine session.
CreateAppExAsync<T>(AsyncHandle, Func<Response, T>, String, String, String, String, String)	Creates an app and opens an engine session.
CreateSessionApp()	Creates an empty session app. The following applies: * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
CreateSessionAppAsync()	Creates an empty session app. The following applies: * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
CreateSessionAppAsync(AsyncHandle)	Creates an empty session app. The following applies: * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
CreateSessionAppAsync<T>(AsyncHandle, Func<Response, T>)	Creates an empty session app. The following applies: * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
CreateSessionAppFromApp(String)	Creates a session app from a source app. The following applies: * The objects in the source app are copied into the session app but contain no data. * The script of the session app can be edited and reloaded. * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
CreateSessionAppFromAppAsync(AsyncHandle, String)	Creates a session app from a source app. The following applies: * The objects in the source app are copied into the session app but contain no data. * The script of the session app can be edited and reloaded. * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
CreateSessionAppFromAppAsync(String)	Creates a session app from a source app. The following applies: * The objects in the source app are copied into the session app but contain no data. * The script of the session app can be edited and reloaded. * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
CreateSessionAppFromAppAsync<T>(AsyncHandle, Func<Response, T>, String)	Creates a session app from a source app. The following applies: * The objects in the source app are copied into the session app but contain no data. * The script of the session app can be edited and reloaded. * The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app. * A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
DestroyApp(String)	Deletes an app from the Qlik Sense repository or from the file system. Qlik Sense Enterprise In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Apps The default installation directory is `ProgramData`. Qlik Sense Desktop The app is deleted from the directory `%userprofile%\Documents\Qlik\ \Apps`. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
DestroyAppAsync(AsyncHandle, String)	Deletes an app from the Qlik Sense repository or from the file system. Qlik Sense Enterprise In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Apps The default installation directory is `ProgramData`. Qlik Sense Desktop The app is deleted from the directory `%userprofile%\Documents\Qlik\ \Apps`. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
DestroyAppAsync(String)	Deletes an app from the Qlik Sense repository or from the file system. Qlik Sense Enterprise In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Apps The default installation directory is `ProgramData`. Qlik Sense Desktop The app is deleted from the directory `%userprofile%\Documents\Qlik\ \Apps`. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
DestroyAppAsync<T>(AsyncHandle, Func<Response, T>, String)	Deletes an app from the Qlik Sense repository or from the file system. Qlik Sense Enterprise In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Apps The default installation directory is `ProgramData`. Qlik Sense Desktop The app is deleted from the directory `%userprofile%\Documents\Qlik\ \Apps`. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. Where to find the log files The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop. Please refer to Engine API reference for table definition.
EngineVersion()	Returns the version number of the Qlik engine component.
EngineVersionAsync()	Returns the version number of the Qlik engine component.
EngineVersionAsync(AsyncHandle)	Returns the version number of the Qlik engine component.
EngineVersionAsync<T>(AsyncHandle, Func<Response, T>)	Returns the version number of the Qlik engine component.
ExportApp(String, String, IEnumerable<String>, Boolean)	Exports an app from the Qlik Sense repository to the file system. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. The log files are located in: `%ProgramData%/Qlik/Sense/Log/Engine`
ExportAppAsync(AsyncHandle, String, String, IEnumerable<String>, Boolean)	Exports an app from the Qlik Sense repository to the file system. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. The log files are located in: `%ProgramData%/Qlik/Sense/Log/Engine`
ExportAppAsync(String, String, IEnumerable<String>, Boolean)	Exports an app from the Qlik Sense repository to the file system. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. The log files are located in: `%ProgramData%/Qlik/Sense/Log/Engine`
ExportAppAsync<T>(AsyncHandle, Func<Response, T>, String, String, IEnumerable<String>, Boolean)	Exports an app from the Qlik Sense repository to the file system. Logs When this method is called, audit activity logs are produced to track the user activity. In the case of errors, both audit activity logs and system services logs are produced. The log files are named as follows: Please refer to Engine API reference for table definition. The log files are located in: `%ProgramData%/Qlik/Sense/Log/Engine`
GetActiveDoc()	Returns the handle of the current app.
GetActiveDocAsync()	Returns the handle of the current app.
GetActiveDocAsync(AsyncHandle)	Returns the handle of the current app.
GetActiveDocAsync<T>(AsyncHandle, Func<Response, T>)	Returns the handle of the current app.
GetAppEntry(String)	Retrieves the meta data of an app.
GetAppEntryAsync(AsyncHandle, String)	Retrieves the meta data of an app.
GetAppEntryAsync(String)	Retrieves the meta data of an app.
GetAppEntryAsync<T>(AsyncHandle, Func<Response, T>, String)	Retrieves the meta data of an app.
GetAppList()	Returns the list of apps. In Qlik Sense Enterprise: The list is generated by the QRS. The GetDocList method only returns documents the current user is allowed to access. In Qlik Sense Desktop: The apps are located in `C:\Users<user name>\Documents\Qlik\Sense\Apps`.
GetAppListAsync()	Returns the list of apps. In Qlik Sense Enterprise: The list is generated by the QRS. The GetDocList method only returns documents the current user is allowed to access. In Qlik Sense Desktop: The apps are located in `C:\Users<user name>\Documents\Qlik\Sense\Apps`.
GetAppListAsync(AsyncHandle)	Returns the list of apps. In Qlik Sense Enterprise: The list is generated by the QRS. The GetDocList method only returns documents the current user is allowed to access. In Qlik Sense Desktop: The apps are located in `C:\Users<user name>\Documents\Qlik\Sense\Apps`.
GetAppListAsync<T>(AsyncHandle, Func<Response, T>)	Returns the list of apps. In Qlik Sense Enterprise: The list is generated by the QRS. The GetDocList method only returns documents the current user is allowed to access. In Qlik Sense Desktop: The apps are located in `C:\Users<user name>\Documents\Qlik\Sense\Apps`.
GetAuthenticatedUser()	Retrieves information about the authenticated user.
GetAuthenticatedUserAsync()	Retrieves information about the authenticated user.
GetAuthenticatedUserAsync(AsyncHandle)	Retrieves information about the authenticated user.
GetAuthenticatedUserAsync<T>(AsyncHandle, Func<Response, T>)	Retrieves information about the authenticated user.
GetBaseBNF(BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBaseBNFAsync(AsyncHandle, BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBaseBNFAsync(BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBaseBNFAsync<T>(AsyncHandle, Func<Response, T>, BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBaseBNFHash(BNFType)	Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. If the hash changes between subsequent calls to this method, this indicates that the BNF grammar has changed.
GetBaseBNFHashAsync(AsyncHandle, BNFType)	Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. If the hash changes between subsequent calls to this method, this indicates that the BNF grammar has changed.
GetBaseBNFHashAsync(BNFType)	Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. If the hash changes between subsequent calls to this method, this indicates that the BNF grammar has changed.
GetBaseBNFHashAsync<T>(AsyncHandle, Func<Response, T>, BNFType)	Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. If the hash changes between subsequent calls to this method, this indicates that the BNF grammar has changed.
GetBaseBNFString(BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBaseBNFStringAsync(AsyncHandle, BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBaseBNFStringAsync(BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBaseBNFStringAsync<T>(AsyncHandle, Func<Response, T>, BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed. In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBNF(BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. The BNF rules define the syntax for the script statements and the script or chart functions. In the Qlik engine BNF grammar, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBNFAsync(AsyncHandle, BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. The BNF rules define the syntax for the script statements and the script or chart functions. In the Qlik engine BNF grammar, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBNFAsync(BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. The BNF rules define the syntax for the script statements and the script or chart functions. In the Qlik engine BNF grammar, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetBNFAsync<T>(AsyncHandle, Func<Response, T>, BNFType)	Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. The BNF rules define the syntax for the script statements and the script or chart functions. In the Qlik engine BNF grammar, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
GetCustomConnectors(Boolean)	List the custom connectors available in the system.
GetCustomConnectorsAsync(AsyncHandle, Boolean)	List the custom connectors available in the system.
GetCustomConnectorsAsync(Boolean)	List the custom connectors available in the system.
GetCustomConnectorsAsync<T>(AsyncHandle, Func<Response, T>, Boolean)	List the custom connectors available in the system.
GetDatabasesFromConnectionString(Connection)	Lists the databases in a ODBC, OLEDB or CUSTOM data source.
GetDatabasesFromConnectionStringAsync(AsyncHandle, Connection)	Lists the databases in a ODBC, OLEDB or CUSTOM data source.
GetDatabasesFromConnectionStringAsync(Connection)	Lists the databases in a ODBC, OLEDB or CUSTOM data source.
GetDatabasesFromConnectionStringAsync<T>(AsyncHandle, Func<Response, T>, Connection)	Lists the databases in a ODBC, OLEDB or CUSTOM data source.
GetDefaultAppFolder()	Returns the folder where the apps are stored.
GetDefaultAppFolderAsync()	Returns the folder where the apps are stored.
GetDefaultAppFolderAsync(AsyncHandle)	Returns the folder where the apps are stored.
GetDefaultAppFolderAsync<T>(AsyncHandle, Func<Response, T>)	Returns the folder where the apps are stored.
GetFolderItemsForPath(String)	Returns the files and folders located at a specified path.
GetFolderItemsForPathAsync(AsyncHandle, String)	Returns the files and folders located at a specified path.
GetFolderItemsForPathAsync(String)	Returns the files and folders located at a specified path.
GetFolderItemsForPathAsync<T>(AsyncHandle, Func<Response, T>, String)	Returns the files and folders located at a specified path.
GetFunctions(FunctionGroup)	Gets the list of all the script functions.
GetFunctionsAsync(AsyncHandle, FunctionGroup)	Gets the list of all the script functions.
GetFunctionsAsync(FunctionGroup)	Gets the list of all the script functions.
GetFunctionsAsync<T>(AsyncHandle, Func<Response, T>, FunctionGroup)	Gets the list of all the script functions.
GetInteract(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.
GetInteract(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.
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.
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.
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.
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.
GetLogicalDriveStrings()	Lists the logical drives in the system.
GetLogicalDriveStringsAsync()	Lists the logical drives in the system.
GetLogicalDriveStringsAsync(AsyncHandle)	Lists the logical drives in the system.
GetLogicalDriveStringsAsync<T>(AsyncHandle, Func<Response, T>)	Lists the logical drives in the system.
GetOdbcDsns()	Returns the list of the ODBC connectors that are installed in the system.
GetOdbcDsnsAsync()	Returns the list of the ODBC connectors that are installed in the system.
GetOdbcDsnsAsync(AsyncHandle)	Returns the list of the ODBC connectors that are installed in the system.
GetOdbcDsnsAsync<T>(AsyncHandle, Func<Response, T>)	Returns the list of the ODBC connectors that are installed in the system.
GetOleDbProviders()	Returns the list of the OLEDB providers installed on the system.
GetOleDbProvidersAsync()	Returns the list of the OLEDB providers installed on the system.
GetOleDbProvidersAsync(AsyncHandle)	Returns the list of the OLEDB providers installed on the system.
GetOleDbProvidersAsync<T>(AsyncHandle, Func<Response, T>)	Returns the list of the OLEDB providers installed on the system.
GetProgress(AsyncHandle)	Gives information about the progress of the DoReload and DoSave calls. asyncHandle corresponds to the identifier for the call.
GetProgress(Int32)	Gives information about the progress of the `DoReload` and `DoSave` calls.
GetProgressAsync(AsyncHandle)	Gives information about the progress of the DoReload and DoSave calls. asyncHandle corresponds to the identifier for the call.
GetProgressAsync(AsyncHandle, Int32)	Gives information about the progress of the `DoReload` and `DoSave` calls.
GetProgressAsync(Int32)	Gives information about the progress of the `DoReload` and `DoSave` calls.
GetProgressAsync<T>(AsyncHandle, Func<Response, T>, Int32)	Gives information about the progress of the `DoReload` and `DoSave` calls.
GetStreamList()
GetStreamListAsync()
GetStreamListAsync(AsyncHandle)
GetStreamListAsync<T>(AsyncHandle, Func<Response, T>)
GetSupportedCodePages()	Lists the supported code pages.
GetSupportedCodePagesAsync()	Lists the supported code pages.
GetSupportedCodePagesAsync(AsyncHandle)	Lists the supported code pages.
GetSupportedCodePagesAsync<T>(AsyncHandle, Func<Response, T>)	Lists the supported code pages.
GetUniqueID()	Returns the unique identifier of the endpoint for the current user in the current app.
GetUniqueIDAsync()	Returns the unique identifier of the endpoint for the current user in the current app.
GetUniqueIDAsync(AsyncHandle)	Returns the unique identifier of the endpoint for the current user in the current app.
GetUniqueIDAsync<T>(AsyncHandle, Func<Response, T>)	Returns the unique identifier of the endpoint for the current user in the current app.
InteractDone(AsyncHandle, InteractDef)	Informs the engine that a user interaction (which was earlier requested by the engine) was performed and indicates the engine what to do next.
InteractDone(Int32, InteractDef)	Informs the engine that a user interaction (which was earlier requested by the engine) was performed and indicates to the engine what to do next.
InteractDoneAsync(AsyncHandle, InteractDef)	Informs the engine that a user interaction (which was earlier requested by the engine) was performed and indicates the engine what to do next.
InteractDoneAsync(AsyncHandle, Int32, InteractDef)	Informs the engine that a user interaction (which was earlier requested by the engine) was performed and indicates to the engine what to do next.
InteractDoneAsync(Int32, InteractDef)	Informs the engine that a user interaction (which was earlier requested by the engine) was performed and indicates to the engine what to do next.
IsDesktopMode()	Indicates whether the user is working in Qlik Sense Desktop.
IsDesktopModeAsync()	Indicates whether the user is working in Qlik Sense Desktop.
IsDesktopModeAsync(AsyncHandle)	Indicates whether the user is working in Qlik Sense Desktop.
IsDesktopModeAsync<T>(AsyncHandle, Func<Response, T>)	Indicates whether the user is working in Qlik Sense Desktop.
IsPersonalMode()	Indicates whether or not the user is working in personal mode (Qlik Sense Desktop).
IsPersonalModeAsync()	Indicates whether or not the user is working in personal mode (Qlik Sense Desktop).
IsPersonalModeAsync(AsyncHandle)	Indicates whether or not the user is working in personal mode (Qlik Sense Desktop).
IsPersonalModeAsync<T>(AsyncHandle, Func<Response, T>)	Indicates whether or not the user is working in personal mode (Qlik Sense Desktop).
IsValidConnectionString(Connection)	Checks if a connection string is valid.
IsValidConnectionStringAsync(AsyncHandle, Connection)	Checks if a connection string is valid.
IsValidConnectionStringAsync(Connection)	Checks if a connection string is valid.
IsValidConnectionStringAsync<T>(AsyncHandle, Func<Response, T>, Connection)	Checks if a connection string is valid.
OpenApp(String, String, String, String, Boolean)	Opens an app and checks if the app needs to be migrated (if the app is deprecated). The `OpenDoc method` compares the version of the app with the version of Qlik Sense and migrates the app to the current version of Qlik Sense if necessary. Once the migration is done, the app is opened. If no migration is needed, the app is opened immediately. The following applies: * The app version is lower than 0.95: no migration is done. Apps older than the version 0.95 are not supported. * The app version is at least 0.95 and less than the Qlik Sense version: the app is migrated and then opened. * Qlik Sense and the app have the same version: the app is opened, no migration is needed. Backups In Qlik Sense Desktop, apps are automatically backed up before a migration. The backup files are located in `%userprofile%\Documents\Qlik\Sense\AppsBackup<Qlik Sense Desktop version>`. In Qlik Sense Enterprise, no automatic back up is run. The back up should be done manually.
OpenAppAsync(AsyncHandle, String, String, String, String, Boolean)	Opens an app and checks if the app needs to be migrated (if the app is deprecated). The `OpenDoc method` compares the version of the app with the version of Qlik Sense and migrates the app to the current version of Qlik Sense if necessary. Once the migration is done, the app is opened. If no migration is needed, the app is opened immediately. The following applies: * The app version is lower than 0.95: no migration is done. Apps older than the version 0.95 are not supported. * The app version is at least 0.95 and less than the Qlik Sense version: the app is migrated and then opened. * Qlik Sense and the app have the same version: the app is opened, no migration is needed. Backups In Qlik Sense Desktop, apps are automatically backed up before a migration. The backup files are located in `%userprofile%\Documents\Qlik\Sense\AppsBackup<Qlik Sense Desktop version>`. In Qlik Sense Enterprise, no automatic back up is run. The back up should be done manually.
OpenAppAsync(String, String, String, String, Boolean)	Opens an app and checks if the app needs to be migrated (if the app is deprecated). The `OpenDoc method` compares the version of the app with the version of Qlik Sense and migrates the app to the current version of Qlik Sense if necessary. Once the migration is done, the app is opened. If no migration is needed, the app is opened immediately. The following applies: * The app version is lower than 0.95: no migration is done. Apps older than the version 0.95 are not supported. * The app version is at least 0.95 and less than the Qlik Sense version: the app is migrated and then opened. * Qlik Sense and the app have the same version: the app is opened, no migration is needed. Backups In Qlik Sense Desktop, apps are automatically backed up before a migration. The backup files are located in `%userprofile%\Documents\Qlik\Sense\AppsBackup<Qlik Sense Desktop version>`. In Qlik Sense Enterprise, no automatic back up is run. The back up should be done manually.
OpenAppAsync<T>(AsyncHandle, Func<Response, T>, String, String, String, String, Boolean)	Opens an app and checks if the app needs to be migrated (if the app is deprecated). The `OpenDoc method` compares the version of the app with the version of Qlik Sense and migrates the app to the current version of Qlik Sense if necessary. Once the migration is done, the app is opened. If no migration is needed, the app is opened immediately. The following applies: * The app version is lower than 0.95: no migration is done. Apps older than the version 0.95 are not supported. * The app version is at least 0.95 and less than the Qlik Sense version: the app is migrated and then opened. * Qlik Sense and the app have the same version: the app is opened, no migration is needed. Backups In Qlik Sense Desktop, apps are automatically backed up before a migration. The backup files are located in `%userprofile%\Documents\Qlik\Sense\AppsBackup<Qlik Sense Desktop version>`. In Qlik Sense Enterprise, no automatic back up is run. The back up should be done manually.
OSName()	Returns the name of the operating system.
OSNameAsync()	Returns the name of the operating system.
OSNameAsync(AsyncHandle)	Returns the name of the operating system.
OSNameAsync<T>(AsyncHandle, Func<Response, T>)	Returns the name of the operating system.
OSVersion()	Returns the version number of the operating system.
OSVersionAsync()	Returns the version number of the operating system.
OSVersionAsync(AsyncHandle)	Returns the version number of the operating system.
OSVersionAsync<T>(AsyncHandle, Func<Response, T>)	Returns the version number of the operating system.
ProductVersion()	Returns the Qlik Sense version number.
ProductVersionAsync()	Returns the Qlik Sense version number.
ProductVersionAsync(AsyncHandle)	Returns the Qlik Sense version number.
ProductVersionAsync<T>(AsyncHandle, Func<Response, T>)	Returns the Qlik Sense version number.
PublishApp(String, String, String)	Publishes an app to the supplied stream.
PublishAppAsync(AsyncHandle, String, String, String)	Publishes an app to the supplied stream.
PublishAppAsync(String, String, String)	Publishes an app to the supplied stream.
QTProduct()	Returns the Qlik product name.
QTProductAsync()	Returns the Qlik product name.
QTProductAsync(AsyncHandle)	Returns the Qlik product name.
QTProductAsync<T>(AsyncHandle, Func<Response, T>)	Returns the Qlik product name.
QvVersion()	Returns the Qlik Sense version number.
QvVersionAsync()	Returns the Qlik Sense version number.
QvVersionAsync(AsyncHandle)	Returns the Qlik Sense version number.
QvVersionAsync<T>(AsyncHandle, Func<Response, T>)	Returns the Qlik Sense version number.
ReloadExtensionList()	Reloads the list of extensions.
ReloadExtensionListAsync()	Reloads the list of extensions.
ReloadExtensionListAsync(AsyncHandle)	Reloads the list of extensions.
ReplaceAppFromID(String, String, IEnumerable<String>)	Replaces objects of a target app with the objects from a source app. The list of objects in the app to be replaced must be defined in `qIds`.
ReplaceAppFromIDAsync(AsyncHandle, String, String, IEnumerable<String>)	Replaces objects of a target app with the objects from a source app. The list of objects in the app to be replaced must be defined in `qIds`.
ReplaceAppFromIDAsync(String, String, IEnumerable<String>)	Replaces objects of a target app with the objects from a source app. The list of objects in the app to be replaced must be defined in `qIds`.
ReplaceAppFromIDAsync<T>(AsyncHandle, Func<Response, T>, String, String, IEnumerable<String>)	Replaces objects of a target app with the objects from a source app. The list of objects in the app to be replaced must be defined in `qIds`.
SaveAs(String)	Save a copy of an app with a different name. Can be used to save a session app as an ordinary app.
SaveAsAsync(AsyncHandle, String)	Save a copy of an app with a different name. Can be used to save a session app as an ordinary app.
SaveAsAsync(String)	Save a copy of an app with a different name. Can be used to save a session app as an ordinary app.
SaveAsAsync<T>(AsyncHandle, Func<Response, T>, String)	Save a copy of an app with a different name. Can be used to save a session app as an ordinary app.
ShutdownProcess()	Shuts down the Qlik engine.
ShutdownProcessAsync()	Shuts down the Qlik engine.
ShutdownProcessAsync(AsyncHandle)	Shuts down the Qlik engine.

Events

Name	Description
CommunicationErrorEvent	Triggered when a communication error occurs on the websocket used by the hub.

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

IHub Interface

Syntax

Properties

Methods

Logs

Where to find the log files

Logs

Where to find the log files

Logs

Where to find the log files

Logs

Where to find the log files

Qlik Sense Enterprise

Qlik Sense Desktop

Logs

Where to find the log files

Qlik Sense Enterprise

Qlik Sense Desktop

Logs

Where to find the log files

Qlik Sense Enterprise

Qlik Sense Desktop

Logs

Where to find the log files

Qlik Sense Enterprise

Qlik Sense Desktop

Logs

Where to find the log files

Logs

Logs

Logs

Logs

Backups

Backups

Backups

Backups

Events

Did this page help you?