App Class

App / Doc class

Inheritance

Implements

System.IDisposable
Namespace Qlik.Engine
Assembly Qlik.Engine.dll

Syntax

public class App : QixClassBase, IApp, IQixClassBase, IDisposable, IChangeNotifier

Constructors

App(Int32)

Declaration

public App(int handle)
Parameters
Type Name Description
System.Int32 handle

Methods

AbortModal(Boolean)

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Declaration

public void AbortModal([QixName("qAccept")] bool accept)
Parameters
Type Name Description
System.Boolean accept

Set this parameter to true to accept the selections before exiting the selection mode.

AbortModalAsync(AsyncHandle, Boolean)

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Declaration

public Task AbortModalAsync(AsyncHandle asyncHandle, [QixName("qAccept")] bool accept)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Boolean accept

Set this parameter to true to accept the selections before exiting the selection mode.

Returns
Type Description
System.Threading.Tasks.Task

AbortModalAsync(Boolean)

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Declaration

public Task AbortModalAsync([QixName("qAccept")] bool accept)
Parameters
Type Name Description
System.Boolean accept

Set this parameter to true to accept the selections before exiting the selection mode.

Returns
Type Description
System.Threading.Tasks.Task

AddAlternateState(String)

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Declaration

public void AddAlternateState([QixName("qStateName")] string stateName)
Parameters
Type Name Description
System.String stateName

Name of the alternate state.

AddAlternateStateAsync(AsyncHandle, String)

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Declaration

public Task AddAlternateStateAsync(AsyncHandle asyncHandle, [QixName("qStateName")] string stateName)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String stateName

Name of the alternate state.

Returns
Type Description
System.Threading.Tasks.Task

AddAlternateStateAsync(String)

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Declaration

public Task AddAlternateStateAsync([QixName("qStateName")] string stateName)
Parameters
Type Name Description
System.String stateName

Name of the alternate state.

Returns
Type Description
System.Threading.Tasks.Task

AddFieldFromExpression(String, String)

Adds a field on the fly.

Declaration

public bool AddFieldFromExpression([QixName("qName")] string name, [QixName("qExpr")] string expr)
Parameters
Type Name Description
System.String name

Name of the field.

System.String expr

Expression value. It is not possible to use all aggregation functions. For example, you cannot add a field on the fly with an expression that uses the Sum or Count aggregation functions.

Returns
Type Description
System.Boolean

AddFieldFromExpressionAsync(AsyncHandle, String, String)

Adds a field on the fly.

Declaration

public Task<bool> AddFieldFromExpressionAsync(AsyncHandle asyncHandle, [QixName("qName")] string name, [QixName("qExpr")] string expr)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String name

Name of the field.

System.String expr

Expression value. It is not possible to use all aggregation functions. For example, you cannot add a field on the fly with an expression that uses the Sum or Count aggregation functions.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

AddFieldFromExpressionAsync(String, String)

Adds a field on the fly.

Declaration

public Task<bool> AddFieldFromExpressionAsync([QixName("qName")] string name, [QixName("qExpr")] string expr)
Parameters
Type Name Description
System.String name

Name of the field.

System.String expr

Expression value. It is not possible to use all aggregation functions. For example, you cannot add a field on the fly with an expression that uses the Sum or Count aggregation functions.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

AddFieldFromExpressionAsync<T>(AsyncHandle, Func<Response, T>, String, String)

Adds a field on the fly.

Declaration

public Task<T> AddFieldFromExpressionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qName")] string name, [QixName("qExpr")] string expr)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String name

Name of the field.

System.String expr

Expression value. It is not possible to use all aggregation functions. For example, you cannot add a field on the fly with an expression that uses the Sum or Count aggregation functions.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

ApplyGenericBookmark(String)

Applies a bookmark.

Declaration

