| IHub Interface |
Namespace: Qlik.Engine
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)
SyntaxThe IHub type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AbortAll | Sets an abort flag on all pending and ongoing requests in the current 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 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(AsyncHandle) | Indicates whether or not a user is able to create an app. |
| AllowCreateAppAsyncT(FuncResponse, T, AsyncHandle) | Indicates whether or not a user is able to create an app. |
| CancelReload | Cancels an ongoing reload. The reload of the app is stopped. |
| CancelReloadAsync | Cancels an ongoing reload. The reload of the app is stopped. |
| CancelRequest | Cancels an ongoing request. The request is stopped. |
| CancelRequestAsync | Cancels an ongoing request. The request is stopped. |
| ConfigureReload | Configures the engine's behavior during a reload. The ConfigureReload method should be run before the DoReload method. |
| ConfigureReloadAsync | Configures the engine's behavior during a reload. The ConfigureReload method should be run before the DoReload method. |
| CopyApp | 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. See the QRS API (REST API) help for more information. This method applies only if running in server mode. |
| CopyAppAsync(String, String, IEnumerableString, AsyncHandle) | 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. See the QRS API (REST API) help for more information. This method applies only if running in server mode. |
| CopyAppAsyncT(String, String, IEnumerableString, FuncResponse, T, AsyncHandle) | 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. See the QRS API (REST API) help for more information. This method applies only if running in server mode. |
| CreateApp | Creates an app. |
| CreateAppAsync(String, String, AsyncHandle) | Creates an app. |
| CreateAppAsyncT(String, String, FuncResponse, T, AsyncHandle) | Creates an app. |
| CreateAppEx | Creates an app and opens a session. This method applies only if running a local installation of Qlik Sense. |
| CreateAppExAsync(String, String, String, String, String, AsyncHandle) | Creates an app and opens a session. This method applies only if running a local installation of Qlik Sense. |
| CreateAppExAsyncT(String, String, String, String, String, FuncResponse, T, AsyncHandle) | Creates an app and opens a session. This method applies only if running a local installation of Qlik Sense. |
| DestroyApp | Deletes an app from the Qlik Sense repository or from the file system. ** In server mode ** In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Repository\Apps The default installation directory is ProgramData. ** In desktop mode ** The app is deleted from the directory %userprofile%\Documents\Qlik\Sense\Apps. |
| DestroyAppAsync(String, AsyncHandle) | Deletes an app from the Qlik Sense repository or from the file system. ** In server mode ** In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Repository\Apps The default installation directory is ProgramData. ** In desktop mode ** The app is deleted from the directory %userprofile%\Documents\Qlik\Sense\Apps. |
| DestroyAppAsyncT(String, FuncResponse, T, AsyncHandle) | Deletes an app from the Qlik Sense repository or from the file system. ** In server mode ** In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Repository\Apps The default installation directory is ProgramData. ** In desktop mode ** The app is deleted from the directory %userprofile%\Documents\Qlik\Sense\Apps. |
| ExportApp | Exports an app from the Qlik Sense repository to the file system. This method applies only if running in server mode. |
| ExportAppAsync(String, String, IEnumerableString, AsyncHandle) | Exports an app from the Qlik Sense repository to the file system. This method applies only if running in server mode. |
| ExportAppAsyncT(String, String, IEnumerableString, FuncResponse, T, AsyncHandle) | Exports an app from the Qlik Sense repository to the file system. This method applies only if running in server mode. |
| GetActiveDoc | Returns the handle of the current app. |
| GetActiveDocAsync(AsyncHandle) | Returns the handle of the current app. |
| GetActiveDocAsyncT(FuncResponse, T, AsyncHandle) | Returns the handle of the current app. |
| GetAppList | Returns the list of apps available: * in the repository in C:\ProgramData\Qlik\Sense\Repository\Apps if running Qlik Sense Server * in the directory C:\Users\<user name>\Documents\Qlik\Sense\Apps if running a local installation of Qlik Sense. If Qlik Sense has not been installed under ProgramData when in server mode, the app files are located under <installation_directory>\Qlik\Sense\Repository\Apps. |
| GetAppListAsync(AsyncHandle) | Returns the list of apps available: * in the repository in C:\ProgramData\Qlik\Sense\Repository\Apps if running Qlik Sense Server * in the directory C:\Users\<user name>\Documents\Qlik\Sense\Apps if running a local installation of Qlik Sense. If Qlik Sense has not been installed under ProgramData when in server mode, the app files are located under <installation_directory>\Qlik\Sense\Repository\Apps. |
| GetAppListAsyncT(FuncResponse, T, AsyncHandle) | Returns the list of apps available: * in the repository in C:\ProgramData\Qlik\Sense\Repository\Apps if running Qlik Sense Server * in the directory C:\Users\<user name>\Documents\Qlik\Sense\Apps if running a local installation of Qlik Sense. If Qlik Sense has not been installed under ProgramData when in server mode, the app files are located under <installation_directory>\Qlik\Sense\Repository\Apps. |
| GetAuthenticatedUser | Retrieves information about the authenticated user. |
| GetAuthenticatedUserAsync(AsyncHandle) | Retrieves information about the authenticated user. |
| GetAuthenticatedUserAsyncT(FuncResponse, T, AsyncHandle) | Retrieves information about the authenticated user. |
| GetBNF | Returns a set of rules defining the Qlik Sense scripting language grammar. These rules define the syntax for the script statements and the script or chart functions. A way to retrieve the list of script statements, script functions or chart functions is to call the GetBNF method. |
| GetBNFAsync(BNFType, AsyncHandle) | Returns a set of rules defining the Qlik Sense scripting language grammar. These rules define the syntax for the script statements and the script or chart functions. A way to retrieve the list of script statements, script functions or chart functions is to call the GetBNF method. |
| GetBNFAsyncT(BNFType, FuncResponse, T, AsyncHandle) | Returns a set of rules defining the Qlik Sense scripting language grammar. These rules define the syntax for the script statements and the script or chart functions. A way to retrieve the list of script statements, script functions or chart functions is to call the GetBNF method. |
| GetCustomConnectors | List the custom connectors available in the system. |
| GetCustomConnectorsAsync(Boolean, AsyncHandle) | List the custom connectors available in the system. |
| GetCustomConnectorsAsyncT(Boolean, FuncResponse, T, AsyncHandle) | List the custom connectors available in the system. |
| GetDatabasesFromConnectionString | Lists the databases in a ODBC, OLEDB or CUSTOM data source. |
| GetDatabasesFromConnectionStringAsync(Connection, AsyncHandle) | Lists the databases in a ODBC, OLEDB or CUSTOM data source. |
| GetDatabasesFromConnectionStringAsyncT(Connection, FuncResponse, T, AsyncHandle) | Lists the databases in a ODBC, OLEDB or CUSTOM data source. |
| GetDefaultAppFolder | Returns the folder where the apps are stored. This method applies only if running Qlik Sense Desktop. |
| GetDefaultAppFolderAsync(AsyncHandle) | Returns the folder where the apps are stored. This method applies only if running Qlik Sense Desktop. |
| GetDefaultAppFolderAsyncT(FuncResponse, T, AsyncHandle) | Returns the folder where the apps are stored. This method applies only if running Qlik Sense Desktop. |
| GetFolderItemsForPath | Returns the files and folders located at a specified path. |
| GetFolderItemsForPathAsync(String, AsyncHandle) | Returns the files and folders located at a specified path. |
| GetFolderItemsForPathAsyncT(String, FuncResponse, T, AsyncHandle) | Returns the files and folders located at a specified path. |
| GetFunctions | Gets the list of all the script functions. |
| GetFunctionsAsync(FunctionGroup, AsyncHandle) | Gets the list of all the script functions. |
| GetFunctionsAsyncT(FunctionGroup, FuncResponse, T, AsyncHandle) | Gets the list of all the script functions. |
| GetInteract | |
| GetInteractAsync(Int32, AsyncHandle) | |
| GetInteractAsyncT(Int32, FuncResponse, T, AsyncHandle) | |
| GetLogicalDriveStrings | Lists the logical drives in the system. This method applies only if running Qlik Sense Desktop. |
| GetLogicalDriveStringsAsync(AsyncHandle) | Lists the logical drives in the system. This method applies only if running Qlik Sense Desktop. |
| GetLogicalDriveStringsAsyncT(FuncResponse, T, AsyncHandle) | Lists the logical drives in the system. This method applies only if running Qlik Sense Desktop. |
| GetMyDocumentsFolder | |
| GetMyDocumentsFolderAsync(AsyncHandle) | |
| GetMyDocumentsFolderAsyncT(FuncResponse, T, AsyncHandle) | |
| GetOdbcDsns | 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. |
| GetOdbcDsnsAsyncT(FuncResponse, T, AsyncHandle) | 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(AsyncHandle) | Returns the list of the OLEDB providers installed on the system. |
| GetOleDbProvidersAsyncT(FuncResponse, T, AsyncHandle) | Returns the list of the OLEDB providers installed on the system. |
| GetProgress | Gives information about the progress of the DoReload and DoSave calls. For more information on DoReload and DoSave, see the DoReload method and DoSave method. |
| GetProgressAsync(AsyncHandle) | |
| GetProgressAsync(Int32, AsyncHandle) | Gives information about the progress of the DoReload and DoSave calls. For more information on DoReload and DoSave, see the DoReload method and DoSave method. |
| GetProgressAsyncT(Int32, FuncResponse, T, AsyncHandle) | Gives information about the progress of the DoReload and DoSave calls. For more information on DoReload and DoSave, see the DoReload method and DoSave method. |
| GetStreamList | Lists the streams. |
| GetStreamListAsync(AsyncHandle) | Lists the streams. |
| GetStreamListAsyncT(FuncResponse, T, AsyncHandle) | Lists the streams. |
| GetSupportedCodePages | Lists the supported code pages. |
| GetSupportedCodePagesAsync(AsyncHandle) | Lists the supported code pages. |
| GetSupportedCodePagesAsyncT(FuncResponse, T, AsyncHandle) | Lists the supported code pages. |
| GetUniqueID | Returns the unique identifier of the endpoint for the current user in the current app. This unique identifier can be used for logging purposes. |
| GetUniqueIDAsync(AsyncHandle) | Returns the unique identifier of the endpoint for the current user in the current app. This unique identifier can be used for logging purposes. |
| GetUniqueIDAsyncT(FuncResponse, T, AsyncHandle) | Returns the unique identifier of the endpoint for the current user in the current app. This unique identifier can be used for logging purposes. |
| ImportApp | Imports an app to the Qlik Sense repository. This method applies only if running in server mode. |
| ImportAppAsync(String, String, IEnumerableString, AsyncHandle) | Imports an app to the Qlik Sense repository. This method applies only if running in server mode. |
| ImportAppAsyncT(String, String, IEnumerableString, FuncResponse, T, AsyncHandle) | Imports an app to the Qlik Sense repository. This method applies only if running in server mode. |
| InteractDone | |
| InteractDoneAsync | |
| IsDesktopMode | Indicates whether or not the user works in standalone mode. |
| IsDesktopModeAsync(AsyncHandle) | Indicates whether or not the user works in standalone mode. |
| IsDesktopModeAsyncT(FuncResponse, T, AsyncHandle) | Indicates whether or not the user works in standalone mode. |
| IsPersonalMode | Indicates whether or not the user works in personal mode. |
| IsPersonalModeAsync(AsyncHandle) | Indicates whether or not the user works in personal mode. |
| IsPersonalModeAsyncT(FuncResponse, T, AsyncHandle) | Indicates whether or not the user works in personal mode. |
| IsValidConnectionString | Checks if a connection string is valid. |
| IsValidConnectionStringAsync(Connection, AsyncHandle) | Checks if a connection string is valid. |
| IsValidConnectionStringAsyncT(Connection, FuncResponse, T, AsyncHandle) | Checks if a connection string is valid. |
| OpenApp | Opens an app. It is not recommended to use this method to open an app. The OpenApp method should be used instead. |
| OpenAppAsync(String, String, String, String, Boolean, AsyncHandle) | Opens an app. It is not recommended to use this method to open an app. The OpenApp method should be used instead. |
| OpenAppAsyncT(String, String, String, String, Boolean, FuncResponse, T, AsyncHandle) | Opens an app. It is not recommended to use this method to open an app. The OpenApp method should be used instead. |
| OSName | Returns the name of the operating system. |
| OSNameAsync(AsyncHandle) | Returns the name of the operating system. |
| OSNameAsyncT(FuncResponse, T, AsyncHandle) | Returns the name of the operating system. |
| OSVersion | Returns the version number of the operating system. |
| OSVersionAsync(AsyncHandle) | Returns the version number of the operating system. |
| OSVersionAsyncT(FuncResponse, T, AsyncHandle) | Returns the version number of the operating system. |
| PublishApp | |
| PublishAppAsync(String, String, Boolean, String, AsyncHandle) | |
| PublishAppAsyncT(String, String, Boolean, String, FuncResponse, T, AsyncHandle) | |
| QTProduct | Returns the Qlik product name. |
| QTProductAsync(AsyncHandle) | Returns the Qlik product name. |
| QTProductAsyncT(FuncResponse, T, AsyncHandle) | Returns the Qlik product name. |
| QvVersion | Returns the Qlik Sense version number. |
| QvVersionAsync(AsyncHandle) | Returns the Qlik Sense version number. |
| QvVersionAsyncT(FuncResponse, T, AsyncHandle) | Returns the Qlik Sense version number. |
| ReloadExtensionList | Reloads the list of extensions. |
| ReloadExtensionListAsync | Reloads the list of extensions. |
| ReplaceAppFromID | Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode. |
| ReplaceAppFromIDAsync(String, String, IEnumerableString, AsyncHandle) | Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode. |
| ReplaceAppFromIDAsyncT(String, String, IEnumerableString, FuncResponse, T, AsyncHandle) | Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode. |
| ReplaceAppFromPath | Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode. |
| ReplaceAppFromPathAsync(String, String, IEnumerableString, AsyncHandle) | Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode. |
| ReplaceAppFromPathAsyncT(String, String, IEnumerableString, FuncResponse, T, AsyncHandle) | Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode. |
| ShutdownProcess | Shutdowns the Qlik engine. This method applies only if running a local installation of Qlik Sense. |
| ShutdownProcessAsync | Shutdowns the Qlik engine. This method applies only if running a local installation of Qlik Sense. |
| TestLogging | |
| TestLoggingAsync(String, Int32, Int32, AsyncHandle) | |
| TestLoggingAsyncT(String, Int32, Int32, FuncResponse, T, AsyncHandle) | |
| TestRepositoryLogging | |
| TestRepositoryLoggingAsync(String, Int32, String, AsyncHandle) | |
| TestRepositoryLoggingAsyncT(String, Int32, String, FuncResponse, T, AsyncHandle) |
Properties| Name | Description | |
|---|---|---|
 | Handle |
The handle of the Qlik Sense entity.
(Inherited from IQixClassBase.) |
| Id |
The id of the Qlik Sense entity.
(Inherited from IQixClassBase.) |
| Type |
The type of the Qlik Sense entity.
(Inherited from IQixClassBase.) |
Events| Name | Description | |
|---|---|---|
 | Changed |
This event fires every time the Qlik Sense entity needs to be updated due to changes in either selectionstate, data or entity properties
(Inherited from IQixClassBase.) |
| Closed |
This event fires when the Qlik Sense entity has been removed or deleted.
(Inherited from IQixClassBase.) |
| CommunicationError |
See Also