OpenAppAsync Method
Overloads
| OpenAppAsync(String, String, String, String, Boolean) |
Opens an app and checks if the app needs to be migrated (if the app is deprecated). The 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. BackupsIn Qlik Sense Desktop, apps are automatically backed up before a migration. The backup files are located in 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 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. BackupsIn Qlik Sense Desktop, apps are automatically backed up before a migration. The backup files are located in 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 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. BackupsIn Qlik Sense Desktop, apps are automatically backed up before a migration. The backup files are located in 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.
Declaration
[QixName("OpenDoc")]
Task<App> OpenAppAsync([QixName("qDocName")] string docName, [QixName("qUserName")] string userName = null, [QixName("qPassword")] string password = null, [QixName("qSerial")] string serial = null, [QixName("qNoData")] bool noData = false)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | docName |
The GUID (in Qlik Sense Enterprise) or Name (in Qlik Sense Desktop) of the app to retrieve. |
| System.String | userName |
Name of the user that opens the app. |
| System.String | password |
Password of the user. |
| System.String | serial |
Current Qlik Sense serial number. |
| System.Boolean | noData |
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. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<App> |
Remarks
If the app is read-only, the app migration cannot occur. An error message is sent.
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.
Declaration
[QixName("OpenDoc")]
Task<App> OpenAppAsync(AsyncHandle asyncHandle, [QixName("qDocName")] string docName, [QixName("qUserName")] string userName = null, [QixName("qPassword")] string password = null, [QixName("qSerial")] string serial = null, [QixName("qNoData")] bool noData = false)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | docName |
The GUID (in Qlik Sense Enterprise) or Name (in Qlik Sense Desktop) of the app to retrieve. |
| System.String | userName |
Name of the user that opens the app. |
| System.String | password |
Password of the user. |
| System.String | serial |
Current Qlik Sense serial number. |
| System.Boolean | noData |
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. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<App> |
Remarks
If the app is read-only, the app migration cannot occur. An error message is sent.
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.
Declaration
[QixName("OpenDoc")]
Task<T> OpenAppAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qDocName")] string docName, [QixName("qUserName")] string userName = null, [QixName("qPassword")] string password = null, [QixName("qSerial")] string serial = null, [QixName("qNoData")] bool noData = false)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | docName |
The GUID (in Qlik Sense Enterprise) or Name (in Qlik Sense Desktop) of the app to retrieve. |
| System.String | userName |
Name of the user that opens the app. |
| System.String | password |
Password of the user. |
| System.String | serial |
Current Qlik Sense serial number. |
| System.Boolean | noData |
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. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Remarks
If the app is read-only, the app migration cannot occur. An error message is sent.
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!