IHubOpenAppAsync Method (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.
If the app is read-only, the app migration cannot occur. An error message is sent.
Namespace: Qlik.EngineAssembly: Qlik.Engine (in Qlik.Engine.dll) Version: 2.1.0.0+Build:7.origin/release/ms13
Syntax Task<App> OpenAppAsync(
AsyncHandle asyncHandle,
string docName,
string userName = null,
string password = null,
string serial = null,
bool noData = false
)
Function OpenAppAsync (
asyncHandle As AsyncHandle,
docName As String,
Optional userName As String = Nothing,
Optional password As String = Nothing,
Optional serial As String = Nothing,
Optional noData As Boolean = false
) As Task(Of App)
Parameters
- asyncHandle
- Type: Qlik.EngineAsyncHandle
Handle to asynchronous method request - docName
- Type: SystemString
Name of the app to retrieve.
This parameter is mandatory. - userName (Optional)
- Type: SystemString
Name of the user that opens the app.
This parameter is optional. - password (Optional)
- Type: SystemString
Password of the user.
This parameter is optional. - serial (Optional)
- Type: SystemString
Current Qlik Sense serial number.
This parameter is optional. - noData (Optional)
- Type: SystemBoolean
Set this parameter to true to be able to open an app without loading its data.
When this parameter is set to true, the objects in the app are present but contain no data. The script can be edited and reloaded.
This parameter is optional and the default value is false.
Return Value
Type:
TaskAppSee Also