IHubCopyAppAsync Method (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.
Namespace: Qlik.EngineAssembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax Task<bool> CopyAppAsync(
string targetAppId,
string srcAppId,
IEnumerable<string> ids,
AsyncHandle asyncHandle = null
)
Function CopyAppAsync (
targetAppId As String,
srcAppId As String,
ids As IEnumerable(Of String),
Optional asyncHandle As AsyncHandle = Nothing
) As Task(Of Boolean)
Parameters
- targetAppId
- Type: SystemString
Identifier (GUID) of the app entity in the Qlik Sense repository.
The app entity must have been previously created by the repository (via the REST API).
This parameter is mandatory. - srcAppId
- Type: SystemString
Identifier (GUID) of the source app in the Qlik Sense repository.
This parameter is mandatory. - ids
- Type: System.Collections.GenericIEnumerableString
Array of QRS identifiers.
The list of all the objects in the app to be copied must be given. This list must contain the GUIDs of all these objects.
If the list of the QRS identifiers is empty, the method CopyApp copies only the database and the objects necessary to open the app. The objects that were created inside the app are not copied.
To get the QRS identifiers of the objects in an app, you can use the QRS API. The GET method (from the QRS API) returns the identifiers of the objects in the app.
The following example returns the QRS identifiers of all the objects in a specified app:
GET /qrs/app/9c3f8634-6191-4a34-a114-a39102058d13
Where
9c3f8634-6191-4a34-a114-a39102058d13 is the identifier of the app. - asyncHandle (Optional)
- Type: Qlik.EngineAsyncHandle
Handle to asyncronous method request
Return Value
Type:
TaskBooleanSee Also