[QixName("ApplyBookmark")]
public bool ApplyGenericBookmark([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the bookmark.

Returns
Type Description
System.Boolean

ApplyGenericBookmarkAsync(AsyncHandle, String)

Applies a bookmark.

Declaration

[QixName("ApplyBookmark")]
public Task<bool> ApplyGenericBookmarkAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ApplyGenericBookmarkAsync(String)

Applies a bookmark.

Declaration

[QixName("ApplyBookmark")]
public Task<bool> ApplyGenericBookmarkAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ApplyGenericBookmarkAsync<T>(AsyncHandle, Func<Response, T>, String)

Applies a bookmark.

Declaration

[QixName("ApplyBookmark")]
public Task<T> ApplyGenericBookmarkAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

Back()

Loads the last logical operation (if any).

Declaration

public void Back()

BackAsync()

Loads the last logical operation (if any).

Declaration

public Task BackAsync()
Returns
Type Description
System.Threading.Tasks.Task

BackAsync(AsyncHandle)

Loads the last logical operation (if any).

Declaration

public Task BackAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task

BackCount()

Returns the number of entries on the back stack.

Declaration

[QixName("BackCount")]
public int BackCount()
Returns
Type Description
System.Int32

BackCountAsync()

Returns the number of entries on the back stack.

Declaration

[QixName("BackCount")]
public Task<int> BackCountAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

BackCountAsync(AsyncHandle)

Returns the number of entries on the back stack.

Declaration

[QixName("BackCount")]
public Task<int> BackCountAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

BackCountAsync<T>(AsyncHandle, Func<Response, T>)

Returns the number of entries on the back stack.

Declaration

[QixName("BackCount")]
public Task<T> BackCountAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CheckExpression(String, IEnumerable<String>)

Checks if a given expression is valid.

Declaration

public CheckExpressionResult CheckExpression([QixName("qExpr")] string expr, [QixName("qLabels")] IEnumerable<string> labels = null)
Parameters
Type Name Description
System.String expr

Expression to check.

System.Collections.Generic.IEnumerable<System.String> labels

List of labels.

Returns
Type Description
CheckExpressionResult

CheckExpressionAsync(AsyncHandle, String, IEnumerable<String>)

Checks if a given expression is valid.

Declaration

public Task<CheckExpressionResult> CheckExpressionAsync(AsyncHandle asyncHandle, [QixName("qExpr")] string expr, [QixName("qLabels")] IEnumerable<string> labels = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String expr

Expression to check.

System.Collections.Generic.IEnumerable<System.String> labels

List of labels.

Returns
Type Description
System.Threading.Tasks.Task<CheckExpressionResult>

CheckExpressionAsync(String, IEnumerable<String>)

Checks if a given expression is valid.

Declaration

public Task<CheckExpressionResult> CheckExpressionAsync([QixName("qExpr")] string expr, [QixName("qLabels")] IEnumerable<string> labels = null)
Parameters
Type Name Description
System.String expr

Expression to check.

System.Collections.Generic.IEnumerable<System.String> labels

List of labels.

Returns
Type Description
System.Threading.Tasks.Task<CheckExpressionResult>

CheckExpressionAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<String>)

Checks if a given expression is valid.

Declaration

public Task<T> CheckExpressionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qExpr")] string expr, [QixName("qLabels")] IEnumerable<string> labels = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String expr

Expression to check.

System.Collections.Generic.IEnumerable<System.String> labels

List of labels.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CheckNumberOrExpression(String)

Checks if:

  • A given expression is valid.
  • A number is correct according to the locale.

Declaration

public CheckNumberOrExpressionResult CheckNumberOrExpression([QixName("qExpr")] string expr)
Parameters
Type Name Description
System.String expr

Expression to check.

Returns

CheckNumberOrExpressionAsync(AsyncHandle, String)

Checks if:

  • A given expression is valid.
  • A number is correct according to the locale.

Declaration

public Task<CheckNumberOrExpressionResult> CheckNumberOrExpressionAsync(AsyncHandle asyncHandle, [QixName("qExpr")] string expr)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String expr

Expression to check.

Returns
Type Description
System.Threading.Tasks.Task<CheckNumberOrExpressionResult>

CheckNumberOrExpressionAsync(String)

Checks if:

  • A given expression is valid.
  • A number is correct according to the locale.

Declaration

public Task<CheckNumberOrExpressionResult> CheckNumberOrExpressionAsync([QixName("qExpr")] string expr)
Parameters
Type Name Description
System.String expr

Expression to check.

Returns
Type Description
System.Threading.Tasks.Task<CheckNumberOrExpressionResult>

CheckNumberOrExpressionAsync<T>(AsyncHandle, Func<Response, T>, String)

Checks if:

  • A given expression is valid.
  • A number is correct according to the locale.

Declaration

public Task<T> CheckNumberOrExpressionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qExpr")] string expr)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String expr

Expression to check.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CheckScriptSyntax()

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Declaration

public IEnumerable<ScriptSyntaxError> CheckScriptSyntax()
Returns
Type Description
System.Collections.Generic.IEnumerable<ScriptSyntaxError>

CheckScriptSyntaxAsync()

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Declaration

public Task<IEnumerable<ScriptSyntaxError>> CheckScriptSyntaxAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ScriptSyntaxError>>

CheckScriptSyntaxAsync(AsyncHandle)

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Declaration

public Task<IEnumerable<ScriptSyntaxError>> CheckScriptSyntaxAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ScriptSyntaxError>>

CheckScriptSyntaxAsync<T>(AsyncHandle, Func<Response, T>)

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Declaration

public Task<T> CheckScriptSyntaxAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

ClearAll(Boolean, String)

Clear selections in fields for current state. Locked fields are not cleared by default.

Declaration

public void ClearAll([QixName("qLockedAlso")] bool lockedAlso = false, [QixName("qStateName")] string stateName = null)
Parameters
Type Name Description
System.Boolean lockedAlso

When true, clears the selection for locked fields.

System.String stateName

Alternate state name. When set, applies to alternate state instead of current

ClearAllAsync(AsyncHandle, Boolean, String)

Clear selections in fields for current state. Locked fields are not cleared by default.

Declaration

public Task ClearAllAsync(AsyncHandle asyncHandle, [QixName("qLockedAlso")] bool lockedAlso = false, [QixName("qStateName")] string stateName = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Boolean lockedAlso

When true, clears the selection for locked fields.

System.String stateName

Alternate state name. When set, applies to alternate state instead of current

Returns
Type Description
System.Threading.Tasks.Task

ClearAllAsync(Boolean, String)

Clear selections in fields for current state. Locked fields are not cleared by default.

Declaration

public Task ClearAllAsync([QixName("qLockedAlso")] bool lockedAlso = false, [QixName("qStateName")] string stateName = null)
Parameters
Type Name Description
System.Boolean lockedAlso

When true, clears the selection for locked fields.

System.String stateName

Alternate state name. When set, applies to alternate state instead of current

Returns
Type Description
System.Threading.Tasks.Task

ClearUndoBuffer()

Clears entirely the undo and redo buffer.

Declaration

public void ClearUndoBuffer()

ClearUndoBufferAsync()

Clears entirely the undo and redo buffer.

Declaration

public Task ClearUndoBufferAsync()
Returns
Type Description
System.Threading.Tasks.Task

ClearUndoBufferAsync(AsyncHandle)

Clears entirely the undo and redo buffer.

Declaration

public Task ClearUndoBufferAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task

CloneGenericBookmark(String)

Clones a bookmark.

Declaration

[QixName("CloneBookmark")]
public string CloneGenericBookmark([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone.

Returns
Type Description
System.String

CloneGenericBookmarkAsync(AsyncHandle, String)

Clones a bookmark.

Declaration

[QixName("CloneBookmark")]
public Task<string> CloneGenericBookmarkAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericBookmarkAsync(String)

Clones a bookmark.

Declaration

[QixName("CloneBookmark")]
public Task<string> CloneGenericBookmarkAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericBookmarkAsync<T>(AsyncHandle, Func<Response, T>, String)

Clones a bookmark.

Declaration

[QixName("CloneBookmark")]
public Task<T> CloneGenericBookmarkAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CloneGenericDimension(String)

Clones a dimension.

Declaration

[QixName("CloneDimension")]
public string CloneGenericDimension([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone.

Returns
Type Description
System.String

CloneGenericDimensionAsync(AsyncHandle, String)

Clones a dimension.

Declaration

[QixName("CloneDimension")]
public Task<string> CloneGenericDimensionAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericDimensionAsync(String)

Clones a dimension.

Declaration

[QixName("CloneDimension")]
public Task<string> CloneGenericDimensionAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericDimensionAsync<T>(AsyncHandle, Func<Response, T>, String)

Clones a dimension.

Declaration

[QixName("CloneDimension")]
public Task<T> CloneGenericDimensionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CloneGenericMeasure(String)

Clones a measure.

Declaration

[QixName("CloneMeasure")]
public string CloneGenericMeasure([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone.

Returns
Type Description
System.String

CloneGenericMeasureAsync(AsyncHandle, String)

Clones a measure.

Declaration

[QixName("CloneMeasure")]
public Task<string> CloneGenericMeasureAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericMeasureAsync(String)

Clones a measure.

Declaration

[QixName("CloneMeasure")]
public Task<string> CloneGenericMeasureAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericMeasureAsync<T>(AsyncHandle, Func<Response, T>, String)

Clones a measure.

Declaration

[QixName("CloneMeasure")]
public Task<T> CloneGenericMeasureAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the object to clone.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CloneGenericObject(String)

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Declaration

[QixName("CloneObject")]
public string CloneGenericObject([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone. The identifier must be a root object.

Returns
Type Description
System.String

CloneGenericObjectAsync(AsyncHandle, String)

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Declaration

[QixName("CloneObject")]
public Task<string> CloneGenericObjectAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the object to clone. The identifier must be a root object.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericObjectAsync(String)

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Declaration

[QixName("CloneObject")]
public Task<string> CloneGenericObjectAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to clone. The identifier must be a root object.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CloneGenericObjectAsync<T>(AsyncHandle, Func<Response, T>, String)

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Declaration

[QixName("CloneObject")]
public Task<T> CloneGenericObjectAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the object to clone. The identifier must be a root object.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateBookmarkEx(GenericBookmarkProperties, IEnumerable<String>)

Creates a bookmark with softpatches.

Declaration

public CreateBookmarkExResult CreateBookmarkEx([QixName("qProp")] GenericBookmarkProperties prop, [QixName("qObjectIdsToPatch")] IEnumerable<string> objectIdsToPatch = null)
Parameters
Type Name Description
GenericBookmarkProperties prop

Properties for the object.

System.Collections.Generic.IEnumerable<System.String> objectIdsToPatch

Add softpatches for this objects if available. If empty all softpatches are added to the bookmark.

Returns
Type Description
CreateBookmarkExResult

CreateBookmarkExAsync(AsyncHandle, GenericBookmarkProperties, IEnumerable<String>)

Creates a bookmark with softpatches.

Declaration

public Task<CreateBookmarkExResult> CreateBookmarkExAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericBookmarkProperties prop, [QixName("qObjectIdsToPatch")] IEnumerable<string> objectIdsToPatch = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericBookmarkProperties prop

Properties for the object.

System.Collections.Generic.IEnumerable<System.String> objectIdsToPatch

Add softpatches for this objects if available. If empty all softpatches are added to the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<CreateBookmarkExResult>

CreateBookmarkExAsync(GenericBookmarkProperties, IEnumerable<String>)

Creates a bookmark with softpatches.

Declaration

public Task<CreateBookmarkExResult> CreateBookmarkExAsync([QixName("qProp")] GenericBookmarkProperties prop, [QixName("qObjectIdsToPatch")] IEnumerable<string> objectIdsToPatch = null)
Parameters
Type Name Description
GenericBookmarkProperties prop

Properties for the object.

System.Collections.Generic.IEnumerable<System.String> objectIdsToPatch

Add softpatches for this objects if available. If empty all softpatches are added to the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<CreateBookmarkExResult>

CreateBookmarkExAsync<T>(AsyncHandle, Func<Response, T>, GenericBookmarkProperties, IEnumerable<String>)

Creates a bookmark with softpatches.

Declaration

public Task<T> CreateBookmarkExAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericBookmarkProperties prop, [QixName("qObjectIdsToPatch")] IEnumerable<string> objectIdsToPatch = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericBookmarkProperties prop

Properties for the object.

System.Collections.Generic.IEnumerable<System.String> objectIdsToPatch

Add softpatches for this objects if available. If empty all softpatches are added to the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateConnection(Connection)

Creates a connection.

A connection indicates from which data source the data should be taken.

Declaration

public string CreateConnection([QixName("qConnection")] Connection connection)
Parameters
Type Name Description
Connection connection

Information about the connection.

Returns
Type Description
System.String

CreateConnectionAsync(AsyncHandle, Connection)

Creates a connection.

A connection indicates from which data source the data should be taken.

Declaration

public Task<string> CreateConnectionAsync(AsyncHandle asyncHandle, [QixName("qConnection")] Connection connection)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Connection connection

Information about the connection.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CreateConnectionAsync(Connection)

Creates a connection.

A connection indicates from which data source the data should be taken.

Declaration

public Task<string> CreateConnectionAsync([QixName("qConnection")] Connection connection)
Parameters
Type Name Description
Connection connection

Information about the connection.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

CreateConnectionAsync<T>(AsyncHandle, Func<Response, T>, Connection)

Creates a connection.

A connection indicates from which data source the data should be taken.

Declaration

public Task<T> CreateConnectionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnection")] Connection connection)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Connection connection

Information about the connection.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateGenericBookmark(GenericBookmarkProperties)

Creates a bookmark.

Declaration

[QixName("CreateBookmark")]
public CreateGenericBookmarkResult CreateGenericBookmark([QixName("qProp")] GenericBookmarkProperties prop)
Parameters
Type Name Description
GenericBookmarkProperties prop

Properties for the object.

Returns
Type Description
CreateGenericBookmarkResult

CreateGenericBookmarkAsync(AsyncHandle, GenericBookmarkProperties)

Creates a bookmark.

Declaration

[QixName("CreateBookmark")]
public Task<CreateGenericBookmarkResult> CreateGenericBookmarkAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericBookmarkProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericBookmarkProperties prop

Properties for the object.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericBookmarkResult>

CreateGenericBookmarkAsync(GenericBookmarkProperties)

Creates a bookmark.

Declaration

[QixName("CreateBookmark")]
public Task<CreateGenericBookmarkResult> CreateGenericBookmarkAsync([QixName("qProp")] GenericBookmarkProperties prop)
Parameters
Type Name Description
GenericBookmarkProperties prop

Properties for the object.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericBookmarkResult>

CreateGenericBookmarkAsync<T>(AsyncHandle, Func<Response, T>, GenericBookmarkProperties)

Creates a bookmark.

Declaration

[QixName("CreateBookmark")]
public Task<T> CreateGenericBookmarkAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericBookmarkProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericBookmarkProperties prop

Properties for the object.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateGenericDimension(GenericDimensionProperties)

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Declaration

[QixName("CreateDimension")]
public CreateGenericDimensionResult CreateGenericDimension([QixName("qProp")] GenericDimensionProperties prop)
Parameters
Type Name Description
GenericDimensionProperties prop

Information about the properties.

Returns
Type Description
CreateGenericDimensionResult

CreateGenericDimensionAsync(AsyncHandle, GenericDimensionProperties)

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Declaration

[QixName("CreateDimension")]
public Task<CreateGenericDimensionResult> CreateGenericDimensionAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericDimensionProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericDimensionProperties prop

Information about the properties.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericDimensionResult>

CreateGenericDimensionAsync(GenericDimensionProperties)

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Declaration

[QixName("CreateDimension")]
public Task<CreateGenericDimensionResult> CreateGenericDimensionAsync([QixName("qProp")] GenericDimensionProperties prop)
Parameters
Type Name Description
GenericDimensionProperties prop

Information about the properties.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericDimensionResult>

CreateGenericDimensionAsync<T>(AsyncHandle, Func<Response, T>, GenericDimensionProperties)

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Declaration

[QixName("CreateDimension")]
public Task<T> CreateGenericDimensionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericDimensionProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericDimensionProperties prop

Information about the properties.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateGenericMeasure(GenericMeasureProperties)

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Declaration

[QixName("CreateMeasure")]
public CreateGenericMeasureResult CreateGenericMeasure([QixName("qProp")] GenericMeasureProperties prop)
Parameters
Type Name Description
GenericMeasureProperties prop

Information about the properties.

Returns
Type Description
CreateGenericMeasureResult

CreateGenericMeasureAsync(AsyncHandle, GenericMeasureProperties)

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Declaration

[QixName("CreateMeasure")]
public Task<CreateGenericMeasureResult> CreateGenericMeasureAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericMeasureProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericMeasureProperties prop

Information about the properties.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericMeasureResult>

CreateGenericMeasureAsync(GenericMeasureProperties)

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Declaration

[QixName("CreateMeasure")]
public Task<CreateGenericMeasureResult> CreateGenericMeasureAsync([QixName("qProp")] GenericMeasureProperties prop)
Parameters
Type Name Description
GenericMeasureProperties prop

Information about the properties.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericMeasureResult>

CreateGenericMeasureAsync<T>(AsyncHandle, Func<Response, T>, GenericMeasureProperties)

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Declaration

[QixName("CreateMeasure")]
public Task<T> CreateGenericMeasureAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericMeasureProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericMeasureProperties prop

Information about the properties.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateGenericObject(GenericObjectProperties)

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateObject")]
public CreateGenericObjectResult CreateGenericObject([QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
GenericObjectProperties prop

Information about the object.

Returns
Type Description
CreateGenericObjectResult

CreateGenericObjectAsync(AsyncHandle, GenericObjectProperties)

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateObject")]
public Task<CreateGenericObjectResult> CreateGenericObjectAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericObjectProperties prop

Information about the object.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericObjectResult>

CreateGenericObjectAsync(GenericObjectProperties)

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateObject")]
public Task<CreateGenericObjectResult> CreateGenericObjectAsync([QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
GenericObjectProperties prop

Information about the object.

Returns
Type Description
System.Threading.Tasks.Task<CreateGenericObjectResult>

CreateGenericObjectAsync<T>(AsyncHandle, Func<Response, T>, GenericObjectProperties)

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateObject")]
public Task<T> CreateGenericObjectAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericObjectProperties prop

Information about the object.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateGenericSessionObject(GenericObjectProperties)

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateSessionObject")]
public GenericObject CreateGenericSessionObject([QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
GenericObjectProperties prop

Information about the object.

Returns
Type Description
GenericObject

CreateGenericSessionObjectAsync(AsyncHandle, GenericObjectProperties)

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateSessionObject")]
public Task<GenericObject> CreateGenericSessionObjectAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericObjectProperties prop

Information about the object.

Returns
Type Description
System.Threading.Tasks.Task<GenericObject>

CreateGenericSessionObjectAsync(GenericObjectProperties)

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateSessionObject")]
public Task<GenericObject> CreateGenericSessionObjectAsync([QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
GenericObjectProperties prop

Information about the object.

Returns
Type Description
System.Threading.Tasks.Task<GenericObject>

CreateGenericSessionObjectAsync<T>(AsyncHandle, Func<Response, T>, GenericObjectProperties)

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Declaration

[QixName("CreateSessionObject")]
public Task<T> CreateGenericSessionObjectAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericObjectProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericObjectProperties prop

Information about the object.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateSessionVariable(GenericVariableProperties)

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public GenericVariable CreateSessionVariable([QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
GenericVariableProperties prop

Name of the variable. Variable names are case sensitive.

Returns
Type Description
GenericVariable

CreateSessionVariableAsync(AsyncHandle, GenericVariableProperties)

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public Task<GenericVariable> CreateSessionVariableAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericVariableProperties prop

Name of the variable. Variable names are case sensitive.

Returns
Type Description
System.Threading.Tasks.Task<GenericVariable>

CreateSessionVariableAsync(GenericVariableProperties)

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public Task<GenericVariable> CreateSessionVariableAsync([QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
GenericVariableProperties prop

Name of the variable. Variable names are case sensitive.

Returns
Type Description
System.Threading.Tasks.Task<GenericVariable>

CreateSessionVariableAsync<T>(AsyncHandle, Func<Response, T>, GenericVariableProperties)

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public Task<T> CreateSessionVariableAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericVariableProperties prop

Name of the variable. Variable names are case sensitive.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

CreateVariableEx(GenericVariableProperties)

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public CreateVariableExResult CreateVariableEx([QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
GenericVariableProperties prop

Name of the variable. Variable names are case sensitive and must be unique.

Returns
Type Description
CreateVariableExResult

CreateVariableExAsync(AsyncHandle, GenericVariableProperties)

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public Task<CreateVariableExResult> CreateVariableExAsync(AsyncHandle asyncHandle, [QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

GenericVariableProperties prop

Name of the variable. Variable names are case sensitive and must be unique.

Returns
Type Description
System.Threading.Tasks.Task<CreateVariableExResult>

CreateVariableExAsync(GenericVariableProperties)

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public Task<CreateVariableExResult> CreateVariableExAsync([QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
GenericVariableProperties prop

Name of the variable. Variable names are case sensitive and must be unique.

Returns
Type Description
System.Threading.Tasks.Task<CreateVariableExResult>

CreateVariableExAsync<T>(AsyncHandle, Func<Response, T>, GenericVariableProperties)

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Declaration

public Task<T> CreateVariableExAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qProp")] GenericVariableProperties prop)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

GenericVariableProperties prop

Name of the variable. Variable names are case sensitive and must be unique.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DeleteConnection(String)

Deletes a connection.

Declaration

public void DeleteConnection([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection to remove.

DeleteConnectionAsync(AsyncHandle, String)

Deletes a connection.

Declaration

public Task DeleteConnectionAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection to remove.

Returns
Type Description
System.Threading.Tasks.Task

DeleteConnectionAsync(String)

Deletes a connection.

Declaration

public Task DeleteConnectionAsync([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection to remove.

Returns
Type Description
System.Threading.Tasks.Task

DestroyGenericBookmark(String)

Removes a bookmark.

Declaration

[QixName("DestroyBookmark")]
public bool DestroyGenericBookmark([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the bookmark.

Returns
Type Description
System.Boolean

DestroyGenericBookmarkAsync(AsyncHandle, String)

Removes a bookmark.

Declaration

[QixName("DestroyBookmark")]
public Task<bool> DestroyGenericBookmarkAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericBookmarkAsync(String)

Removes a bookmark.

Declaration

[QixName("DestroyBookmark")]
public Task<bool> DestroyGenericBookmarkAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericBookmarkAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a bookmark.

Declaration

[QixName("DestroyBookmark")]
public Task<T> DestroyGenericBookmarkAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroyGenericDimension(String)

Removes a dimension.

Declaration

[QixName("DestroyDimension")]
public bool DestroyGenericDimension([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the dimension to remove.

Returns
Type Description
System.Boolean

DestroyGenericDimensionAsync(AsyncHandle, String)

Removes a dimension.

Declaration

[QixName("DestroyDimension")]
public Task<bool> DestroyGenericDimensionAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the dimension to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericDimensionAsync(String)

Removes a dimension.

Declaration

[QixName("DestroyDimension")]
public Task<bool> DestroyGenericDimensionAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the dimension to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericDimensionAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a dimension.

Declaration

[QixName("DestroyDimension")]
public Task<T> DestroyGenericDimensionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the dimension to remove.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroyGenericMeasure(String)

Removes a generic measure.

Declaration

[QixName("DestroyMeasure")]
public bool DestroyGenericMeasure([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the measure to remove.

Returns
Type Description
System.Boolean

DestroyGenericMeasureAsync(AsyncHandle, String)

Removes a generic measure.

Declaration

[QixName("DestroyMeasure")]
public Task<bool> DestroyGenericMeasureAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the measure to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericMeasureAsync(String)

Removes a generic measure.

Declaration

[QixName("DestroyMeasure")]
public Task<bool> DestroyGenericMeasureAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the measure to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericMeasureAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a generic measure.

Declaration

[QixName("DestroyMeasure")]
public Task<T> DestroyGenericMeasureAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the measure to remove.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroyGenericObject(String)

Removes an app object.

The children of the object (if any) are removed as well.

Declaration

[QixName("DestroyObject")]
public bool DestroyGenericObject([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to remove.

Returns
Type Description
System.Boolean

DestroyGenericObjectAsync(AsyncHandle, String)

Removes an app object.

The children of the object (if any) are removed as well.

Declaration

[QixName("DestroyObject")]
public Task<bool> DestroyGenericObjectAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the object to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericObjectAsync(String)

Removes an app object.

The children of the object (if any) are removed as well.

Declaration

[QixName("DestroyObject")]
public Task<bool> DestroyGenericObjectAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericObjectAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes an app object.

The children of the object (if any) are removed as well.

Declaration

[QixName("DestroyObject")]
public Task<T> DestroyGenericObjectAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the object to remove.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroyGenericSessionObject(String)

Removes a transient object.

Declaration

[QixName("DestroySessionObject")]
public bool DestroyGenericSessionObject([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the transient object to remove.

Returns
Type Description
System.Boolean

DestroyGenericSessionObjectAsync(AsyncHandle, String)

Removes a transient object.

Declaration

[QixName("DestroySessionObject")]
public Task<bool> DestroyGenericSessionObjectAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the transient object to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericSessionObjectAsync(String)

Removes a transient object.

Declaration

[QixName("DestroySessionObject")]
public Task<bool> DestroyGenericSessionObjectAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the transient object to remove.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyGenericSessionObjectAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a transient object.

Declaration

[QixName("DestroySessionObject")]
public Task<T> DestroyGenericSessionObjectAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the transient object to remove.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroySessionVariable(String)

Removes a transient variable.

Declaration

public bool DestroySessionVariable([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the variable.

Returns
Type Description
System.Boolean

DestroySessionVariableAsync(AsyncHandle, String)

Removes a transient variable.

Declaration

public Task<bool> DestroySessionVariableAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroySessionVariableAsync(String)

Removes a transient variable.

Declaration

public Task<bool> DestroySessionVariableAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroySessionVariableAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a transient variable.

Declaration

public Task<T> DestroySessionVariableAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroySessionVariableById(String)

Removes a transient variable.

Declaration

public bool DestroySessionVariableById([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the variable.

Returns
Type Description
System.Boolean

DestroySessionVariableByIdAsync(AsyncHandle, String)

Removes a transient variable.

Declaration

public Task<bool> DestroySessionVariableByIdAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroySessionVariableByIdAsync(String)

Removes a transient variable.

Declaration

public Task<bool> DestroySessionVariableByIdAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroySessionVariableByIdAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a transient variable.

Declaration

public Task<T> DestroySessionVariableByIdAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroySessionVariableByName(String)

Removes a transient variable.

Declaration

public bool DestroySessionVariableByName([QixName("qName")] string name)
Parameters
Type Name Description
System.String name

Name of the variable.

Returns
Type Description
System.Boolean

DestroySessionVariableByNameAsync(AsyncHandle, String)

Removes a transient variable.

Declaration

public Task<bool> DestroySessionVariableByNameAsync(AsyncHandle asyncHandle, [QixName("qName")] string name)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String name

Name of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroySessionVariableByNameAsync(String)

Removes a transient variable.

Declaration

public Task<bool> DestroySessionVariableByNameAsync([QixName("qName")] string name)
Parameters
Type Name Description
System.String name

Name of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroySessionVariableByNameAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a transient variable.

Declaration

public Task<T> DestroySessionVariableByNameAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qName")] string name)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String name

Name of the variable.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroyVariableById(String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public bool DestroyVariableById([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the variable.

Returns
Type Description
System.Boolean

DestroyVariableByIdAsync(AsyncHandle, String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public Task<bool> DestroyVariableByIdAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyVariableByIdAsync(String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public Task<bool> DestroyVariableByIdAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyVariableByIdAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public Task<T> DestroyVariableByIdAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the variable.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DestroyVariableByName(String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public bool DestroyVariableByName([QixName("qName")] string name)
Parameters
Type Name Description
System.String name

Name of the variable.

Returns
Type Description
System.Boolean

DestroyVariableByNameAsync(AsyncHandle, String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public Task<bool> DestroyVariableByNameAsync(AsyncHandle asyncHandle, [QixName("qName")] string name)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String name

Name of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyVariableByNameAsync(String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public Task<bool> DestroyVariableByNameAsync([QixName("qName")] string name)
Parameters
Type Name Description
System.String name

Name of the variable.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DestroyVariableByNameAsync<T>(AsyncHandle, Func<Response, T>, String)

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Declaration

public Task<T> DestroyVariableByNameAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qName")] string name)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String name

Name of the variable.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Overrides

DoReload(Int32, Boolean, Boolean)

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Declaration

public bool DoReload([QixName("qMode")] int mode = 0, [QixName("qPartial")] bool partial = false, [QixName("qDebug")] bool debug = false)
Parameters
Type Name Description
System.Int32 mode

Error handling mode One of:

  • 0: for default mode.
  • 1: for ABEND; the reload of the script ends if an error occurs.
  • 2: for ignore; the reload of the script continues even if an error is detected in the script.
System.Boolean partial

Set to true for partial reload. The default value is false.

System.Boolean debug

Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode. The default value is false.

Returns
Type Description
System.Boolean

DoReloadAsync(AsyncHandle, Int32, Boolean, Boolean)

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Declaration

public Task<bool> DoReloadAsync(AsyncHandle asyncHandle, [QixName("qMode")] int mode = 0, [QixName("qPartial")] bool partial = false, [QixName("qDebug")] bool debug = false)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Int32 mode

Error handling mode One of:

  • 0: for default mode.
  • 1: for ABEND; the reload of the script ends if an error occurs.
  • 2: for ignore; the reload of the script continues even if an error is detected in the script.
System.Boolean partial

Set to true for partial reload. The default value is false.

System.Boolean debug

Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode. The default value is false.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DoReloadAsync(Int32, Boolean, Boolean)

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Declaration

public Task<bool> DoReloadAsync([QixName("qMode")] int mode = 0, [QixName("qPartial")] bool partial = false, [QixName("qDebug")] bool debug = false)
Parameters
Type Name Description
System.Int32 mode

Error handling mode One of:

  • 0: for default mode.
  • 1: for ABEND; the reload of the script ends if an error occurs.
  • 2: for ignore; the reload of the script continues even if an error is detected in the script.
System.Boolean partial

Set to true for partial reload. The default value is false.

System.Boolean debug

Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode. The default value is false.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

DoReloadAsync<T>(AsyncHandle, Func<Response, T>, Int32, Boolean, Boolean)

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Declaration

public Task<T> DoReloadAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qMode")] int mode = 0, [QixName("qPartial")] bool partial = false, [QixName("qDebug")] bool debug = false)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.Int32 mode

Error handling mode One of:

  • 0: for default mode.
  • 1: for ABEND; the reload of the script ends if an error occurs.
  • 2: for ignore; the reload of the script continues even if an error is detected in the script.
System.Boolean partial

Set to true for partial reload. The default value is false.

System.Boolean debug

Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode. The default value is false.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DoReloadEx(DoReloadExParams)

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Declaration

public DoReloadExResult DoReloadEx([QixName("qParams")] DoReloadExParams params = null)
Parameters
Type Name Description
DoReloadExParams params
Returns
Type Description
DoReloadExResult

DoReloadExAsync(AsyncHandle, DoReloadExParams)

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Declaration

public Task<DoReloadExResult> DoReloadExAsync(AsyncHandle asyncHandle, [QixName("qParams")] DoReloadExParams params = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

DoReloadExParams params
Returns
Type Description
System.Threading.Tasks.Task<DoReloadExResult>

DoReloadExAsync(DoReloadExParams)

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Declaration

public Task<DoReloadExResult> DoReloadExAsync([QixName("qParams")] DoReloadExParams params = null)
Parameters
Type Name Description
DoReloadExParams params
Returns
Type Description
System.Threading.Tasks.Task<DoReloadExResult>

DoReloadExAsync<T>(AsyncHandle, Func<Response, T>, DoReloadExParams)

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Declaration

public Task<T> DoReloadExAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qParams")] DoReloadExParams params = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

DoReloadExParams params
Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

DoSave(String)

Saves an app. All objects and data in the data model are saved.

Declaration

public void DoSave([QixName("qFileName")] string fileName = null)
Parameters
Type Name Description
System.String fileName

Name of the file to save.

DoSaveAsync(AsyncHandle, String)

Saves an app. All objects and data in the data model are saved.

Declaration

public Task DoSaveAsync(AsyncHandle asyncHandle, [QixName("qFileName")] string fileName = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String fileName

Name of the file to save.

Returns
Type Description
System.Threading.Tasks.Task

DoSaveAsync(String)

Saves an app. All objects and data in the data model are saved.

Declaration

public Task DoSaveAsync([QixName("qFileName")] string fileName = null)
Parameters
Type Name Description
System.String fileName

Name of the file to save.

Returns
Type Description
System.Threading.Tasks.Task

Evaluate(String)

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public string Evaluate([QixName("qExpression")] string expression)
Parameters
Type Name Description
System.String expression

Expression to evaluate.

Returns
Type Description
System.String

EvaluateAsync(AsyncHandle, String)

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public Task<string> EvaluateAsync(AsyncHandle asyncHandle, [QixName("qExpression")] string expression)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String expression

Expression to evaluate.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

EvaluateAsync(String)

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public Task<string> EvaluateAsync([QixName("qExpression")] string expression)
Parameters
Type Name Description
System.String expression

Expression to evaluate.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

EvaluateAsync<T>(AsyncHandle, Func<Response, T>, String)

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public Task<T> EvaluateAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qExpression")] string expression)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String expression

Expression to evaluate.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

EvaluateEx(String)

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public FieldValue EvaluateEx([QixName("qExpression")] string expression)
Parameters
Type Name Description
System.String expression

Expression to evaluate.

Returns
Type Description
FieldValue

EvaluateExAsync(AsyncHandle, String)

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public Task<FieldValue> EvaluateExAsync(AsyncHandle asyncHandle, [QixName("qExpression")] string expression)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String expression

Expression to evaluate.

Returns
Type Description
System.Threading.Tasks.Task<FieldValue>

EvaluateExAsync(String)

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public Task<FieldValue> EvaluateExAsync([QixName("qExpression")] string expression)
Parameters
Type Name Description
System.String expression

Expression to evaluate.

Returns
Type Description
System.Threading.Tasks.Task<FieldValue>

EvaluateExAsync<T>(AsyncHandle, Func<Response, T>, String)

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Declaration

public Task<T> EvaluateExAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qExpression")] string expression)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String expression

Expression to evaluate.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

ExpandExpression(String)

Expands the expression.

Declaration

public string ExpandExpression([QixName("qExpression")] string expression)
Parameters
Type Name Description
System.String expression

The expression string to expand.

Returns
Type Description
System.String

ExpandExpressionAsync(AsyncHandle, String)

Expands the expression.

Declaration

public Task<string> ExpandExpressionAsync(AsyncHandle asyncHandle, [QixName("qExpression")] string expression)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String expression

The expression string to expand.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

ExpandExpressionAsync(String)

Expands the expression.

Declaration

public Task<string> ExpandExpressionAsync([QixName("qExpression")] string expression)
Parameters
Type Name Description
System.String expression

The expression string to expand.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

ExpandExpressionAsync<T>(AsyncHandle, Func<Response, T>, String)

Expands the expression.

Declaration

public Task<T> ExpandExpressionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qExpression")] string expression)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String expression

The expression string to expand.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

ExportReducedData(NxDownloadOptions)

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Declaration

public NxDownloadInfo ExportReducedData([QixName("qOptions")] NxDownloadOptions options = null)
Parameters
Type Name Description
NxDownloadOptions options

BookmarkId used to reduced the app on and an expire time.

Returns
Type Description
NxDownloadInfo

ExportReducedDataAsync(AsyncHandle, NxDownloadOptions)

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Declaration

public Task<NxDownloadInfo> ExportReducedDataAsync(AsyncHandle asyncHandle, [QixName("qOptions")] NxDownloadOptions options = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

NxDownloadOptions options

BookmarkId used to reduced the app on and an expire time.

Returns
Type Description
System.Threading.Tasks.Task<NxDownloadInfo>

ExportReducedDataAsync(NxDownloadOptions)

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Declaration

public Task<NxDownloadInfo> ExportReducedDataAsync([QixName("qOptions")] NxDownloadOptions options = null)
Parameters
Type Name Description
NxDownloadOptions options

BookmarkId used to reduced the app on and an expire time.

Returns
Type Description
System.Threading.Tasks.Task<NxDownloadInfo>

ExportReducedDataAsync<T>(AsyncHandle, Func<Response, T>, NxDownloadOptions)

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Declaration

public Task<T> ExportReducedDataAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qOptions")] NxDownloadOptions options = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

NxDownloadOptions options

BookmarkId used to reduced the app on and an expire time.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

FindMatchingFields(String, IEnumerable<String>)

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Declaration

public IEnumerable<NxMatchingFieldInfo> FindMatchingFields([QixName("qFieldName")] string fieldName, [QixName("qTags")] IEnumerable<string> tags)
Parameters
Type Name Description
System.String fieldName

Name of the field. This method looks for fields that belong to the same archipelago as this specified field.

System.Collections.Generic.IEnumerable<System.String> tags

List of tags. This method looks for fields that match at least one of the tags in this list.

Returns
Type Description
System.Collections.Generic.IEnumerable<NxMatchingFieldInfo>

FindMatchingFieldsAsync(AsyncHandle, String, IEnumerable<String>)

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Declaration

public Task<IEnumerable<NxMatchingFieldInfo>> FindMatchingFieldsAsync(AsyncHandle asyncHandle, [QixName("qFieldName")] string fieldName, [QixName("qTags")] IEnumerable<string> tags)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String fieldName

Name of the field. This method looks for fields that belong to the same archipelago as this specified field.

System.Collections.Generic.IEnumerable<System.String> tags

List of tags. This method looks for fields that match at least one of the tags in this list.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxMatchingFieldInfo>>

FindMatchingFieldsAsync(String, IEnumerable<String>)

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Declaration

public Task<IEnumerable<NxMatchingFieldInfo>> FindMatchingFieldsAsync([QixName("qFieldName")] string fieldName, [QixName("qTags")] IEnumerable<string> tags)
Parameters
Type Name Description
System.String fieldName

Name of the field. This method looks for fields that belong to the same archipelago as this specified field.

System.Collections.Generic.IEnumerable<System.String> tags

List of tags. This method looks for fields that match at least one of the tags in this list.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxMatchingFieldInfo>>

FindMatchingFieldsAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<String>)

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Declaration

public Task<T> FindMatchingFieldsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qFieldName")] string fieldName, [QixName("qTags")] IEnumerable<string> tags)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String fieldName

Name of the field. This method looks for fields that belong to the same archipelago as this specified field.

System.Collections.Generic.IEnumerable<System.String> tags

List of tags. This method looks for fields that match at least one of the tags in this list.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

Forward()

Loads the next logical operation (if any).

Declaration

public void Forward()

ForwardAsync()

Loads the next logical operation (if any).

Declaration

public Task ForwardAsync()
Returns
Type Description
System.Threading.Tasks.Task

ForwardAsync(AsyncHandle)

Loads the next logical operation (if any).

Declaration

public Task ForwardAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task

ForwardCount()

Returns the number of entries on the Forward stack.

Declaration

[QixName("ForwardCount")]
public int ForwardCount()
Returns
Type Description
System.Int32

ForwardCountAsync()

Returns the number of entries on the Forward stack.

Declaration

[QixName("ForwardCount")]
public Task<int> ForwardCountAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

ForwardCountAsync(AsyncHandle)

Returns the number of entries on the Forward stack.

Declaration

[QixName("ForwardCount")]
public Task<int> ForwardCountAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

ForwardCountAsync<T>(AsyncHandle, Func<Response, T>)

Returns the number of entries on the Forward stack.

Declaration

[QixName("ForwardCount")]
public Task<T> ForwardCountAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetAllInfos()

Returns the identifier and the type of any generic object in the app.

Declaration

[QixName("GetAllInfos")]
public IEnumerable<NxInfo> GetAllInfos()
Returns
Type Description
System.Collections.Generic.IEnumerable<NxInfo>

GetAllInfosAsync()

Returns the identifier and the type of any generic object in the app.

Declaration

[QixName("GetAllInfos")]
public Task<IEnumerable<NxInfo>> GetAllInfosAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxInfo>>

GetAllInfosAsync(AsyncHandle)

Returns the identifier and the type of any generic object in the app.

Declaration

[QixName("GetAllInfos")]
public Task<IEnumerable<NxInfo>> GetAllInfosAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxInfo>>

GetAllInfosAsync<T>(AsyncHandle, Func<Response, T>)

Returns the identifier and the type of any generic object in the app.

Declaration

[QixName("GetAllInfos")]
public Task<T> GetAllInfosAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetAppLayout()

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Declaration

public NxAppLayout GetAppLayout()
Returns
Type Description
NxAppLayout

GetAppLayoutAsync()

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Declaration

public Task<NxAppLayout> GetAppLayoutAsync()
Returns
Type Description
System.Threading.Tasks.Task<NxAppLayout>

GetAppLayoutAsync(AsyncHandle)

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Declaration

public Task<NxAppLayout> GetAppLayoutAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<NxAppLayout>

GetAppLayoutAsync<T>(AsyncHandle, Func<Response, T>)

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Declaration

public Task<T> GetAppLayoutAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetAppProperties()

Gets the properties of an app.

Declaration

public NxAppProperties GetAppProperties()
Returns
Type Description
NxAppProperties

GetAppPropertiesAsync()

Gets the properties of an app.

Declaration

public Task<NxAppProperties> GetAppPropertiesAsync()
Returns
Type Description
System.Threading.Tasks.Task<NxAppProperties>

GetAppPropertiesAsync(AsyncHandle)

Gets the properties of an app.

Declaration

public Task<NxAppProperties> GetAppPropertiesAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<NxAppProperties>

GetAppPropertiesAsync<T>(AsyncHandle, Func<Response, T>)

Gets the properties of an app.

Declaration

public Task<T> GetAppPropertiesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetAssociationScores(String, String)

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Declaration

public IEnumerable<AssociationScore> GetAssociationScores([QixName("qTable1")] string table1, [QixName("qTable2")] string table2)
Parameters
Type Name Description
System.String table1

Name of the first table.

System.String table2

Name of the second table.

Returns
Type Description
System.Collections.Generic.IEnumerable<AssociationScore>

GetAssociationScoresAsync(AsyncHandle, String, String)

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Declaration

public Task<IEnumerable<AssociationScore>> GetAssociationScoresAsync(AsyncHandle asyncHandle, [QixName("qTable1")] string table1, [QixName("qTable2")] string table2)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String table1

Name of the first table.

System.String table2

Name of the second table.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<AssociationScore>>

GetAssociationScoresAsync(String, String)

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Declaration

public Task<IEnumerable<AssociationScore>> GetAssociationScoresAsync([QixName("qTable1")] string table1, [QixName("qTable2")] string table2)
Parameters
Type Name Description
System.String table1

Name of the first table.

System.String table2

Name of the second table.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<AssociationScore>>

GetAssociationScoresAsync<T>(AsyncHandle, Func<Response, T>, String, String)

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Declaration

public Task<T> GetAssociationScoresAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qTable1")] string table1, [QixName("qTable2")] string table2)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String table1

Name of the first table.

System.String table2

Name of the second table.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetBookmarks(NxGetBookmarkOptions)

Returns all bookmarks compatible with options.

Declaration

public IEnumerable<NxContainerEntry> GetBookmarks([QixName("qOptions")] NxGetBookmarkOptions options)
Parameters
Type Name Description
NxGetBookmarkOptions options

Bookmark type filter and requested properties.

Returns
Type Description
System.Collections.Generic.IEnumerable<NxContainerEntry>

GetBookmarksAsync(AsyncHandle, NxGetBookmarkOptions)

Returns all bookmarks compatible with options.

Declaration

public Task<IEnumerable<NxContainerEntry>> GetBookmarksAsync(AsyncHandle asyncHandle, [QixName("qOptions")] NxGetBookmarkOptions options)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

NxGetBookmarkOptions options

Bookmark type filter and requested properties.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxContainerEntry>>

GetBookmarksAsync(NxGetBookmarkOptions)

Returns all bookmarks compatible with options.

Declaration

public Task<IEnumerable<NxContainerEntry>> GetBookmarksAsync([QixName("qOptions")] NxGetBookmarkOptions options)
Parameters
Type Name Description
NxGetBookmarkOptions options

Bookmark type filter and requested properties.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxContainerEntry>>

GetBookmarksAsync<T>(AsyncHandle, Func<Response, T>, NxGetBookmarkOptions)

Returns all bookmarks compatible with options.

Declaration

public Task<T> GetBookmarksAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qOptions")] NxGetBookmarkOptions options)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

NxGetBookmarkOptions options

Bookmark type filter and requested properties.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetConnection(String)

Retrieves a connection and returns:

  • The creation time of the connection.
  • The identifier of the connection.
  • The type of the connection.
  • The name of the connection.
  • The connection string.

Declaration

public Connection GetConnection([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

Returns
Type Description
Connection

GetConnectionAsync(AsyncHandle, String)

Retrieves a connection and returns:

  • The creation time of the connection.
  • The identifier of the connection.
  • The type of the connection.
  • The name of the connection.
  • The connection string.

Declaration

public Task<Connection> GetConnectionAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

Returns
Type Description
System.Threading.Tasks.Task<Connection>

GetConnectionAsync(String)

Retrieves a connection and returns:

  • The creation time of the connection.
  • The identifier of the connection.
  • The type of the connection.
  • The name of the connection.
  • The connection string.

Declaration

public Task<Connection> GetConnectionAsync([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

Returns
Type Description
System.Threading.Tasks.Task<Connection>

GetConnectionAsync<T>(AsyncHandle, Func<Response, T>, String)

Retrieves a connection and returns:

  • The creation time of the connection.
  • The identifier of the connection.
  • The type of the connection.
  • The name of the connection.
  • The connection string.

Declaration

public Task<T> GetConnectionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetConnections()

Lists the connections in an app.

Declaration

public IEnumerable<Connection> GetConnections()
Returns
Type Description
System.Collections.Generic.IEnumerable<Connection>

GetConnectionsAsync()

Lists the connections in an app.

Declaration

public Task<IEnumerable<Connection>> GetConnectionsAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Connection>>

GetConnectionsAsync(AsyncHandle)

Lists the connections in an app.

Declaration

public Task<IEnumerable<Connection>> GetConnectionsAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Connection>>

GetConnectionsAsync<T>(AsyncHandle, Func<Response, T>)

Lists the connections in an app.

Declaration

public Task<T> GetConnectionsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetContentLibraries()

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

Declaration

public ContentLibraryList GetContentLibraries()
Returns
Type Description
ContentLibraryList

GetContentLibrariesAsync()

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

Declaration

public Task<ContentLibraryList> GetContentLibrariesAsync()
Returns
Type Description
System.Threading.Tasks.Task<ContentLibraryList>

GetContentLibrariesAsync(AsyncHandle)

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

Declaration

public Task<ContentLibraryList> GetContentLibrariesAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<ContentLibraryList>

GetContentLibrariesAsync<T>(AsyncHandle, Func<Response, T>)

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

Declaration

public Task<T> GetContentLibrariesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetDatabaseInfo(String)

Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.

Declaration

public DatabaseInfo GetDatabaseInfo([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Name of the connection.

Returns
Type Description
DatabaseInfo

GetDatabaseInfoAsync(AsyncHandle, String)

Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.

Declaration

public Task<DatabaseInfo> GetDatabaseInfoAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Name of the connection.

Returns
Type Description
System.Threading.Tasks.Task<DatabaseInfo>

GetDatabaseInfoAsync(String)

Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.

Declaration

public Task<DatabaseInfo> GetDatabaseInfoAsync([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Name of the connection.

Returns
Type Description
System.Threading.Tasks.Task<DatabaseInfo>

GetDatabaseInfoAsync<T>(AsyncHandle, Func<Response, T>, String)

Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.

Declaration

public Task<T> GetDatabaseInfoAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Name of the connection.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetDatabaseOwners(String, String)

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public IEnumerable<DatabaseOwner> GetDatabaseOwners([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database.

Returns
Type Description
System.Collections.Generic.IEnumerable<DatabaseOwner>

GetDatabaseOwnersAsync(AsyncHandle, String, String)

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<IEnumerable<DatabaseOwner>> GetDatabaseOwnersAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String database

Name of the database.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DatabaseOwner>>

GetDatabaseOwnersAsync(String, String)

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<IEnumerable<DatabaseOwner>> GetDatabaseOwnersAsync([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DatabaseOwner>>

GetDatabaseOwnersAsync<T>(AsyncHandle, Func<Response, T>, String, String)

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<T> GetDatabaseOwnersAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String database

Name of the database.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetDatabases(String)

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

Declaration

public IEnumerable<Database> GetDatabases([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

Returns
Type Description
System.Collections.Generic.IEnumerable<Database>

GetDatabasesAsync(AsyncHandle, String)

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

Declaration

public Task<IEnumerable<Database>> GetDatabasesAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Database>>

GetDatabasesAsync(String)

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

Declaration

public Task<IEnumerable<Database>> GetDatabasesAsync([QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Database>>

GetDatabasesAsync<T>(AsyncHandle, Func<Response, T>, String)

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

Declaration

public Task<T> GetDatabasesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetDatabaseTableFields(String, String, String, String)

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public IEnumerable<DataField> GetDatabaseTableFields([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

Returns
Type Description
System.Collections.Generic.IEnumerable<DataField>

GetDatabaseTableFieldsAsync(AsyncHandle, String, String, String, String)

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<IEnumerable<DataField>> GetDatabaseTableFieldsAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataField>>

GetDatabaseTableFieldsAsync(String, String, String, String)

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<IEnumerable<DataField>> GetDatabaseTableFieldsAsync([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataField>>

GetDatabaseTableFieldsAsync<T>(AsyncHandle, Func<Response, T>, String, String, String, String)

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<T> GetDatabaseTableFieldsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetDatabaseTablePreview(String, String, String, String, FilterInfo)

Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public GetDatabaseTablePreviewResult GetDatabaseTablePreview([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table, [QixName("qConditions")] FilterInfo conditions = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

FilterInfo conditions
Returns

GetDatabaseTablePreviewAsync(AsyncHandle, String, String, String, String, FilterInfo)

Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<GetDatabaseTablePreviewResult> GetDatabaseTablePreviewAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table, [QixName("qConditions")] FilterInfo conditions = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

FilterInfo conditions
Returns
Type Description
System.Threading.Tasks.Task<GetDatabaseTablePreviewResult>

GetDatabaseTablePreviewAsync(String, String, String, String, FilterInfo)

Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<GetDatabaseTablePreviewResult> GetDatabaseTablePreviewAsync([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table, [QixName("qConditions")] FilterInfo conditions = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

FilterInfo conditions
Returns
Type Description
System.Threading.Tasks.Task<GetDatabaseTablePreviewResult>

GetDatabaseTablePreviewAsync<T>(AsyncHandle, Func<Response, T>, String, String, String, String, FilterInfo)

Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<T> GetDatabaseTablePreviewAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null, [QixName("qTable")] string table, [QixName("qConditions")] FilterInfo conditions = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

System.String table

Name of the table.

FilterInfo conditions
Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetDatabaseTables(String, String, String)

Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public IEnumerable<DataTable> GetDatabaseTables([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

Returns
Type Description
System.Collections.Generic.IEnumerable<DataTable>

GetDatabaseTablesAsync(AsyncHandle, String, String, String)

Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<IEnumerable<DataTable>> GetDatabaseTablesAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataTable>>

GetDatabaseTablesAsync(String, String, String)

Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<IEnumerable<DataTable>> GetDatabaseTablesAsync([QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataTable>>

GetDatabaseTablesAsync<T>(AsyncHandle, Func<Response, T>, String, String, String)

Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

Declaration

public Task<T> GetDatabaseTablesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qDatabase")] string database = null, [QixName("qOwner")] string owner = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String database

Name of the database. If qDatabase is not set then qOwner must be set.

System.String owner

Owner of the database. If qOwner is not set then qDatabase must be set.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetEmptyScript(String)

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Declaration

public string GetEmptyScript([QixName("qLocalizedMainSection")] string localizedMainSection = null)
Parameters
Type Name Description
System.String localizedMainSection

Name of the script section. The default value is Main .

Returns
Type Description
System.String

GetEmptyScriptAsync(AsyncHandle, String)

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Declaration

public Task<string> GetEmptyScriptAsync(AsyncHandle asyncHandle, [QixName("qLocalizedMainSection")] string localizedMainSection = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String localizedMainSection

Name of the script section. The default value is Main .

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetEmptyScriptAsync(String)

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Declaration

public Task<string> GetEmptyScriptAsync([QixName("qLocalizedMainSection")] string localizedMainSection = null)
Parameters
Type Name Description
System.String localizedMainSection

Name of the script section. The default value is Main .

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetEmptyScriptAsync<T>(AsyncHandle, Func<Response, T>, String)

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Declaration

public Task<T> GetEmptyScriptAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qLocalizedMainSection")] string localizedMainSection = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String localizedMainSection

Name of the script section. The default value is Main .

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFavoriteVariables()

Retrieves the variables that are tagged as favorite.

Declaration

public IEnumerable<string> GetFavoriteVariables()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

GetFavoriteVariablesAsync()

Retrieves the variables that are tagged as favorite.

Declaration

public Task<IEnumerable<string>> GetFavoriteVariablesAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.String>>

GetFavoriteVariablesAsync(AsyncHandle)

Retrieves the variables that are tagged as favorite.

Declaration

public Task<IEnumerable<string>> GetFavoriteVariablesAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.String>>

GetFavoriteVariablesAsync<T>(AsyncHandle, Func<Response, T>)

Retrieves the variables that are tagged as favorite.

Declaration

public Task<T> GetFavoriteVariablesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetField(String, String)

Returns a handle to a field.

Declaration

public Field GetField([QixName("qFieldName")] string fieldName, [QixName("qStateName")] string stateName = null)
Parameters
Type Name Description
System.String fieldName

Name of the field.

System.String stateName

Name of the alternate state. Default state is current selections.

Returns
Type Description
Field

GetFieldAndColumnSamples(IEnumerable<FieldOrColumn>, Int32, Int32)

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Declaration

public IEnumerable<SampleResult> GetFieldAndColumnSamples([QixName("qFieldsOrColumnsWithWildcards")] IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards, [QixName("qMaxNumberOfValues")] int maxNumberOfValues, [QixName("qRandSeed")] int randSeed = 0)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards

Pairs of table (optionally) and field names. Support wildcard matches.

System.Int32 maxNumberOfValues

Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned.

System.Int32 randSeed

Optional. Sets the random number seed. Should only be set for test purposes.

Returns
Type Description
System.Collections.Generic.IEnumerable<SampleResult>

GetFieldAndColumnSamplesAsync(AsyncHandle, IEnumerable<FieldOrColumn>, Int32, Int32)

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Declaration

public Task<IEnumerable<SampleResult>> GetFieldAndColumnSamplesAsync(AsyncHandle asyncHandle, [QixName("qFieldsOrColumnsWithWildcards")] IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards, [QixName("qMaxNumberOfValues")] int maxNumberOfValues, [QixName("qRandSeed")] int randSeed = 0)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Collections.Generic.IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards

Pairs of table (optionally) and field names. Support wildcard matches.

System.Int32 maxNumberOfValues

Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned.

System.Int32 randSeed

Optional. Sets the random number seed. Should only be set for test purposes.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<SampleResult>>

GetFieldAndColumnSamplesAsync(IEnumerable<FieldOrColumn>, Int32, Int32)

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Declaration

public Task<IEnumerable<SampleResult>> GetFieldAndColumnSamplesAsync([QixName("qFieldsOrColumnsWithWildcards")] IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards, [QixName("qMaxNumberOfValues")] int maxNumberOfValues, [QixName("qRandSeed")] int randSeed = 0)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards

Pairs of table (optionally) and field names. Support wildcard matches.

System.Int32 maxNumberOfValues

Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned.

System.Int32 randSeed

Optional. Sets the random number seed. Should only be set for test purposes.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<SampleResult>>

GetFieldAndColumnSamplesAsync<T>(AsyncHandle, Func<Response, T>, IEnumerable<FieldOrColumn>, Int32, Int32)

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Declaration

public Task<T> GetFieldAndColumnSamplesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qFieldsOrColumnsWithWildcards")] IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards, [QixName("qMaxNumberOfValues")] int maxNumberOfValues, [QixName("qRandSeed")] int randSeed = 0)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.Collections.Generic.IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards

Pairs of table (optionally) and field names. Support wildcard matches.

System.Int32 maxNumberOfValues

Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned.

System.Int32 randSeed

Optional. Sets the random number seed. Should only be set for test purposes.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFieldAsync(AsyncHandle, String, String)

Returns a handle to a field.

Declaration

public Task<Field> GetFieldAsync(AsyncHandle asyncHandle, [QixName("qFieldName")] string fieldName, [QixName("qStateName")] string stateName = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String fieldName

Name of the field.

System.String stateName

Name of the alternate state. Default state is current selections.

Returns
Type Description
System.Threading.Tasks.Task<Field>

GetFieldAsync(String, String)

Returns a handle to a field.

Declaration

public Task<Field> GetFieldAsync([QixName("qFieldName")] string fieldName, [QixName("qStateName")] string stateName = null)
Parameters
Type Name Description
System.String fieldName

Name of the field.

System.String stateName

Name of the alternate state. Default state is current selections.

Returns
Type Description
System.Threading.Tasks.Task<Field>

GetFieldAsync<T>(AsyncHandle, Func<Response, T>, String, String)

Returns a handle to a field.

Declaration

public Task<T> GetFieldAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qFieldName")] string fieldName, [QixName("qStateName")] string stateName = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String fieldName

Name of the field.

System.String stateName

Name of the alternate state. Default state is current selections.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFieldDescription(String)

Returns the description of a field.

Declaration

public FieldDescription GetFieldDescription([QixName("qFieldName")] string fieldName)
Parameters
Type Name Description
System.String fieldName

Name of the field.

Returns
Type Description
FieldDescription

GetFieldDescriptionAsync(AsyncHandle, String)

Returns the description of a field.

Declaration

public Task<FieldDescription> GetFieldDescriptionAsync(AsyncHandle asyncHandle, [QixName("qFieldName")] string fieldName)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String fieldName

Name of the field.

Returns
Type Description
System.Threading.Tasks.Task<FieldDescription>

GetFieldDescriptionAsync(String)

Returns the description of a field.

Declaration

public Task<FieldDescription> GetFieldDescriptionAsync([QixName("qFieldName")] string fieldName)
Parameters
Type Name Description
System.String fieldName

Name of the field.

Returns
Type Description
System.Threading.Tasks.Task<FieldDescription>

GetFieldDescriptionAsync<T>(AsyncHandle, Func<Response, T>, String)

Returns the description of a field.

Declaration

public Task<T> GetFieldDescriptionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qFieldName")] string fieldName)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String fieldName

Name of the field.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFieldOnTheFlyByName(String)

Find the field-on-the-fly by passing its readable name.

Declaration

public string GetFieldOnTheFlyByName([QixName("qReadableName")] string readableName)
Parameters
Type Name Description
System.String readableName

Readable name of the field-on-the-fly.

Returns
Type Description
System.String

GetFieldOnTheFlyByNameAsync(AsyncHandle, String)

Find the field-on-the-fly by passing its readable name.

Declaration

public Task<string> GetFieldOnTheFlyByNameAsync(AsyncHandle asyncHandle, [QixName("qReadableName")] string readableName)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String readableName

Readable name of the field-on-the-fly.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetFieldOnTheFlyByNameAsync(String)

Find the field-on-the-fly by passing its readable name.

Declaration

public Task<string> GetFieldOnTheFlyByNameAsync([QixName("qReadableName")] string readableName)
Parameters
Type Name Description
System.String readableName

Readable name of the field-on-the-fly.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetFieldOnTheFlyByNameAsync<T>(AsyncHandle, Func<Response, T>, String)

Find the field-on-the-fly by passing its readable name.

Declaration

public Task<T> GetFieldOnTheFlyByNameAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qReadableName")] string readableName)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String readableName

Readable name of the field-on-the-fly.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFileTableFields(String, String, FileDataFormat, String)

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public GetFileTableFieldsResult GetFileTableFields([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
GetFileTableFieldsResult

GetFileTableFieldsAsync(AsyncHandle, String, String, FileDataFormat, String)

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<GetFileTableFieldsResult> GetFileTableFieldsAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
System.Threading.Tasks.Task<GetFileTableFieldsResult>

GetFileTableFieldsAsync(String, String, FileDataFormat, String)

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<GetFileTableFieldsResult> GetFileTableFieldsAsync([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
System.Threading.Tasks.Task<GetFileTableFieldsResult>

GetFileTableFieldsAsync<T>(AsyncHandle, Func<Response, T>, String, String, FileDataFormat, String)

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<T> GetFileTableFieldsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFileTablePreview(String, String, FileDataFormat, String)

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public GetFileTablePreviewResult GetFileTablePreview([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
GetFileTablePreviewResult

GetFileTablePreviewAsync(AsyncHandle, String, String, FileDataFormat, String)

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<GetFileTablePreviewResult> GetFileTablePreviewAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
System.Threading.Tasks.Task<GetFileTablePreviewResult>

GetFileTablePreviewAsync(String, String, FileDataFormat, String)

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<GetFileTablePreviewResult> GetFileTablePreviewAsync([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
System.Threading.Tasks.Task<GetFileTablePreviewResult>

GetFileTablePreviewAsync<T>(AsyncHandle, Func<Response, T>, String, String, FileDataFormat, String)

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<T> GetFileTablePreviewAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

System.String table

Name of the table. This parameter must be set for XLS , XLSX , HTML and XML files.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFileTables(String, String, FileDataFormat)

Lists the tables for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public IEnumerable<DataTable> GetFileTables([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Collections.Generic.IEnumerable<DataTable>

GetFileTablesAsync(AsyncHandle, String, String, FileDataFormat)

Lists the tables for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<IEnumerable<DataTable>> GetFileTablesAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataTable>>

GetFileTablesAsync(String, String, FileDataFormat)

Lists the tables for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<IEnumerable<DataTable>> GetFileTablesAsync([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataTable>>

GetFileTablesAsync<T>(AsyncHandle, Func<Response, T>, String, String, FileDataFormat)

Lists the tables for a folder connection.

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file

Declaration

public Task<T> GetFileTablesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFileTablesEx(String, String, FileDataFormat)

Lists the tables and fields of a JSON or XML file for a folder connection.

Declaration

public IEnumerable<DataTableEx> GetFileTablesEx([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Collections.Generic.IEnumerable<DataTableEx>

GetFileTablesExAsync(AsyncHandle, String, String, FileDataFormat)

Lists the tables and fields of a JSON or XML file for a folder connection.

Declaration

public Task<IEnumerable<DataTableEx>> GetFileTablesExAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataTableEx>>

GetFileTablesExAsync(String, String, FileDataFormat)

Lists the tables and fields of a JSON or XML file for a folder connection.

Declaration

public Task<IEnumerable<DataTableEx>> GetFileTablesExAsync([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<DataTableEx>>

GetFileTablesExAsync<T>(AsyncHandle, Func<Response, T>, String, String, FileDataFormat)

Lists the tables and fields of a JSON or XML file for a folder connection.

Declaration

public Task<T> GetFileTablesExAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String relativePath

Path of the connection file.

FileDataFormat dataFormat

Type of the file.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetFolderItemsForConnection(String, String)

Lists the items for a folder connection.

Declaration

public IEnumerable<FolderItem> GetFolderItemsForConnection([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Relative path of the connection.

Returns
Type Description
System.Collections.Generic.IEnumerable<FolderItem>

GetFolderItemsForConnectionAsync(AsyncHandle, String, String)

Lists the items for a folder connection.

Declaration

public Task<IEnumerable<FolderItem>> GetFolderItemsForConnectionAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String connectionId

Identifier of the connection.

System.String relativePath

Relative path of the connection.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<FolderItem>>

GetFolderItemsForConnectionAsync(String, String)

Lists the items for a folder connection.

Declaration

public Task<IEnumerable<FolderItem>> GetFolderItemsForConnectionAsync([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null)
Parameters
Type Name Description
System.String connectionId

Identifier of the connection.

System.String relativePath

Relative path of the connection.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<FolderItem>>

GetFolderItemsForConnectionAsync<T>(AsyncHandle, Func<Response, T>, String, String)

Lists the items for a folder connection.

Declaration

public Task<T> GetFolderItemsForConnectionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String connectionId

Identifier of the connection.

System.String relativePath

Relative path of the connection.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetGenericBookmark(String)

Returns the handle of a bookmark.

Declaration

[QixName("GetBookmark")]
public GenericBookmark GetGenericBookmark([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the bookmark.

Returns
Type Description
GenericBookmark

GetGenericBookmarkAsync(AsyncHandle, String)

Returns the handle of a bookmark.

Declaration

public Task<GenericBookmark> GetGenericBookmarkAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<GenericBookmark>

GetGenericBookmarkAsync(String)

Returns the handle of a bookmark.

Declaration

[QixName("GetBookmark")]
public Task<GenericBookmark> GetGenericBookmarkAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<GenericBookmark>

GetGenericBookmarkAsync<T>(AsyncHandle, Func<Response, T>, String)

Returns the handle of a bookmark.

Declaration

[QixName("GetBookmark")]
public Task<T> GetGenericBookmarkAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the bookmark.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetGenericDimension(String)

Returns the handle of a dimension.

Declaration

[QixName("GetDimension")]
public GenericDimension GetGenericDimension([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the dimension.

Returns
Type Description
GenericDimension

GetGenericDimensionAsync(AsyncHandle, String)

Returns the handle of a dimension.

Declaration

public Task<GenericDimension> GetGenericDimensionAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the dimension This parameter is mandatory

Returns
Type Description
System.Threading.Tasks.Task<GenericDimension>

GetGenericDimensionAsync(String)

Returns the handle of a dimension.

Declaration

[QixName("GetDimension")]
public Task<GenericDimension> GetGenericDimensionAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the dimension.

Returns
Type Description
System.Threading.Tasks.Task<GenericDimension>

GetGenericDimensionAsync<T>(AsyncHandle, Func<Response, T>, String)

Returns the handle of a dimension.

Declaration

[QixName("GetDimension")]
public Task<T> GetGenericDimensionAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the dimension.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetGenericMeasure(String)

Returns the handle of a measure.

Declaration

[QixName("GetMeasure")]
public GenericMeasure GetGenericMeasure([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the measure.

Returns
Type Description
GenericMeasure

GetGenericMeasureAsync(AsyncHandle, String)

Returns the handle of a measure.

Declaration

public Task<GenericMeasure> GetGenericMeasureAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the measure. This parameter is mandatory.

Returns
Type Description
System.Threading.Tasks.Task<GenericMeasure>

GetGenericMeasureAsync(String)

Returns the handle of a measure.

Declaration

[QixName("GetMeasure")]
public Task<GenericMeasure> GetGenericMeasureAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the measure.

Returns
Type Description
System.Threading.Tasks.Task<GenericMeasure>

GetGenericMeasureAsync<T>(AsyncHandle, Func<Response, T>, String)

Returns the handle of a measure.

Declaration

[QixName("GetMeasure")]
public Task<T> GetGenericMeasureAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the measure.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetGenericObject(String)

Returns the type of the app object and the corresponding handle.

Declaration

[QixName("GetObject")]
public GenericObject GetGenericObject([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to retrieve.

Returns
Type Description
GenericObject

GetGenericObjectAsync(AsyncHandle, String)

Returns the type of the app object and the corresponding handle.

Declaration

public Task<GenericObject> GetGenericObjectAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String id

Identifier of the object to retrieve. This parameter is mandatory.

Returns
Type Description
System.Threading.Tasks.Task<GenericObject>

GetGenericObjectAsync(String)

Returns the type of the app object and the corresponding handle.

Declaration

[QixName("GetObject")]
public Task<GenericObject> GetGenericObjectAsync([QixName("qId")] string id)
Parameters
Type Name Description
System.String id

Identifier of the object to retrieve.

Returns
Type Description
System.Threading.Tasks.Task<GenericObject>

GetGenericObjectAsync<T>(AsyncHandle, Func<Response, T>, String)

Returns the type of the app object and the corresponding handle.

Declaration

[QixName("GetObject")]
public Task<T> GetGenericObjectAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String id

Identifier of the object to retrieve.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetIncludeFileContent(String)

Gets the content of a file.

Declaration

public string GetIncludeFileContent([QixName("qPath")] string path)
Parameters
Type Name Description
System.String path

["lib: OR ["lib: [ ] should be used when the first variable contains a lib reference.

Returns
Type Description
System.String

GetIncludeFileContentAsync(AsyncHandle, String)

Gets the content of a file.

Declaration

public Task<string> GetIncludeFileContentAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String path

["lib: OR ["lib: [ ] should be used when the first variable contains a lib reference.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetIncludeFileContentAsync(String)

Gets the content of a file.

Declaration

public Task<string> GetIncludeFileContentAsync([QixName("qPath")] string path)
Parameters
Type Name Description
System.String path

["lib: OR ["lib: [ ] should be used when the first variable contains a lib reference.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetIncludeFileContentAsync<T>(AsyncHandle, Func<Response, T>, String)

Gets the content of a file.

Declaration

public Task<T> GetIncludeFileContentAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qPath")] string path)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String path

["lib: OR ["lib: [ ] should be used when the first variable contains a lib reference.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetLibraryContent(String)

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Declaration

public StaticContentList GetLibraryContent([QixName("qName")] string name)
Parameters
Type Name Description
System.String name

Name of the content library. It corresponds to the property qContentLibraryListItem/qName returned by the GetContentLibraries method.

Returns
Type Description
StaticContentList

GetLibraryContentAsync(AsyncHandle, String)

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Declaration

public Task<StaticContentList> GetLibraryContentAsync(AsyncHandle asyncHandle, [QixName("qName")] string name)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String name

Name of the content library. It corresponds to the property qContentLibraryListItem/qName returned by the GetContentLibraries method.

Returns
Type Description
System.Threading.Tasks.Task<StaticContentList>

GetLibraryContentAsync(String)

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Declaration

public Task<StaticContentList> GetLibraryContentAsync([QixName("qName")] string name)
Parameters
Type Name Description
System.String name

Name of the content library. It corresponds to the property qContentLibraryListItem/qName returned by the GetContentLibraries method.

Returns
Type Description
System.Threading.Tasks.Task<StaticContentList>

GetLibraryContentAsync<T>(AsyncHandle, Func<Response, T>, String)

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Declaration

public Task<T> GetLibraryContentAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qName")] string name)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String name

Name of the content library. It corresponds to the property qContentLibraryListItem/qName returned by the GetContentLibraries method.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetLineage()

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Declaration

public IEnumerable<LineageInfo> GetLineage()
Returns
Type Description
System.Collections.Generic.IEnumerable<LineageInfo>

GetLineageAsync()

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Declaration

public Task<IEnumerable<LineageInfo>> GetLineageAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<LineageInfo>>

GetLineageAsync(AsyncHandle)

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Declaration

public Task<IEnumerable<LineageInfo>> GetLineageAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<LineageInfo>>

GetLineageAsync<T>(AsyncHandle, Func<Response, T>)

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Declaration

public Task<T> GetLineageAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetLocaleInfo()

Returns locale information.

Declaration

public LocaleInfo GetLocaleInfo()
Returns
Type Description
LocaleInfo

GetLocaleInfoAsync()

Returns locale information.

Declaration

public Task<LocaleInfo> GetLocaleInfoAsync()
Returns
Type Description
System.Threading.Tasks.Task<LocaleInfo>

GetLocaleInfoAsync(AsyncHandle)

Returns locale information.

Declaration

public Task<LocaleInfo> GetLocaleInfoAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<LocaleInfo>

GetLocaleInfoAsync<T>(AsyncHandle, Func<Response, T>)

Returns locale information.

Declaration

public Task<T> GetLocaleInfoAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetLooselyCoupledVector()

Returns a list of table states.

The following states apply:

  • 0 The table is not loosely coupled.
  • 1 The table is loosely coupled.
  • 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Declaration

public IEnumerable<byte> GetLooselyCoupledVector()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Byte>

GetLooselyCoupledVectorAsync()

Returns a list of table states.

The following states apply:

  • 0 The table is not loosely coupled.
  • 1 The table is loosely coupled.
  • 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Declaration

public Task<IEnumerable<byte>> GetLooselyCoupledVectorAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Byte>>

GetLooselyCoupledVectorAsync(AsyncHandle)

Returns a list of table states.

The following states apply:

  • 0 The table is not loosely coupled.
  • 1 The table is loosely coupled.
  • 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Declaration

public Task<IEnumerable<byte>> GetLooselyCoupledVectorAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Byte>>

GetLooselyCoupledVectorAsync<T>(AsyncHandle, Func<Response, T>)

Returns a list of table states.

The following states apply:

  • 0 The table is not loosely coupled.
  • 1 The table is loosely coupled.
  • 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Declaration

public Task<T> GetLooselyCoupledVectorAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetMatchingFields(IEnumerable<String>, NxMatchingFieldMode)

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Declaration

public IEnumerable<NxMatchingFieldInfo> GetMatchingFields([QixName("qTags")] IEnumerable<string> tags, [QixName("qMatchingFieldMode")] NxMatchingFieldMode matchingFieldMode = NxMatchingFieldMode.MATCHINGFIELDMODE_MATCH_ALL)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> tags

List of tags. The GetMatchingFields method looks for fields that match one or all of the tags in this list, depending on the value of qMatchingFieldMode .

NxMatchingFieldMode matchingFieldMode

Matching field mode. The default value is MATCHINGFIELDMODE_MATCH_ALL.

Returns
Type Description
System.Collections.Generic.IEnumerable<NxMatchingFieldInfo>

GetMatchingFieldsAsync(AsyncHandle, IEnumerable<String>, NxMatchingFieldMode)

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Declaration

public Task<IEnumerable<NxMatchingFieldInfo>> GetMatchingFieldsAsync(AsyncHandle asyncHandle, [QixName("qTags")] IEnumerable<string> tags, [QixName("qMatchingFieldMode")] NxMatchingFieldMode matchingFieldMode = NxMatchingFieldMode.MATCHINGFIELDMODE_MATCH_ALL)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Collections.Generic.IEnumerable<System.String> tags

List of tags. The GetMatchingFields method looks for fields that match one or all of the tags in this list, depending on the value of qMatchingFieldMode .

NxMatchingFieldMode matchingFieldMode

Matching field mode. The default value is MATCHINGFIELDMODE_MATCH_ALL.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxMatchingFieldInfo>>

GetMatchingFieldsAsync(IEnumerable<String>, NxMatchingFieldMode)

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Declaration

public Task<IEnumerable<NxMatchingFieldInfo>> GetMatchingFieldsAsync([QixName("qTags")] IEnumerable<string> tags, [QixName("qMatchingFieldMode")] NxMatchingFieldMode matchingFieldMode = NxMatchingFieldMode.MATCHINGFIELDMODE_MATCH_ALL)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> tags

List of tags. The GetMatchingFields method looks for fields that match one or all of the tags in this list, depending on the value of qMatchingFieldMode .

NxMatchingFieldMode matchingFieldMode

Matching field mode. The default value is MATCHINGFIELDMODE_MATCH_ALL.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxMatchingFieldInfo>>

GetMatchingFieldsAsync<T>(AsyncHandle, Func<Response, T>, IEnumerable<String>, NxMatchingFieldMode)

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Declaration

public Task<T> GetMatchingFieldsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qTags")] IEnumerable<string> tags, [QixName("qMatchingFieldMode")] NxMatchingFieldMode matchingFieldMode = NxMatchingFieldMode.MATCHINGFIELDMODE_MATCH_ALL)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.Collections.Generic.IEnumerable<System.String> tags

List of tags. The GetMatchingFields method looks for fields that match one or all of the tags in this list, depending on the value of qMatchingFieldMode .

NxMatchingFieldMode matchingFieldMode

Matching field mode. The default value is MATCHINGFIELDMODE_MATCH_ALL.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetObject<T>(String)

Get an object

Declaration

public T GetObject<T>([QixName("qId")] string id)
    where T : GenericObject
Parameters
Type Name Description
System.String id

Id of the object to get

Returns
Type Description
T

The object as type T

Type Parameters
Name Description
T

The type to get

GetObject<T, TI>(String)

Get an object

Declaration

public TI GetObject<T, TI>([QixName("qId")] string id)
    where T : GenericObject, TI
Parameters
Type Name Description
System.String id

Object id

Returns
Type Description
TI

The interface

Type Parameters
Name Description
T

The type to get

TI

The interface to return

Exceptions

Type Condition
System.Exception
System.TimeoutException

GetObjectAsync<T>(String, AsyncHandle)

Get an object

Declaration

public Task<T> GetObjectAsync<T>([QixName("qId")] string id, AsyncHandle asyncHandle)
    where T : GenericObject
Parameters
Type Name Description
System.String id

Object id

AsyncHandle asyncHandle

A token / string returned in the answer

Returns
Type Description
System.Threading.Tasks.Task<T>

A task with the object as result

Type Parameters
Name Description
T

The type to get

GetObjectAsync<T, TI>(String, AsyncHandle)

Get an object

Declaration

[QixName("GetObject")]
public Task<TI> GetObjectAsync<T, TI>([QixName("qId")] string id, AsyncHandle asyncHandle)
    where T : GenericObject, TI
Parameters
Type Name Description
System.String id

Object id

AsyncHandle asyncHandle

A token / string returned in the answer

Returns
Type Description
System.Threading.Tasks.Task<TI>

A task with the interface as result

Type Parameters
Name Description
T

The type to get

TI

The interface to return

GetObjects(NxGetObjectOptions)

Returns all objects compatible with options.

Declaration

public IEnumerable<NxContainerEntry> GetObjects([QixName("qOptions")] NxGetObjectOptions options)
Parameters
Type Name Description
NxGetObjectOptions options

Object type filter and requested properties.

Returns
Type Description
System.Collections.Generic.IEnumerable<NxContainerEntry>

GetObjectsAsync(AsyncHandle, NxGetObjectOptions)

Returns all objects compatible with options.

Declaration

public Task<IEnumerable<NxContainerEntry>> GetObjectsAsync(AsyncHandle asyncHandle, [QixName("qOptions")] NxGetObjectOptions options)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

NxGetObjectOptions options

Object type filter and requested properties.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxContainerEntry>>

GetObjectsAsync(NxGetObjectOptions)

Returns all objects compatible with options.

Declaration

public Task<IEnumerable<NxContainerEntry>> GetObjectsAsync([QixName("qOptions")] NxGetObjectOptions options)
Parameters
Type Name Description
NxGetObjectOptions options

Object type filter and requested properties.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxContainerEntry>>

GetObjectsAsync<T>(AsyncHandle, Func<Response, T>, NxGetObjectOptions)

Returns all objects compatible with options.

Declaration

public Task<T> GetObjectsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qOptions")] NxGetObjectOptions options)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

NxGetObjectOptions options

Object type filter and requested properties.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetScript()

Gets values in script.

Declaration

public string GetScript()
Returns
Type Description
System.String

GetScriptAsync()

Gets values in script.

Declaration

public Task<string> GetScriptAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetScriptAsync(AsyncHandle)

Gets values in script.

Declaration

public Task<string> GetScriptAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetScriptAsync<T>(AsyncHandle, Func<Response, T>)

Gets values in script.

Declaration

public Task<T> GetScriptAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetScriptBreakpoints()

Lists the breakpoints in the script of an app.

Declaration

public IEnumerable<EditorBreakpoint> GetScriptBreakpoints()
Returns
Type Description
System.Collections.Generic.IEnumerable<EditorBreakpoint>

GetScriptBreakpointsAsync()

Lists the breakpoints in the script of an app.

Declaration

public Task<IEnumerable<EditorBreakpoint>> GetScriptBreakpointsAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<EditorBreakpoint>>

GetScriptBreakpointsAsync(AsyncHandle)

Lists the breakpoints in the script of an app.

Declaration

public Task<IEnumerable<EditorBreakpoint>> GetScriptBreakpointsAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<EditorBreakpoint>>

GetScriptBreakpointsAsync<T>(AsyncHandle, Func<Response, T>)

Lists the breakpoints in the script of an app.

Declaration

public Task<T> GetScriptBreakpointsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetScriptEx()

Gets script and script meta-data.

Declaration

public AppScript GetScriptEx()
Returns
Type Description
AppScript

GetScriptExAsync()

Gets script and script meta-data.

Declaration

public Task<AppScript> GetScriptExAsync()
Returns
Type Description
System.Threading.Tasks.Task<AppScript>

GetScriptExAsync(AsyncHandle)

Gets script and script meta-data.

Declaration

public Task<AppScript> GetScriptExAsync(AsyncHandle asyncHandle)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

Returns
Type Description
System.Threading.Tasks.Task<AppScript>

GetScriptExAsync<T>(AsyncHandle, Func<Response, T>)

Gets script and script meta-data.

Declaration

public Task<T> GetScriptExAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetSetAnalysis(String, String)

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Declaration

public string GetSetAnalysis([QixName("qStateName")] string stateName = null, [QixName("qBookmarkId")] string bookmarkId = null)
Parameters
Type Name Description
System.String stateName

Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.

System.String bookmarkId

Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.

Returns
Type Description
System.String

GetSetAnalysisAsync(AsyncHandle, String, String)

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Declaration

public Task<string> GetSetAnalysisAsync(AsyncHandle asyncHandle, [QixName("qStateName")] string stateName = null, [QixName("qBookmarkId")] string bookmarkId = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String stateName

Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.

System.String bookmarkId

Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetSetAnalysisAsync(String, String)

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Declaration

public Task<string> GetSetAnalysisAsync([QixName("qStateName")] string stateName = null, [QixName("qBookmarkId")] string bookmarkId = null)
Parameters
Type Name Description
System.String stateName

Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.

System.String bookmarkId

Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.

Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetSetAnalysisAsync<T>(AsyncHandle, Func<Response, T>, String, String)

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Declaration

public Task<T> GetSetAnalysisAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qStateName")] string stateName = null, [QixName("qBookmarkId")] string bookmarkId = null)
Parameters
Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

System.String stateName

Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.

System.String bookmarkId

Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.

Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

GetTableData(Int32, Int32, Boolean, String)

Retrieves the data of a specific table.

Declaration