Click or drag to resize
IApp Methods

The IApp type exposes the following members.

Methods
  NameDescription
Public methodAbortModal

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

Public methodAbortModalAsync(Boolean)

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

Public methodAbortModalAsync(AsyncHandle, Boolean)

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

Public methodAddAlternateState

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.

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

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

Public methodAddFieldFromExpression

Adds a field on the fly.

The expression of a field on the fly is persisted but not its values.
Public methodAddFieldFromExpressionAsync(String, String)

Adds a field on the fly.

The expression of a field on the fly is persisted but not its values.
Public methodAddFieldFromExpressionAsync(AsyncHandle, String, String)

Adds a field on the fly.

The expression of a field on the fly is persisted but not its values.
Public methodAddFieldFromExpressionAsyncT(AsyncHandle, FuncResponse, T, String, String)

Adds a field on the fly.

The expression of a field on the fly is persisted but not its values.
Public methodApplyGenericBookmark

Applies a bookmark.

Public methodApplyGenericBookmarkAsync(String)

Applies a bookmark.

Public methodApplyGenericBookmarkAsync(AsyncHandle, String)

Applies a bookmark.

Public methodApplyGenericBookmarkAsyncT(AsyncHandle, FuncResponse, T, String)

Applies a bookmark.

Public methodBack

Loads the last logical operation (if any).

Public methodBackAsync

Loads the last logical operation (if any).

Public methodBackAsync(AsyncHandle)

Loads the last logical operation (if any).

Public methodBackCount

Returns the number of entries on the Back stack.

Public methodBackCountAsync

Returns the number of entries on the Back stack.

Public methodBackCountAsync(AsyncHandle)

Returns the number of entries on the Back stack.

Public methodBackCountAsyncT(AsyncHandle, FuncResponse, T)

Returns the number of entries on the Back stack.

Public methodCheckExpression

Checks if a given expression is valid.

Public methodCheckExpressionAsync(String, IEnumerableString)

Checks if a given expression is valid.

Public methodCheckExpressionAsync(AsyncHandle, String, IEnumerableString)

Checks if a given expression is valid.

Public methodCheckExpressionAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableString)

Checks if a given expression is valid.

Public methodCheckNumberOrExpression

Checks if:

* a given expression is valid

* a number is correct according to the locale.

Public methodCheckNumberOrExpressionAsync(String)

Checks if:

* a given expression is valid

* a number is correct according to the locale.

Public methodCheckNumberOrExpressionAsync(AsyncHandle, String)

Checks if:

* a given expression is valid

* a number is correct according to the locale.

Public methodCheckNumberOrExpressionAsyncT(AsyncHandle, FuncResponse, T, String)

Checks if:

* a given expression is valid

* a number is correct according to the locale.

Public methodCheckScriptSyntax

Checks the syntax of a script.

Public methodCheckScriptSyntaxAsync

Checks the syntax of a script.

Public methodCheckScriptSyntaxAsync(AsyncHandle)

Checks the syntax of a script.

Public methodCheckScriptSyntaxAsyncT(AsyncHandle, FuncResponse, T)

Checks the syntax of a script.

Public methodClearAll

Clears all selections in all fields of the current app.

Public methodClearAllAsync(Boolean, String)

Clears all selections in all fields of the current app.

Public methodClearAllAsync(AsyncHandle, Boolean, String)

Clears all selections in all fields of the current app.

Public methodClearUndoBuffer

Clears entirely the undo and redo buffer.

Public methodClearUndoBufferAsync

Clears entirely the undo and redo buffer.

Public methodClearUndoBufferAsync(AsyncHandle)

Clears entirely the undo and redo buffer.

Public methodCloneGenericBookmark

Clones a bookmark.

Public methodCloneGenericBookmarkAsync(String)

Clones a bookmark.

Public methodCloneGenericBookmarkAsync(AsyncHandle, String)

Clones a bookmark.

Public methodCloneGenericBookmarkAsyncT(AsyncHandle, FuncResponse, T, String)

Clones a bookmark.

Public methodCloneGenericDimension

Clones a dimension.

Public methodCloneGenericDimensionAsync(String)

Clones a dimension.

Public methodCloneGenericDimensionAsync(AsyncHandle, String)

Clones a dimension.

Public methodCloneGenericDimensionAsyncT(AsyncHandle, FuncResponse, T, String)

Clones a dimension.

Public methodCloneGenericMeasure

Clones a measure.

Public methodCloneGenericMeasureAsync(String)

Clones a measure.

Public methodCloneGenericMeasureAsync(AsyncHandle, String)

Clones a measure.

Public methodCloneGenericMeasureAsyncT(AsyncHandle, FuncResponse, T, String)

Clones a measure.

Public methodCloneGenericObject

Clones any generic object (for example list objects, hypercubes, slides), sheets and stories. The clone method works for both app objects and child objects.

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

It is not possible to clone a session object.
Public methodCloneGenericObjectAsync(String)

Clones any generic object (for example list objects, hypercubes, slides), sheets and stories. The clone method works for both app objects and child objects.

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

It is not possible to clone a session object.
Public methodCloneGenericObjectAsync(AsyncHandle, String)

Clones any generic object (for example list objects, hypercubes, slides), sheets and stories. The clone method works for both app objects and child objects.

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

It is not possible to clone a session object.
Public methodCloneGenericObjectAsyncT(AsyncHandle, FuncResponse, T, String)

Clones any generic object (for example list objects, hypercubes, slides), sheets and stories. The clone method works for both app objects and child objects.

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

It is not possible to clone a session object.
Public methodCommitDraft

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Public methodCommitDraftAsync(String)

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Public methodCommitDraftAsync(AsyncHandle, String)

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Public methodCreateConnection

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

Public methodCreateConnectionAsync(Connection)

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

Public methodCreateConnectionAsync(AsyncHandle, Connection)

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

Public methodCreateConnectionAsyncT(AsyncHandle, FuncResponse, T, Connection)

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

