Click or drag to resize
IHub Methods

The IHub type exposes the following members.

Methods
  NameDescription
Public methodAbortAll

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.

Public methodAbortAllAsync

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.

Public methodAllowCreateApp

Indicates whether or not a user is able to create an app.

Public methodAllowCreateAppAsync(AsyncHandle)

Indicates whether or not a user is able to create an app.

Public methodAllowCreateAppAsyncT(FuncResponse, T, AsyncHandle)

Indicates whether or not a user is able to create an app.

Public methodCancelReload

Cancels an ongoing reload. The reload of the app is stopped.

Public methodCancelReloadAsync

Cancels an ongoing reload. The reload of the app is stopped.

Public methodCancelRequest

Cancels an ongoing request. The request is stopped.

Public methodCancelRequestAsync

Cancels an ongoing request. The request is stopped.

Public methodConfigureReload

Configures the engine's behavior during a reload.

The ConfigureReload method should be run before the DoReload method.
Public methodConfigureReloadAsync

Configures the engine's behavior during a reload.

The ConfigureReload method should be run before the DoReload method.
Public methodCopyApp

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.
Public methodCopyAppAsync(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.
Public methodCopyAppAsyncT(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.
Public methodCreateApp

Creates an app.

Public methodCreateAppAsync(String, String, AsyncHandle)

Creates an app.

Public methodCreateAppAsyncT(String, String, FuncResponse, T, AsyncHandle)

Creates an app.

Public methodCreateAppEx

Creates an app and opens a session.

This method applies only if running a local installation of Qlik Sense.
Public methodCreateAppExAsync(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.
Public methodCreateAppExAsyncT(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.
Public methodDestroyApp

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.

Public methodDestroyAppAsync(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.

Public methodDestroyAppAsyncT(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.

Public methodExportApp

Exports an app from the Qlik Sense repository to the file system.

This method applies only if running in server mode.
Public methodExportAppAsync(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.
Public methodExportAppAsyncT(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.
Public methodGetActiveDoc

Returns the handle of the current app.

Public methodGetActiveDocAsync(AsyncHandle)

Returns the handle of the current app.

Public methodGetActiveDocAsyncT(FuncResponse, T, AsyncHandle)

Returns the handle of the current app.

Public methodGetAppList

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.
Public methodGetAppListAsync(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.
Public methodGetAppListAsyncT(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.
Public methodGetAuthenticatedUser

Retrieves information about the authenticated user.

Public methodGetAuthenticatedUserAsync(AsyncHandle)

Retrieves information about the authenticated user.

Public methodGetAuthenticatedUserAsyncT(FuncResponse, T, AsyncHandle)

Retrieves information about the authenticated user.

Public methodGetBNF

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.
Public methodGetBNFAsync(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.
Public methodGetBNFAsyncT(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.
Public methodGetCustomConnectors

List the custom connectors available in the system.

Public methodGetCustomConnectorsAsync(Boolean, AsyncHandle)

List the custom connectors available in the system.

Public methodGetCustomConnectorsAsyncT(Boolean, FuncResponse, T, AsyncHandle)

List the custom connectors available in the system.

Public methodGetDatabasesFromConnectionString

Lists the databases in a ODBC, OLEDB or CUSTOM data source.

Public methodGetDatabasesFromConnectionStringAsync(Connection, AsyncHandle)

Lists the databases in a ODBC, OLEDB or CUSTOM data source.

Public methodGetDatabasesFromConnectionStringAsyncT(Connection, FuncResponse, T, AsyncHandle)

Lists the databases in a ODBC, OLEDB or CUSTOM data source.

Public methodGetDefaultAppFolder

Returns the folder where the apps are stored.

This method applies only if running Qlik Sense Desktop.
Public methodGetDefaultAppFolderAsync(AsyncHandle)

Returns the folder where the apps are stored.

This method applies only if running Qlik Sense Desktop.
Public methodGetDefaultAppFolderAsyncT(FuncResponse, T, AsyncHandle)

Returns the folder where the apps are stored.

This method applies only if running Qlik Sense Desktop.
Public methodGetFolderItemsForPath

Returns the files and folders located at a specified path.

Public methodGetFolderItemsForPathAsync(String, AsyncHandle)

Returns the files and folders located at a specified path.

Public methodGetFolderItemsForPathAsyncT(String, FuncResponse, T, AsyncHandle)

Returns the files and folders located at a specified path.

Public methodGetFunctions

Gets the list of all the script functions.

Public methodGetFunctionsAsync(FunctionGroup, AsyncHandle)

Gets the list of all the script functions.

Public methodGetFunctionsAsyncT(FunctionGroup, FuncResponse, T, AsyncHandle)

Gets the list of all the script functions.

Public methodGetInteract
Public methodGetInteractAsync(Int32, AsyncHandle)
Public methodGetInteractAsyncT(Int32, FuncResponse, T, AsyncHandle)
Public methodGetLogicalDriveStrings

Lists the logical drives in the system.

This method applies only if running Qlik Sense Desktop.
Public methodGetLogicalDriveStringsAsync(AsyncHandle)

Lists the logical drives in the system.

This method applies only if running Qlik Sense Desktop.
Public methodGetLogicalDriveStringsAsyncT(FuncResponse, T, AsyncHandle)

Lists the logical drives in the system.

This method applies only if running Qlik Sense Desktop.
Public methodGetMyDocumentsFolder
Public methodGetMyDocumentsFolderAsync(AsyncHandle)
Public methodGetMyDocumentsFolderAsyncT(FuncResponse, T, AsyncHandle)
Public methodGetOdbcDsns

Returns the list of the ODBC connectors that are installed in the system.

Public methodGetOdbcDsnsAsync(AsyncHandle)

Returns the list of the ODBC connectors that are installed in the system.

Public methodGetOdbcDsnsAsyncT(FuncResponse, T, AsyncHandle)

Returns the list of the ODBC connectors that are installed in the system.

Public methodGetOleDbProviders

Returns the list of the OLEDB providers installed on the system.

Public methodGetOleDbProvidersAsync(AsyncHandle)

Returns the list of the OLEDB providers installed on the system.

Public methodGetOleDbProvidersAsyncT(FuncResponse, T, AsyncHandle)

Returns the list of the OLEDB providers installed on the system.

Public methodGetProgress

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.
Public methodGetProgressAsync(AsyncHandle)
Public methodGetProgressAsync(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.
Public methodGetProgressAsyncT(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.
Public methodGetStreamList

Lists the streams.

Public methodGetStreamListAsync(AsyncHandle)

Lists the streams.

Public methodGetStreamListAsyncT(FuncResponse, T, AsyncHandle)

Lists the streams.

Public methodGetSupportedCodePages

Lists the supported code pages.

Public methodGetSupportedCodePagesAsync(AsyncHandle)

Lists the supported code pages.

Public methodGetSupportedCodePagesAsyncT(FuncResponse, T, AsyncHandle)

Lists the supported code pages.

Public methodGetUniqueID

Returns the unique identifier of the endpoint for the current user in the current app.

This unique identifier can be used for logging purposes.
Public methodGetUniqueIDAsync(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.
Public methodGetUniqueIDAsyncT(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.
Public methodImportApp

Imports an app to the Qlik Sense repository.

This method applies only if running in server mode.
Public methodImportAppAsync(String, String, IEnumerableString, AsyncHandle)

Imports an app to the Qlik Sense repository.

This method applies only if running in server mode.
Public methodImportAppAsyncT(String, String, IEnumerableString, FuncResponse, T, AsyncHandle)

Imports an app to the Qlik Sense repository.

This method applies only if running in server mode.
Public methodInteractDone
Public methodInteractDoneAsync
Public methodIsDesktopMode

Indicates whether or not the user works in standalone mode.

Public methodIsDesktopModeAsync(AsyncHandle)

Indicates whether or not the user works in standalone mode.

Public methodIsDesktopModeAsyncT(FuncResponse, T, AsyncHandle)

Indicates whether or not the user works in standalone mode.

Public methodIsPersonalMode

Indicates whether or not the user works in personal mode.

Public methodIsPersonalModeAsync(AsyncHandle)

Indicates whether or not the user works in personal mode.

Public methodIsPersonalModeAsyncT(FuncResponse, T, AsyncHandle)

Indicates whether or not the user works in personal mode.

Public methodIsValidConnectionString

Checks if a connection string is valid.

Public methodIsValidConnectionStringAsync(Connection, AsyncHandle)

Checks if a connection string is valid.

Public methodIsValidConnectionStringAsyncT(Connection, FuncResponse, T, AsyncHandle)

Checks if a connection string is valid.

Public methodOpenApp

Opens an app.

It is not recommended to use this method to open an app. The OpenApp method should be used instead.
Public methodOpenAppAsync(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.
Public methodOpenAppAsyncT(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.
Public methodOSName

Returns the name of the operating system.

Public methodOSNameAsync(AsyncHandle)

Returns the name of the operating system.

Public methodOSNameAsyncT(FuncResponse, T, AsyncHandle)

Returns the name of the operating system.

Public methodOSVersion

Returns the version number of the operating system.

Public methodOSVersionAsync(AsyncHandle)

Returns the version number of the operating system.

Public methodOSVersionAsyncT(FuncResponse, T, AsyncHandle)

Returns the version number of the operating system.

Public methodPublishApp
Public methodPublishAppAsync(String, String, Boolean, String, AsyncHandle)
Public methodPublishAppAsyncT(String, String, Boolean, String, FuncResponse, T, AsyncHandle)
Public methodQTProduct

Returns the Qlik product name.

Public methodQTProductAsync(AsyncHandle)

Returns the Qlik product name.

Public methodQTProductAsyncT(FuncResponse, T, AsyncHandle)

Returns the Qlik product name.

Public methodQvVersion

Returns the Qlik Sense version number.

Public methodQvVersionAsync(AsyncHandle)

Returns the Qlik Sense version number.

Public methodQvVersionAsyncT(FuncResponse, T, AsyncHandle)

Returns the Qlik Sense version number.

Public methodReloadExtensionList

Reloads the list of extensions.

Public methodReloadExtensionListAsync

Reloads the list of extensions.

Public methodReplaceAppFromID

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.
Public methodReplaceAppFromIDAsync(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.
Public methodReplaceAppFromIDAsyncT(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.
Public methodReplaceAppFromPath

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.
Public methodReplaceAppFromPathAsync(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.
Public methodReplaceAppFromPathAsyncT(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.
Public methodShutdownProcess

Shutdowns the Qlik engine.

This method applies only if running a local installation of Qlik Sense.
Public methodShutdownProcessAsync

Shutdowns the Qlik engine.

This method applies only if running a local installation of Qlik Sense.
Public methodTestLogging
Public methodTestLoggingAsync(String, Int32, Int32, AsyncHandle)
Public methodTestLoggingAsyncT(String, Int32, Int32, FuncResponse, T, AsyncHandle)
Public methodTestRepositoryLogging
Public methodTestRepositoryLoggingAsync(String, Int32, String, AsyncHandle)
Public methodTestRepositoryLoggingAsyncT(String, Int32, String, FuncResponse, T, AsyncHandle)
Top
See Also