Public methodCreateDraft

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Public methodCreateDraftAsync(String)

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Public methodCreateDraftAsync(AsyncHandle, String)

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Public methodCreateDraftAsyncT(AsyncHandle, FuncResponse, T, String)

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Public methodCreateGenericBookmark

Creates a bookmark.

Public methodCreateGenericBookmarkAsync(GenericBookmarkProperties)

Creates a bookmark.

Public methodCreateGenericBookmarkAsync(AsyncHandle, GenericBookmarkProperties)

Creates a bookmark.

Public methodCreateGenericBookmarkAsyncT(AsyncHandle, FuncResponse, T, GenericBookmarkProperties)

Creates a bookmark.

Public methodCreateGenericDimension

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.

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

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

Public methodCreateGenericDimensionAsyncT(AsyncHandle, FuncResponse, 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.

Public methodCreateGenericMeasure

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.

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

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

Public methodCreateGenericMeasureAsyncT(AsyncHandle, FuncResponse, 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.

Public methodCreateGenericObject

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

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.

The linking object cannot be a transient object.
Public methodCreateGenericObjectAsync(GenericObjectProperties)

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

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.

The linking object cannot be a transient object.
Public methodCreateGenericObjectAsync(AsyncHandle, GenericObjectProperties)

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

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.

The linking object cannot be a transient object.
Public methodCreateGenericObjectAsyncT(AsyncHandle, FuncResponse, T, GenericObjectProperties)

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

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.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObject

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.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObjectAsync(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.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObjectAsync(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.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObjectAsyncT(AsyncHandle, FuncResponse, 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.

The linking object cannot be a transient object.
Public methodCreateSessionVariable
Public methodCreateSessionVariableAsync(GenericVariableProperties)
Public methodCreateSessionVariableAsync(AsyncHandle, GenericVariableProperties)
Public methodCreateSessionVariableAsyncT(AsyncHandle, FuncResponse, T, GenericVariableProperties)
Public methodCreateVariable Obsolete.

Creates a variable.

Public methodCreateVariableAsync(String) Obsolete.

Creates a variable.

Public methodCreateVariableAsync(AsyncHandle, String) Obsolete.

Creates a variable.

Public methodCreateVariableAsyncT(AsyncHandle, FuncResponse, T, String) Obsolete.

Creates a variable.

Public methodCreateVariableEx
Public methodCreateVariableExAsync(GenericVariableProperties)
Public methodCreateVariableExAsync(AsyncHandle, GenericVariableProperties)
Public methodCreateVariableExAsyncT(AsyncHandle, FuncResponse, T, GenericVariableProperties)
Public methodDeleteConnection

Deletes a connection.

Public methodDeleteConnectionAsync(String)

Deletes a connection.

Public methodDeleteConnectionAsync(AsyncHandle, String)

Deletes a connection.

Public methodDestroyDraft

Removes the draft of an object.

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

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Public methodDestroyDraftAsync(String, String)

Removes the draft of an object.

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

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Public methodDestroyDraftAsync(AsyncHandle, String, String)

Removes the draft of an object.

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

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

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

Removes the draft of an object.

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

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Public methodDestroyGenericBookmark

Removes a bookmark.

Public methodDestroyGenericBookmarkAsync(String)

Removes a bookmark.

Public methodDestroyGenericBookmarkAsync(AsyncHandle, String)

Removes a bookmark.

Public methodDestroyGenericBookmarkAsyncT(AsyncHandle, FuncResponse, T, String)

Removes a bookmark.

Public methodDestroyGenericDimension

Removes a dimension.

Public methodDestroyGenericDimensionAsync(String)

Removes a dimension.

Public methodDestroyGenericDimensionAsync(AsyncHandle, String)

Removes a dimension.

Public methodDestroyGenericDimensionAsyncT(AsyncHandle, FuncResponse, T, String)

Removes a dimension.

Public methodDestroyGenericMeasure

Removes a generic measure.

Public methodDestroyGenericMeasureAsync(String)

Removes a generic measure.

Public methodDestroyGenericMeasureAsync(AsyncHandle, String)

Removes a generic measure.

Public methodDestroyGenericMeasureAsyncT(AsyncHandle, FuncResponse, T, String)

Removes a generic measure.

Public methodDestroyGenericObject

Removes an app object.

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

Public methodDestroyGenericObjectAsync(String)

Removes an app object.

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

Public methodDestroyGenericObjectAsync(AsyncHandle, String)

Removes an app object.

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

Public methodDestroyGenericObjectAsyncT(AsyncHandle, FuncResponse, T, String)

Removes an app object.

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

Public methodDestroyGenericSessionObject

Removes a transient object.

Public methodDestroyGenericSessionObjectAsync(String)

Removes a transient object.

Public methodDestroyGenericSessionObjectAsync(AsyncHandle, String)

Removes a transient object.

Public methodDestroyGenericSessionObjectAsyncT(AsyncHandle, FuncResponse, T, String)

Removes a transient object.

Public methodDestroySessionVariable
Public methodDestroySessionVariableAsync(String)
Public methodDestroySessionVariableAsync(AsyncHandle, String)
Public methodDestroySessionVariableAsyncT(AsyncHandle, FuncResponse, T, String)
Public methodDestroyVariableById
Public methodDestroyVariableByIdAsync(String)
Public methodDestroyVariableByIdAsync(AsyncHandle, String)
Public methodDestroyVariableByIdAsyncT(AsyncHandle, FuncResponse, T, String)
Public methodDestroyVariableByName
Public methodDestroyVariableByNameAsync(String)
Public methodDestroyVariableByNameAsync(AsyncHandle, String)
Public methodDestroyVariableByNameAsyncT(AsyncHandle, FuncResponse, T, String)
Public methodDoReload

Reloads the script that is set in an app.

Public methodDoReloadAsync(Int32, Boolean, Boolean)

Reloads the script that is set in an app.

Public methodDoReloadAsync(AsyncHandle, Int32, Boolean, Boolean)

Reloads the script that is set in an app.

Public methodDoReloadAsyncT(AsyncHandle, FuncResponse, T, Int32, Boolean, Boolean)

Reloads the script that is set in an app.

Public methodDoReloadEx

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

A log file is created per reload.
Public methodDoReloadExAsync(DoReloadExParams)

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

A log file is created per reload.
Public methodDoReloadExAsync(AsyncHandle, DoReloadExParams)

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

A log file is created per reload.
Public methodDoReloadExAsyncT(AsyncHandle, FuncResponse, T, DoReloadExParams)

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

A log file is created per reload.
Public methodDoSave

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

Public methodDoSaveAsync(String)

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

Public methodDoSaveAsync(AsyncHandle, String)

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

Public methodEvaluate

Evaluates an expression as a string.

Public methodEvaluateAsync(String)

Evaluates an expression as a string.

Public methodEvaluateAsync(AsyncHandle, String)

Evaluates an expression as a string.

Public methodEvaluateAsyncT(AsyncHandle, FuncResponse, T, String)

Evaluates an expression as a string.

Public methodEvaluateEx

Evaluates an expression as a dual.

Public methodEvaluateExAsync(String)

Evaluates an expression as a dual.

Public methodEvaluateExAsync(AsyncHandle, String)

Evaluates an expression as a dual.

Public methodEvaluateExAsyncT(AsyncHandle, FuncResponse, T, String)

Evaluates an expression as a dual.

Public methodFindMatchingFields

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

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodFindMatchingFieldsAsync(String, IEnumerableString)

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

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodFindMatchingFieldsAsync(AsyncHandle, String, IEnumerableString)

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

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodFindMatchingFieldsAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableString)

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

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodForward

Loads the next logical operation (if any).

Public methodForwardAsync

Loads the next logical operation (if any).

Public methodForwardAsync(AsyncHandle)

Loads the next logical operation (if any).

Public methodForwardCount

Returns the number of entries on the Forward stack.

Public methodForwardCountAsync

Returns the number of entries on the Forward stack.

Public methodForwardCountAsync(AsyncHandle)

Returns the number of entries on the Forward stack.

Public methodForwardCountAsyncT(AsyncHandle, FuncResponse, T)

Returns the number of entries on the Forward stack.

Public methodGetAllInfos

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

Public methodGetAllInfosAsync

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

Public methodGetAllInfosAsync(AsyncHandle)

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

Public methodGetAllInfosAsyncT(AsyncHandle, FuncResponse, T)

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

Public methodGetAppLayout

Evaluates an app.

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

Public methodGetAppLayoutAsync

Evaluates an app.

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

Public methodGetAppLayoutAsync(AsyncHandle)

Evaluates an app.

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

Public methodGetAppLayoutAsyncT(AsyncHandle, FuncResponse, T)

Evaluates an app.

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

Public methodGetAppProperties

Gets the properties of an app.

Public methodGetAppPropertiesAsync

Gets the properties of an app.

Public methodGetAppPropertiesAsync(AsyncHandle)

Gets the properties of an app.

Public methodGetAppPropertiesAsyncT(AsyncHandle, FuncResponse, T)

Gets the properties of an app.

Public methodGetAssociationScores

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]:.

Public methodGetAssociationScoresAsync(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]:.

Public methodGetAssociationScoresAsync(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]:.

Public methodGetAssociationScoresAsyncT(AsyncHandle, FuncResponse, 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]:.

Public methodGetConnection

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

Public methodGetConnectionAsync(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

Public methodGetConnectionAsync(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

Public methodGetConnectionAsyncT(AsyncHandle, FuncResponse, 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

Public methodGetConnections

Lists the connections in an app.

Public methodGetConnectionsAsync

Lists the connections in an app.

Public methodGetConnectionsAsync(AsyncHandle)

Lists the connections in an app.

Public methodGetConnectionsAsyncT(AsyncHandle, FuncResponse, T)

Lists the connections in an app.

Public methodGetContentLibraries
Public methodGetContentLibrariesAsync
Public methodGetContentLibrariesAsync(AsyncHandle)
Public methodGetContentLibrariesAsyncT(AsyncHandle, FuncResponse, T)
Public methodGetDatabaseInfo

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

Public methodGetDatabaseInfoAsync(String)

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

Public methodGetDatabaseInfoAsync(AsyncHandle, String)

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

Public methodGetDatabaseInfoAsyncT(AsyncHandle, FuncResponse, T, String)

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

Public methodGetDatabaseOwners

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

Public methodGetDatabaseOwnersAsync(String, String)

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

Public methodGetDatabaseOwnersAsync(AsyncHandle, String, String)

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

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

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

Public methodGetDatabases

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

Public methodGetDatabasesAsync(String)

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

Public methodGetDatabasesAsync(AsyncHandle, String)

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

Public methodGetDatabasesAsyncT(AsyncHandle, FuncResponse, T, String)

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

Public methodGetDatabaseTableFields

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

Public methodGetDatabaseTableFieldsAsync(String, String, String, String)

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

Public methodGetDatabaseTableFieldsAsync(AsyncHandle, String, String, String, String)

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

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

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

Public methodGetDatabaseTablePreview

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

Public methodGetDatabaseTablePreviewAsync(String, String, String, String)

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

Public methodGetDatabaseTablePreviewAsync(AsyncHandle, String, String, String, String)

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

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

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

Public methodGetDatabaseTables

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

Public methodGetDatabaseTablesAsync(String, String, String)

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

Public methodGetDatabaseTablesAsync(AsyncHandle, String, String, String)

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

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

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

Public methodGetEmptyScript

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

The computer regional settings are retrieved when the engine starts.
Public methodGetEmptyScriptAsync(String)

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

The computer regional settings are retrieved when the engine starts.
Public methodGetEmptyScriptAsync(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.

The computer regional settings are retrieved when the engine starts.
Public methodGetEmptyScriptAsyncT(AsyncHandle, FuncResponse, 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.

The computer regional settings are retrieved when the engine starts.
Public methodGetFavoriteVariables

Retrieves the variables that are tagged as favorite.

Public methodGetFavoriteVariablesAsync

Retrieves the variables that are tagged as favorite.

Public methodGetFavoriteVariablesAsync(AsyncHandle)

Retrieves the variables that are tagged as favorite.

Public methodGetFavoriteVariablesAsyncT(AsyncHandle, FuncResponse, T)

Retrieves the variables that are tagged as favorite.

Public methodGetField

Retrieves the handle of a field.

Public methodGetFieldAsync(String, String)

Retrieves the handle of a field.

Public methodGetFieldAsync(AsyncHandle, String, String)

Retrieves the handle of a field.

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

Retrieves the handle of a field.

Public methodGetFieldDescription

Retrieves the description of a field.

Public methodGetFieldDescriptionAsync(String)

Retrieves the description of a field.

Public methodGetFieldDescriptionAsync(AsyncHandle, String)

Retrieves the description of a field.

Public methodGetFieldDescriptionAsyncT(AsyncHandle, FuncResponse, T, String)

Retrieves the description of a field.

Public methodGetFileTableFields

Lists the fields of a table for a folder connection.

Public methodGetFileTableFieldsAsync(String, String, FileDataFormat, String)

Lists the fields of a table for a folder connection.

Public methodGetFileTableFieldsAsync(AsyncHandle, String, String, FileDataFormat, String)

Lists the fields of a table for a folder connection.

Public methodGetFileTableFieldsAsyncT(AsyncHandle, FuncResponse, T, String, String, FileDataFormat, String)

Lists the fields of a table for a folder connection.

Public methodGetFileTablePreview

Lists the values in a table for a folder connection.

Public methodGetFileTablePreviewAsync(String, String, FileDataFormat, String)

Lists the values in a table for a folder connection.

Public methodGetFileTablePreviewAsync(AsyncHandle, String, String, FileDataFormat, String)

Lists the values in a table for a folder connection.

Public methodGetFileTablePreviewAsyncT(AsyncHandle, FuncResponse, T, String, String, FileDataFormat, String)

Lists the values in a table for a folder connection.

Public methodGetFileTables

Lists the tables for a folder connection.

Public methodGetFileTablesAsync(String, String, FileDataFormat)

Lists the tables for a folder connection.

Public methodGetFileTablesAsync(AsyncHandle, String, String, FileDataFormat)

Lists the tables for a folder connection.

Public methodGetFileTablesAsyncT(AsyncHandle, FuncResponse, T, String, String, FileDataFormat)

Lists the tables for a folder connection.

Public methodGetFileTablesEx

Lists the tables and fields of a JSON or XML file for a folder connection.

Public methodGetFileTablesExAsync(String, String, FileDataFormat)

Lists the tables and fields of a JSON or XML file for a folder connection.

Public methodGetFileTablesExAsync(AsyncHandle, String, String, FileDataFormat)

Lists the tables and fields of a JSON or XML file for a folder connection.

Public methodGetFileTablesExAsyncT(AsyncHandle, FuncResponse, T, String, String, FileDataFormat)

Lists the tables and fields of a JSON or XML file for a folder connection.

Public methodGetFolderItemsForConnection

Lists the items for a folder connection.

Public methodGetFolderItemsForConnectionAsync(String, String)

Lists the items for a folder connection.

Public methodGetFolderItemsForConnectionAsync(AsyncHandle, String, String)

Lists the items for a folder connection.

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

Lists the items for a folder connection.

Public methodGetGenericBookmark

Returns the handle of a bookmark.

Public methodGetGenericBookmarkAsync(String)

Returns the handle of a bookmark.

Public methodGetGenericBookmarkAsync(AsyncHandle, String)

Returns the handle of a bookmark.

Public methodGetGenericBookmarkAsyncT(AsyncHandle, FuncResponse, T, String)

Returns the handle of a bookmark.

Public methodGetGenericDimension

Returns the handle of a dimension.

Public methodGetGenericDimensionAsync(String)

Returns the handle of a dimension.

Public methodGetGenericDimensionAsync(AsyncHandle, String)

Returns the handle of a dimension.

Public methodGetGenericDimensionAsyncT(AsyncHandle, FuncResponse, T, String)

Returns the handle of a dimension.

Public methodGetGenericMeasure

Returns the handle of a measure.

Public methodGetGenericMeasureAsync(String)

Returns the handle of a measure.

Public methodGetGenericMeasureAsync(AsyncHandle, String)

Returns the handle of a measure.

Public methodGetGenericMeasureAsyncT(AsyncHandle, FuncResponse, T, String)

Returns the handle of a measure.

Public methodGetGenericObject

Returns the type of the app object and the corresponding handle.

Public methodGetGenericObjectAsync(String)

Returns the type of the app object and the corresponding handle.

Public methodGetGenericObjectAsync(AsyncHandle, String)

Returns the type of the app object and the corresponding handle.

Public methodGetGenericObjectAsyncT(AsyncHandle, FuncResponse, T, String)

Returns the type of the app object and the corresponding handle.

Public methodGetIncludeFileContent

Gets the content of a file.

Public methodGetIncludeFileContentAsync(String)

Gets the content of a file.

Public methodGetIncludeFileContentAsync(AsyncHandle, String)

Gets the content of a file.

Public methodGetIncludeFileContentAsyncT(AsyncHandle, FuncResponse, T, String)

Gets the content of a file.

Public methodGetLibraryContent
Public methodGetLibraryContentAsync(String)
Public methodGetLibraryContentAsync(AsyncHandle, String)
Public methodGetLibraryContentAsyncT(AsyncHandle, FuncResponse, T, String)
Public methodGetLocaleInfo

Retrieves locale information.

Public methodGetLocaleInfoAsync

Retrieves locale information.

Public methodGetLocaleInfoAsync(AsyncHandle)

Retrieves locale information.

Public methodGetLocaleInfoAsyncT(AsyncHandle, FuncResponse, T)

Retrieves locale information.

Public methodGetLooselyCoupledVector

Returns a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.In case of circular references, the engine automatically create loosely coupled tables so that the circular references do not create a loop.
Public methodGetLooselyCoupledVectorAsync

Returns a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.In case of circular references, the engine automatically create loosely coupled tables so that the circular references do not create a loop.
Public methodGetLooselyCoupledVectorAsync(AsyncHandle)

Returns a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.In case of circular references, the engine automatically create loosely coupled tables so that the circular references do not create a loop.
Public methodGetLooselyCoupledVectorAsyncT(AsyncHandle, FuncResponse, T)

Returns a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.In case of circular references, the engine automatically create loosely coupled tables so that the circular references do not create a loop.
Public methodGetMatchingFields

Retrieves any fields that match all or one of the specified tags in the data model of an app.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodGetMatchingFieldsAsync(IEnumerableString, NxMatchingFieldMode)

Retrieves any fields that match all or one of the specified tags in the data model of an app.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodGetMatchingFieldsAsync(AsyncHandle, IEnumerableString, NxMatchingFieldMode)

Retrieves any fields that match all or one of the specified tags in the data model of an app.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodGetMatchingFieldsAsyncT(AsyncHandle, FuncResponse, T, IEnumerableString, NxMatchingFieldMode)

Retrieves any fields that match all or one of the specified tags in the data model of an app.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodGetMediaList Obsolete.

Lists the media files.

Public methodGetMediaListAsync Obsolete.

Lists the media files.

Public methodGetMediaListAsync(AsyncHandle) Obsolete.

Lists the media files.

Public methodGetMediaListAsyncT(AsyncHandle, FuncResponse, T) Obsolete.

Lists the media files.

Public methodGetObjectT(String)
Get an object
Public methodGetObjectT, TI(String)
Get an object
Public methodGetObjectAsyncT(String, AsyncHandle)
Get an object
Public methodGetObjectAsyncT, TI(String, AsyncHandle)
Get an object
Public methodGetProperties

Gets the properties of an app.

Public methodGetPropertiesAsync

Gets the properties of an app.

Public methodGetPropertiesAsync(AsyncHandle)

Gets the properties of an app.

Public methodGetPropertiesAsyncT(AsyncHandle, FuncResponse, T)

Gets the properties of an app.

Public methodGetScript

Gets values in script.

Public methodGetScriptAsync

Gets values in script.

Public methodGetScriptAsync(AsyncHandle)

Gets values in script.

Public methodGetScriptAsyncT(AsyncHandle, FuncResponse, T)

Gets values in script.

Public methodGetScriptBreakpoints

Lists the breakpoints in the script of an app.

Public methodGetScriptBreakpointsAsync

Lists the breakpoints in the script of an app.

Public methodGetScriptBreakpointsAsync(AsyncHandle)

Lists the breakpoints in the script of an app.

Public methodGetScriptBreakpointsAsyncT(AsyncHandle, FuncResponse, T)

Lists the breakpoints in the script of an app.

Public methodGetTableData

Retrieves the data of a specific table.

Public methodGetTableDataAsync(Int32, Int32, Boolean, String)

Retrieves the data of a specific table.

Public methodGetTableDataAsync(AsyncHandle, Int32, Int32, Boolean, String)

Retrieves the data of a specific table.

Public methodGetTableDataAsyncT(AsyncHandle, FuncResponse, T, Int32, Int32, Boolean, String)

Retrieves the data of a specific table.

Public methodGetTablesAndKeys

Returns:

* the list of tables in an app and the fields inside each table

* the list of derived fields

* the list of key fields

Public methodGetTablesAndKeysAsync(Size, Size, Int32, Boolean, Boolean)

Returns:

* the list of tables in an app and the fields inside each table

* the list of derived fields

* the list of key fields

Public methodGetTablesAndKeysAsync(AsyncHandle, Size, Size, Int32, Boolean, Boolean)

Returns:

* the list of tables in an app and the fields inside each table

* the list of derived fields

* the list of key fields

Public methodGetTablesAndKeysAsyncT(AsyncHandle, FuncResponse, T, Size, Size, Int32, Boolean, Boolean)

Returns:

* the list of tables in an app and the fields inside each table

* the list of derived fields

* the list of key fields

Public methodGetTextMacros

Fetches updated variables after a statement execution.

Public methodGetTextMacrosAsync

Fetches updated variables after a statement execution.

Public methodGetTextMacrosAsync(AsyncHandle)

Fetches updated variables after a statement execution.

Public methodGetTextMacrosAsyncT(AsyncHandle, FuncResponse, T)

Fetches updated variables after a statement execution.

Public methodGetVariable Obsolete.

Gets the handle of a variable.

Public methodGetVariableAsync(String) Obsolete.

Gets the handle of a variable.

Public methodGetVariableAsync(AsyncHandle, String) Obsolete.

Gets the handle of a variable.

Public methodGetVariableAsyncT(AsyncHandle, FuncResponse, T, String) Obsolete.

Gets the handle of a variable.

Public methodGetVariableById
Public methodGetVariableByIdAsync(String)
Public methodGetVariableByIdAsync(AsyncHandle, String)
Public methodGetVariableByIdAsyncT(AsyncHandle, FuncResponse, T, String)
Public methodGetVariableByName
Public methodGetVariableByNameAsync(String)
Public methodGetVariableByNameAsync(AsyncHandle, String)
Public methodGetVariableByNameAsyncT(AsyncHandle, FuncResponse, T, String)
Public methodGetViewDlgSaveInfo

Retrieves information about the position of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be retrieved in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodGetViewDlgSaveInfoAsync

Retrieves information about the position of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be retrieved in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodGetViewDlgSaveInfoAsync(AsyncHandle)

Retrieves information about the position of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be retrieved in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodGetViewDlgSaveInfoAsyncT(AsyncHandle, FuncResponse, T)

Retrieves information about the position of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be retrieved in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodGuessFileType

Guesses the data format for a given file.

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)

* HTMLfor HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

Public methodGuessFileTypeAsync(String, String)

Guesses the data format for a given file.

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)

* HTMLfor HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

Public methodGuessFileTypeAsync(AsyncHandle, String, String)

Guesses the data format for a given file.

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)

* HTMLfor HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

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

Guesses the data format for a given file.

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)

* HTMLfor HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

Public methodLockAll

Locks all selections in all fields of the current app.

Public methodLockAllAsync(String)

Locks all selections in all fields of the current app.

Public methodLockAllAsync(AsyncHandle, String)

Locks all selections in all fields of the current app.

Public methodModifyConnection

Updates a connection.

The identifier of a connection cannot be updated.
Public methodModifyConnectionAsync(String, Connection, Boolean)

Updates a connection.

The identifier of a connection cannot be updated.
Public methodModifyConnectionAsync(AsyncHandle, String, Connection, Boolean)

Updates a connection.

The identifier of a connection cannot be updated.
Public methodPublish

Publishes an app. The published app can have a different name than the original app.

All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

An app can only be published once and cannot be published to more than one stream.
Public methodPublishAsync(String, String)

Publishes an app. The published app can have a different name than the original app.

All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

An app can only be published once and cannot be published to more than one stream.
Public methodPublishAsync(AsyncHandle, String, String)

Publishes an app. The published app can have a different name than the original app.

All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

An app can only be published once and cannot be published to more than one stream.
Public methodRedo

Redoes the previous operation.

Public methodRedoAsync

Redoes the previous operation.

Public methodRedoAsync(AsyncHandle)

Redoes the previous operation.

Public methodRedoAsyncT(AsyncHandle, FuncResponse, T)

Redoes the previous operation.

Public methodReduceData Obsolete.
Public methodReduceDataAsync(Boolean, IEnumerableString) Obsolete.
Public methodReduceDataAsync(AsyncHandle, Boolean, IEnumerableString) Obsolete.
Public methodRemoveAllData Obsolete.
Public methodRemoveAllDataAsync(Boolean) Obsolete.
Public methodRemoveAllDataAsync(AsyncHandle, Boolean) Obsolete.
Public methodRemoveAlternateState

Removes an alternate state in the app.

Public methodRemoveAlternateStateAsync(String)

Removes an alternate state in the app.

Public methodRemoveAlternateStateAsync(AsyncHandle, String)

Removes an alternate state in the app.

Public methodRemoveVariable Obsolete.

Removes a variable.

Public methodRemoveVariableAsync(String) Obsolete.

Removes a variable.

Public methodRemoveVariableAsync(AsyncHandle, String) Obsolete.

Removes a variable.

Public methodRemoveVariableAsyncT(AsyncHandle, FuncResponse, T, String) Obsolete.

Removes a variable.

Public methodResume

Resumes the app as the user left it.

Public methodResumeAsync

Resumes the app as the user left it.

Public methodResumeAsync(AsyncHandle)

Resumes the app as the user left it.

Public methodSaveObjects

Saves all objects that were modified in the app.

Data from the data model are not saved.This operation is only possible when working in server mode.
Public methodSaveObjectsAsync

Saves all objects that were modified in the app.

Data from the data model are not saved.This operation is only possible when working in server mode.
Public methodSaveObjectsAsync(AsyncHandle)

Saves all objects that were modified in the app.

Data from the data model are not saved.This operation is only possible when working in server mode.
Public methodSearchAssociations

Returns the search matches for one or more search terms.

The search results depend on the search context.

See: SearchCombinationOptions

This type of search is also called smart search.
Public methodSearchAssociationsAsync(SearchCombinationOptions, IEnumerableString, SearchPage)

Returns the search matches for one or more search terms.

The search results depend on the search context.

See: SearchCombinationOptions

This type of search is also called smart search.
Public methodSearchAssociationsAsync(AsyncHandle, SearchCombinationOptions, IEnumerableString, SearchPage)

Returns the search matches for one or more search terms.

The search results depend on the search context.

See: SearchCombinationOptions

This type of search is also called smart search.
Public methodSearchAssociationsAsyncT(AsyncHandle, FuncResponse, T, SearchCombinationOptions, IEnumerableString, SearchPage)

Returns the search matches for one or more search terms.

The search results depend on the search context.

See: SearchCombinationOptions

This type of search is also called smart search.
Public methodSearchSuggest

Returns search terms suggestions.

Public methodSearchSuggestAsync(SearchCombinationOptions, IEnumerableString)

Returns search terms suggestions.

Public methodSearchSuggestAsync(AsyncHandle, SearchCombinationOptions, IEnumerableString)

Returns search terms suggestions.

Public methodSearchSuggestAsyncT(AsyncHandle, FuncResponse, T, SearchCombinationOptions, IEnumerableString)

Returns search terms suggestions.

Public methodSelectAssociations

Selects all search hits for a specified group.

The results depend on the search context.

See: SearchCombinationOptions

Public methodSelectAssociationsAsync(SearchCombinationOptions, IEnumerableString, Int32, Boolean)

Selects all search hits for a specified group.

The results depend on the search context.

See: SearchCombinationOptions

Public methodSelectAssociationsAsync(AsyncHandle, SearchCombinationOptions, IEnumerableString, Int32, Boolean)

Selects all search hits for a specified group.

The results depend on the search context.

See: SearchCombinationOptions

Public methodSendGenericCommandToCustomConnector

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Public methodSendGenericCommandToCustomConnectorAsync(String, String, String, IEnumerableString, String)

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Public methodSendGenericCommandToCustomConnectorAsync(AsyncHandle, String, String, String, IEnumerableString, String)

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Public methodSendGenericCommandToCustomConnectorAsyncT(AsyncHandle, FuncResponse, T, String, String, String, IEnumerableString, String)

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Public methodSetAppProperties

Sets properties to an app.

Public methodSetAppPropertiesAsync(NxAppProperties)

Sets properties to an app.

Public methodSetAppPropertiesAsync(AsyncHandle, NxAppProperties)

Sets properties to an app.

Public methodSetFavoriteVariables

Set some variables as favorite.

Public methodSetFavoriteVariablesAsync(IEnumerableString)

Set some variables as favorite.

Public methodSetFavoriteVariablesAsync(AsyncHandle, IEnumerableString)

Set some variables as favorite.

Public methodSetFetchLimit

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Public methodSetFetchLimitAsync(Int32)

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Public methodSetFetchLimitAsync(AsyncHandle, Int32)

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Public methodSetLooselyCoupledVector

Sets a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.
Public methodSetLooselyCoupledVectorAsync(IEnumerableByte)

Sets a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.
Public methodSetLooselyCoupledVectorAsync(AsyncHandle, IEnumerableByte)

Sets a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.
Public methodSetLooselyCoupledVectorAsyncT(AsyncHandle, FuncResponse, T, IEnumerableByte)

Sets a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.
Public methodSetScript

Sets values in script.

Public methodSetScriptAsync(String)

Sets values in script.

Public methodSetScriptAsync(AsyncHandle, String)

Sets values in script.

Public methodSetScriptBreakpoints

Set some breakpoints in the script of an app.

Public methodSetScriptBreakpointsAsync(IEnumerableEditorBreakpoint)

Set some breakpoints in the script of an app.

Public methodSetScriptBreakpointsAsync(AsyncHandle, IEnumerableEditorBreakpoint)

Set some breakpoints in the script of an app.

Public methodSetViewDlgSaveInfo

Sets the positions of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be set in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodSetViewDlgSaveInfoAsync(TableViewDlgSaveInfo)

Sets the positions of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be set in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodSetViewDlgSaveInfoAsync(AsyncHandle, TableViewDlgSaveInfo)

Sets the positions of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be set in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodUndo

Undoes the previous operation.

Public methodUndoAsync

Undoes the previous operation.

Public methodUndoAsync(AsyncHandle)

Undoes the previous operation.

Public methodUndoAsyncT(AsyncHandle, FuncResponse, T)

Undoes the previous operation.

Public methodUnlockAll

Unlocks all selections in all fields of the current app.

Public methodUnlockAllAsync(String)

Unlocks all selections in all fields of the current app.

Public methodUnlockAllAsync(AsyncHandle, String)

Unlocks all selections in all fields of the current app.

Public methodUnPublish

Unpublishes an app.

Public methodUnPublishAsync

Unpublishes an app.

Public methodUnPublishAsync(AsyncHandle)

Unpublishes an app.

Top
Extension Methods
  NameDescription
Public Extension MethodApplyBookmark
Apply bookmark
(Defined by AppExtensions.)
Public Extension MethodApplyBookmarkAsync
Apply bookmark
(Defined by AppExtensions.)
Public Extension MethodCreateAndLinkMasterObject
Create and link master object, this method will create a master object and will convert the source object to linked object (linked to the created master object).
(Defined by AppExtensions.)
Public Extension MethodCreateAndLinkMasterObjectAsync
Create and link master object, this method will create a master object and will convert the source object to linked object (linked to the created master object).
(Defined by AppExtensions.)
Public Extension MethodCreateBookmark
Create bookmark
(Defined by AppExtensions.)
Public Extension MethodCreateBookmarkAsync
Create bookmark
(Defined by AppExtensions.)
Public Extension MethodCreateDimension(String, DimensionProperties)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimension(String, String)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimension(String, IEnumerableString)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimensionAsync(String, DimensionProperties)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimensionAsync(String, String)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimensionAsync(String, IEnumerableString)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateMasterObject
Create master object, this method will create a master object from source object.
(Defined by AppExtensions.)
Public Extension MethodCreateMasterObjectAsync
Create master object, this method will create a master object from source object.
(Defined by AppExtensions.)
Public Extension MethodCreateMeasure(String, MeasureProperties)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateMeasure(String, String)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateMeasureAsync(String, MeasureProperties)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateMeasureAsync(String, String)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateSessionVariable
Create a session variable
(Defined by AppExtensions.)
Public Extension MethodCreateSessionVariableAsync
Create a session variable async
(Defined by AppExtensions.)
Public Extension MethodCreateSheet
Create sheet
(Defined by AppExtensions.)
Public Extension MethodCreateSheetAsync
Create sheet
(Defined by AppExtensions.)
Public Extension MethodCreateSnapshot(String, SnapshotProperties)Overloaded.
Create snapshot
(Defined by AppExtensions.)
Public Extension MethodCreateSnapshot(String, String, String, SnapshotObjectSizeDef)Overloaded.
Create Snapshot
(Defined by AppExtensions.)
Public Extension MethodCreateSnapshotAsync
Create snapshot
(Defined by AppExtensions.)
Public Extension MethodCreateStory
Create story
(Defined by AppExtensions.)
Public Extension MethodCreateStoryAsync
Create story
(Defined by AppExtensions.)
Public Extension MethodCreateVariableExpression
Create a variable expression
(Defined by AppExtensions.)
Public Extension MethodCreateVariableExpressionAsync
Create a variable expression async
(Defined by AppExtensions.)
Public Extension MethodDestroySessionVariableById
Destroy Session Variable by Name
(Defined by AppExtensions.)
Public Extension MethodDestroySessionVariableByIdAsync
Destroy Session Variable by Name Async
(Defined by AppExtensions.)
Public Extension MethodDestroyStory
Destroy story
(Defined by AppExtensions.)
Public Extension MethodDestroyStoryAsync
Destroy story
(Defined by AppExtensions.)
Public Extension MethodGetAppField
Get app field
(Defined by AppExtensions.)
Public Extension MethodGetAppFieldAsync
Get app field
(Defined by AppExtensions.)
Public Extension MethodGetAppFields
Get app fields
(Defined by AppExtensions.)
Public Extension MethodGetAppFieldsAsync
Get app fields
(Defined by AppExtensions.)
Public Extension MethodGetBookmark
Get bookmark
(Defined by AppExtensions.)
Public Extension MethodGetBookmarkAsync(String)Overloaded.
Get bookmark
(Defined by AppExtensions.)
Public Extension MethodGetBookmarkAsync(AsyncHandle, String)Overloaded.
Get bookmark
(Defined by AppExtensions.)
Public Extension MethodGetBookmarkList
(Defined by AppExtensions.)
Public Extension MethodGetBookmarkListAsync
(Defined by AppExtensions.)
Public Extension MethodGetCommonOperationsScript (Defined by ScriptExtensions.)
Public Extension MethodGetCurrentSelection
(Defined by AppExtensions.)
Public Extension MethodGetCurrentSelectionAsync
(Defined by AppExtensions.)
Public Extension MethodGetDimension
Get dimension
(Defined by AppExtensions.)
Public Extension MethodGetDimensionAsync(String)Overloaded.
Get dimension
(Defined by AppExtensions.)
Public Extension MethodGetDimensionAsync(AsyncHandle, String)Overloaded.
Get dimension
(Defined by AppExtensions.)
Public Extension MethodGetDimensionList
(Defined by AppExtensions.)
Public Extension MethodGetDimensionListAsync
(Defined by AppExtensions.)
Public Extension MethodGetExtendedCurrentSelection
Gets the extended current selections (gives you all the values, not a range as the normal current selection)
(Defined by SelectionExtensions.)
Public Extension MethodGetExtendedCurrentSelectionAsync
Gets the extended current selections (gives you all the values, not a range as the normal current selection)
(Defined by SelectionExtensions.)
Public Extension MethodGetExtensionList
(Defined by AppExtensions.)
Public Extension MethodGetExtensionListAsync
(Defined by AppExtensions.)
Public Extension MethodGetFieldList
(Defined by AppExtensions.)
Public Extension MethodGetFieldListAsync
(Defined by AppExtensions.)
Public Extension MethodGetMasterObject
Get master object
(Defined by AppExtensions.)
Public Extension MethodGetMasterObjectAsync(String)Overloaded.
Get master object
(Defined by AppExtensions.)
Public Extension MethodGetMasterObjectAsync(AsyncHandle, String)Overloaded.
Get master object
(Defined by AppExtensions.)
Public Extension MethodGetMasterObjectList
(Defined by AppExtensions.)
Public Extension MethodGetMasterObjectListAsync
(Defined by AppExtensions.)
Public Extension MethodGetMeasure
Get measure
(Defined by AppExtensions.)
Public Extension MethodGetMeasureAsync(String)Overloaded.
Get measure
(Defined by AppExtensions.)
Public Extension MethodGetMeasureAsync(AsyncHandle, String)Overloaded.
Get measure
(Defined by AppExtensions.)
Public Extension MethodGetMeasureList
(Defined by AppExtensions.)
Public Extension MethodGetMeasureListAsync
(Defined by AppExtensions.)
Public Extension MethodGetSheet
Get sheet
(Defined by AppExtensions.)
Public Extension MethodGetSheetAsync
Get sheet
(Defined by AppExtensions.)
Public Extension MethodGetSheetList
(Defined by AppExtensions.)
Public Extension MethodGetSheetListAsync
(Defined by AppExtensions.)
Public Extension MethodGetSheets
Get sheets
(Defined by AppExtensions.)
Public Extension MethodGetSheetsAsync
Get sheets
(Defined by AppExtensions.)
Public Extension MethodGetSnapshot
Get snapshot
(Defined by AppExtensions.)
Public Extension MethodGetSnapshotAsync(String)Overloaded.
Get snapshot
(Defined by AppExtensions.)
Public Extension MethodGetSnapshotAsync(AsyncHandle, String)Overloaded.
Get snapshot
(Defined by AppExtensions.)
Public Extension MethodGetSnapshotList
(Defined by AppExtensions.)
Public Extension MethodGetSnapshotListAsync
(Defined by AppExtensions.)
Public Extension MethodGetStories
Get stories
(Defined by AppExtensions.)
Public Extension MethodGetStoriesAsync
Get stories
(Defined by AppExtensions.)
Public Extension MethodGetStory
Get story
(Defined by AppExtensions.)
Public Extension MethodGetStoryAsync(String)Overloaded.
Get story
(Defined by AppExtensions.)
Public Extension MethodGetStoryAsync(AsyncHandle, String)Overloaded.
Get story
(Defined by AppExtensions.)
Public Extension MethodGetStoryList
(Defined by AppExtensions.)
Public Extension MethodGetStoryListAsync
(Defined by AppExtensions.)
Public Extension MethodGetUndoInfo
(Defined by AppExtensions.)
Public Extension MethodGetUndoInfoAsync
(Defined by AppExtensions.)
Public Extension MethodGetVariableList
(Defined by AppExtensions.)
Public Extension MethodGetVariableListAsync
(Defined by AppExtensions.)
Public Extension MethodLinkMasterObject
Link master object, this method will convert the source object to linked object (linked to the master object id).
(Defined by AppExtensions.)
Public Extension MethodLinkMasterObjectAsync
Link master object, this method will convert the source object to linked object (linked to the master object id).
(Defined by AppExtensions.)
Public Extension MethodRemoveBookmark
Remove bookmark
(Defined by AppExtensions.)
Public Extension MethodRemoveBookmarkAsync
Remove bookmark
(Defined by AppExtensions.)
Public Extension MethodRemoveDimension
Remove dimension
(Defined by AppExtensions.)
Public Extension MethodRemoveDimensionAsync
Remove dimension
(Defined by AppExtensions.)
Public Extension MethodRemoveMasterObject
Remove master object, this method will unlink all linked objects and remove the master object.
(Defined by AppExtensions.)
Public Extension MethodRemoveMasterObjectAsync
Remove master object, this method will unlink all linked objects and remove the master object.
(Defined by AppExtensions.)
Public Extension MethodRemoveMeasure
Remove measure
(Defined by AppExtensions.)
Public Extension MethodRemoveMeasureAsync
Remove measure
(Defined by AppExtensions.)
Public Extension MethodRemoveSheet
Remove sheet
(Defined by AppExtensions.)
Public Extension MethodRemoveSheetAsync
Remove sheet
(Defined by AppExtensions.)
Public Extension MethodRemoveSnapshot
Remove snapshot
(Defined by AppExtensions.)
Public Extension MethodRemoveSnapshotAsync
Remove snapshot
(Defined by AppExtensions.)
Public Extension MethodUnlinkMasterObject
Unlink master object, this method will convert the source object to the type of the master object.
(Defined by AppExtensions.)
Public Extension MethodUnlinkMasterObjectAsync
Unlink master object, this method will convert the source object to the type of the master object.
(Defined by AppExtensions.)
Top
See Also