Skip to main content Skip to complementary content

Qlik.Engine Namespace

Classes

AbstractStructure

A wrapper that can provide a typed interface for a JToken.

AlfaNumString
AlternateStateData
App

App / Doc class

AppEntry
AppIdentifier

Token to identify a unique Qlik Sense app

AppObjectList
AppObjectListDef
AppScript
AppScriptObject
ArrayOfNxValuePoint
AssociationScore
AsyncHandle

User created handle to asynchronous method request

Blob
BNFDef
Bookmark
BookmarkFieldItem
BookmarkFieldPage
BookmarkList
BookmarkListDef
BookmarkVariableItem
CalendarStrings
CharRange
CheckExpressionResult
CheckNumberOrExpressionResult
ChildList
ChildListDef
CodePage
CondDef
Connection
ConnectionInfo
ContentLibraryList
ContentLibraryListItem
CreateAppExResult
CreateAppResult
CreateBookmarkExResult
CreateChildResult
CreateChildResult<T>
CreateGenericBookmarkResult
CreateGenericDimensionResult
CreateGenericMeasureResult
CreateGenericObjectResult
CreateSessionAppFromAppResult
CreateSessionAppResult
CreateVariableExResult
CustomConnector
Database
DatabaseInfo
DatabaseOwner
DataField
DataPager

A class providing a paging interface for a pageable structure.

DataRecord
DataTable
DataTableEx
DelimiterInfo
DerivedFieldsInTableData
DimensionList
DimensionListDef
DoReloadExParams
DoReloadExResult
DriveInfo
DynamicStructure
EditorBreakpoint
Else
EmbeddedSnapshot
EmbeddedSnapshotDef
EncyptedSecretEntry
EngineApiVersion

Class for identifying the Qlik Sense Engine version that this build of the .Net SDK is based on.

ErrorData
ExpansionData
ExportDataResult
ExtendedLayoutBookmarkData
ExtendedPivotStateData
ExtensionList
ExtensionListDef
Field

This class describes all the methods that apply at field level.

The handle member in the JSON request for all methods listed in this section is the handle of the field.

FieldAttributes
FieldDefEx
FieldDescription
FieldInTableData
FieldInTableProfilingData
FieldList
FieldListDef
FieldOrColumn
FieldScores
FieldValue
FileDataFormat
FilterInfo
FolderItem
FrequencyDistributionData
Function
GenericAppObjectEntry
GenericAppObjectMetaData
GenericBookmark

This class describes all the methods that apply at bookmark level.

The handle member in the JSON request for all methods listed in this section is the handle of the bookmark.

GenericBookmarkEntry
GenericBookmarkLayout
GenericBookmarkProperties
GenericDerivedDefinitionEntry
GenericDerivedDefinitionProperties
GenericDerivedFieldEntry
GenericDerivedFieldEntryList
GenericDerivedFieldsProperties
GenericDimension

This class describes all the methods that apply at dimension level.

The handle member in the JSON request for all methods listed in this section is the handle of the dimension.

GenericDimensionInfo
GenericDimensionLayout
GenericDimensionProperties
GenericMeasure

This class describes all the methods that apply at measure level.

The handle member in the JSON request for all methods listed in this section is the handle of the measure.

GenericMeasureLayout
GenericMeasureProperties
GenericObject

This class describes all the methods that apply at generic object level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic object.

GenericObjectEntry
GenericObjectIdentifier
GenericObjectLayout
GenericObjectList
GenericObjectProperties
GenericObjectTypeOverrideAttribute
GenericUserState
GenericVariable

This class describes all the methods that apply at generic variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic variable.

GenericVariableEntry
GenericVariableEntryList
GenericVariableLayout
GenericVariableProperties
GetBaseBNFResult
GetBaseBNFStringResult
GetDatabaseTablePreviewResult
GetDerivedFieldResult
GetFileTableFieldsResult
GetFileTablePreviewResult
GetHyperCubeContinuousDataResult
GetInteractResult
GetMediaListResult
GetTablesAndKeysResult
GroupBookmarkData
GroupStateInfo
Hub

Represents the hub of a Qlik engine location and is based on the Global class of the engine API.

HyperCube
HyperCubeDef
HyperCubePager

A class providing a paging interface for a hypercube.

If
InputFieldItem
InteractDef
InterFieldSortData
InvalidPropertyAccessException

Exception indicating that a property in an object instance of a class derived from the AbstractStructure class has been accessed twice with incompatible types. Two types are considered compatible in this context if they are identical, if the type of the second type cast is a base class of the type of the first type class or if they are both subclasses of AbstractStructure.

JsonArray
JsonObject
JsonProperty
JSONWebTokenHeader
LayoutBookmarkData
LayoutExclude
LayoutFieldInfo
LineageGraph
LineageGraphEdge
LineageGraphMetaData
LineageGraphNode
LineageGraphNodes
LineageGraphOptions
LineageInfo
ListObject
ListObjectDef
ListObjectPager

A class providing a paging interface for a list object.

LocaleInfo
Location

Handles the location of the Qlik Sense instance

LocationExtensions

Some locations need to be accessed in a specific way, the default is using NTML Authentication to connect against a server installation and will not require any specific setup.

MasterObjectException
MeasureList
MeasureListDef
MediaList
MediaListDef
MediaListItem
MetaData
MethodInvocationException

The Exception thrown when a method has gone wrong on the server during execution.

MethodInvocationException.Error

Qlik Sense error

NxAppLayout
NxAppProperties
NxAttrDimDef
NxAttrDimInfo
NxAttrExprDef
NxAttrExprInfo
NxAttributeDimValues
NxAttributeExpressionValues
NxAutoSortByStateDef
NxAxisData
NxAxisTicks
NxBookmark
NxCalcCond
NxCardinalities
NxCell
NxCellMark
NxCellPosition
NxCellRows
NxConfigurationInfo
NxConnectivityManagerGetResponse
NxContainerEntry
NxContinuousDataOptions
NxContinuousRangeSelectInfo
NxCurrentSelectionItem
NxCustomProperty
NxDataAreaPage
NxDataPage
NxDerivedDefinition
NxDerivedDefinitionData
NxDerivedDefinitionInfo
NxDerivedDefinitionParameter
NxDerivedDefinitionParameterDesc
NxDerivedField
NxDerivedFieldDescriptionList
NxDerivedFieldsData
NxDerivedGroup
NxDimension
NxDimensionInfo
NxDownloadInfo
NxDownloadOptions
NxEngineSSESetting
NxEngineVersion
NxExpansionPath
NxExpressionCubeDef
NxExpressionCubeExpr
NxFeatureConfiguration
NxFieldDerivedDefinition
NxFieldDescription
NxFieldDescriptor
NxFieldProperties
NxFieldSelectionInfo
NxGeoBoundingBox
NxGeoCoordinate
NxGetBookmarkOptions
NxGetObjectOptions
NxGroupDerivedDefinition
NxGroupTail
NxHighlightRanges
NxInfo
NxInlineDimensionDef
NxInlineMeasureDef
NxLayoutErrors
NxLibraryDimension
NxLibraryDimensionDef
NxLibraryMeasure
NxLibraryMeasureDef
NxLinkedObjectInfo
NxListObjectExpression
NxListObjectExpressionDef
NxLocatedExpression
NxMatchingFieldInfo
NxMeasure
NxMeasureInfo
NxMeta
NxMetaDef
NxMiniChart
NxMiniChartCell
NxMiniChartData
NxMiniChartDef
NxMiniChartRows
NxMultiRangeSelectInfo
NxNotification
NxPage
NxPageTreeLevel
NxPageTreeNode
NxPatch
NxPatches
NxPivotDimensionCell
NxPivotPage
NxPivotValuePoint
NxQrsAddedDataSegment
NxQrsAddedObject
NxQrsApp
NxQrsAppContainer
NxQrsAppContentLibraryListItem
NxQrsAppDataSegmentOperation
NxQrsAppFileMeta
NxQrsAppObject
NxQrsAppObjectPrivileges
NxQrsAppResponse
NxQrsBulkRequest
NxQrsChunk
NxQrsConnection
NxQrsConnectionOperation
NxQrsContentLibraryListItem
NxQrsCreateResponse
NxQrsDatasegment
NxQrsEncryption
NxQrsEngineApp
NxQrsEngineService
NxQrsEngineSettings
NxQrsExternalChangeInfo
NxQrsMagicImportItem
NxQrsMediaListItem
NxQrsObjectOperation
NxQrsRestEndpointHandle
NxQrsRule
NxQrsStaticContentItem
NxQrsStaticContentListItem
NxQrsStaticContentOperation
NxQrsSyncTransaction
NxQrsUser
NxQrsUserFull
NxQvfBundledItem
NxRange
NxRangeSelectInfo
NxRules
NxSelectionCell
NxSelectionInfo
NxServiceConfiguration
NxSimpleDimValue
NxSimpleValue
NxStackedPivotCell
NxStackPage
NxStateCounts
NxStreamListEntry
NxSystemProperties
NxTickCell
NxTreeDataOption
NxTreeDimensionDef
NxTreeDimensionInfo
NxTreeMultiRangeSelectInfo
NxTreeNode
NxTreeRangeSelectInfo
NxTreeValue
NxTrendline
NxTrendlineDef
NxValidationError
NxVariableListItem
NxVariableProperties
NxViewPort
ObjectInterface
OdbcDsn
OleDbProvider
OtherTotalSpecProp
Pager

Used for paging when getting data from the engine.

PersistedObjectMeta
Point
PositionMark
ProgressData
ProgressMessage
PropertyContainer

Instances of this class represent objects known to the Qlik Sense Engine that follow the properties/layout pattern.

QcsLocation

Class for handling connections to Qlik Cloud Services.

QixClassBase

Instances of this class represent objects known to the Qlik Sense Engine.

QixNameAttribute

Contains the actual server name for a component

Range
RangeSelectInfo
Rect
SampleResult
ScriptSyntaxError
ScrollPosition
SearchableObject
SearchAssociationResult
SearchAttribute
SearchAttributeArray
SearchCharRange
SearchCombinationOptions
SearchFieldDictionary
SearchFieldMatch
SearchFieldMatchesItem
SearchFieldValueItem
SearchGroup
SearchGroupItem
SearchGroupItemMatch
SearchGroupItemOptions
SearchGroupOptions
SearchMatchCombination
SearchMatchCombinations
SearchObjectInternalOptions
SearchObjectOptions
SearchPage
SearchResult
SearchSuggestionResult
SearchSuggestItem
SearchTermResult
SearchValueOptions
SearchValuePage
SearchValueResult
SelectInfo
SelectionObject
SelectionObjectDef
Session

Contains Information to attach to a specific Qlik engine session When connecting to a Qlik Sense app you can work with sessions. Sessions specify who should see changes in an app, and are based on combining userId and session key.

SessionToken

Class for encapsulating the token string used to identify a Qlik Cloud Services session.

Size
SortCriteria
SourceKeyRecord
StaticContentList
StaticContentListItem
StaticContentUrl
StaticContentUrlDef
StoreTempSelectionStateResult
StringExpr

Expression class that evaluates to a string

StringExpression

Expression class that evaluates to a string

StringExpressionContainer

Wrapper class for a StringExpression object.

StructureDiff
SuspendedLayoutException

Exception indicating that a layout has been accessed while suspended.

SymbolFrequency
SymbolValue
TableProfilingData
TableRecord
TableRow
TableViewBroomPointSaveInfo
TableViewConnectionPointSaveInfo
TableViewCtlSaveInfo
TableViewDlgSaveInfo
TableViewSaveInfo
TableViewTableWinSaveInfo
TextMacro
Then
TreeData
TreeDataDef
UndoExclude
UndoInfo
UndoInfoDef
UriBindingException

Exception thrown when the system was unable to bind an uri to local qlik sense instance automatically

ValueClassAttribute

Describes that a class is static data only. When its parent object updates, this object will no longer be valid.

ValueExpr

Expression class that evaluates to a value

ValueExpression
ValueExpressionContainer

Wrapper class for a ValueExpression object.

Variable

This class describes all the methods that apply at variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the variable.

VariableList
VariableListDef

Interfaces

IAbstractStructure
IAlfaNumString
IAlternateStateData
IApp

App / Doc class

IAppEntry
IAppIdentifier

Token to identify a unique Qlik Sense app

IAppObjectList
IAppObjectListDef
IAppScript
IAppScriptObject
IArrayOfNxValuePoint
IAssociationScore
IBlob
IBNFDef
IBookmark
IBookmarkFieldItem
IBookmarkFieldPage
IBookmarkList
IBookmarkListDef
IBookmarkVariableItem
ICalendarStrings
IChangeNotifier

Interface used by classes that supports change notification.

ICharRange
ICheckExpressionResult
ICheckNumberOrExpressionResult
IChildList
IChildListDef
ICodePage
ICondDef
IConnection
IConnectionInfo
IContentLibraryList
IContentLibraryListItem
ICreateAppExResult
ICreateAppResult
ICreateBookmarkExResult
ICreateChildResult
ICreateChildResult<T>
ICreateGenericBookmarkResult
ICreateGenericDimensionResult
ICreateGenericMeasureResult
ICreateGenericObjectResult
ICreateSessionAppFromAppResult
ICreateSessionAppResult
ICreateVariableExResult
ICustomConnector
IDatabase
IDatabaseInfo
IDatabaseOwner
IDataField
IDataRecord
IDataTable
IDataTableEx
IDelimiterInfo
IDerivedFieldsInTableData
IDimensionList
IDimensionListDef
IDoReloadExParams
IDoReloadExResult
IDriveInfo
IDynamicStructure
IEditorBreakpoint
IElse
IEmbeddedSnapshot
IEmbeddedSnapshotDef
IEncyptedSecretEntry
IErrorData
IExpansionData
IExportDataResult
IExtendedLayoutBookmarkData
IExtendedPivotStateData
IExtensionList
IExtensionListDef
IField

This class describes all the methods that apply at field level.

The handle member in the JSON request for all methods listed in this section is the handle of the field.

IFieldAttributes
IFieldDefEx
IFieldDescription
IFieldInTableData
IFieldInTableProfilingData
IFieldList
IFieldListDef
IFieldOrColumn
IFieldScores
IFieldValue
IFileDataFormat
IFilterInfo
IFolderItem
IFrequencyDistributionData
IFunction
IGenericAppObjectEntry
IGenericAppObjectMetaData
IGenericBookmark

This class describes all the methods that apply at bookmark level.

The handle member in the JSON request for all methods listed in this section is the handle of the bookmark.

IGenericBookmarkEntry
IGenericBookmarkLayout
IGenericBookmarkProperties
IGenericDerivedDefinitionEntry
IGenericDerivedDefinitionProperties
IGenericDerivedFieldEntry
IGenericDerivedFieldEntryList
IGenericDerivedFieldsProperties
IGenericDimension

This class describes all the methods that apply at dimension level.

The handle member in the JSON request for all methods listed in this section is the handle of the dimension.

IGenericDimensionInfo
IGenericDimensionLayout
IGenericDimensionProperties
IGenericMeasure

This class describes all the methods that apply at measure level.

The handle member in the JSON request for all methods listed in this section is the handle of the measure.

IGenericMeasureLayout
IGenericMeasureProperties
IGenericObject

This class describes all the methods that apply at generic object level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic object.

IGenericObjectEntry
IGenericObjectIdentifier
IGenericObjectLayout
IGenericObjectList
IGenericObjectProperties
IGenericUserState
IGenericVariable

This class describes all the methods that apply at generic variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic variable.

IGenericVariableEntry
IGenericVariableEntryList
IGenericVariableLayout
IGenericVariableProperties
IGetBaseBNFResult
IGetBaseBNFStringResult
IGetDatabaseTablePreviewResult
IGetDerivedFieldResult
IGetFileTableFieldsResult
IGetFileTablePreviewResult
IGetHyperCubeContinuousDataResult
IGetInteractResult
IGetMediaListResult
IGetTablesAndKeysResult
IGroupBookmarkData
IGroupStateInfo
IHub
IHyperCube
IHyperCubeDef
IIf
IInputFieldItem
IInteractDef
IInterFieldSortData
IJsonArray
IJsonObject
IJsonProperty
IJSONWebTokenHeader
ILayoutBookmarkData
ILayoutExclude
ILayoutFieldInfo
ILineageGraph
ILineageGraphEdge
ILineageGraphMetaData
ILineageGraphNode
ILineageGraphNodes
ILineageGraphOptions
ILineageInfo
IListObject
IListObjectDef
ILocaleInfo
ILocation

Interface for Qlik Sense instance location handling

IMeasureList
IMeasureListDef
IMediaList
IMediaListDef
IMediaListItem
IMetaData
INxAppLayout
INxAppProperties
INxAttrDimDef
INxAttrDimInfo
INxAttrExprDef
INxAttrExprInfo
INxAttributeDimValues
INxAttributeExpressionValues
INxAutoSortByStateDef
INxAxisData
INxAxisTicks
INxBookmark
INxCalcCond
INxCardinalities
INxCell
INxCellMark
INxCellPosition
INxCellRows
INxConfigurationInfo
INxConnectivityManagerGetResponse
INxContainerEntry
INxContinuousDataOptions
INxContinuousRangeSelectInfo
INxCurrentSelectionItem
INxCustomProperty
INxDataAreaPage
INxDataPage
INxDerivedDefinition
INxDerivedDefinitionData
INxDerivedDefinitionInfo
INxDerivedDefinitionParameter
INxDerivedDefinitionParameterDesc
INxDerivedField
INxDerivedFieldDescriptionList
INxDerivedFieldsData
INxDerivedGroup
INxDimension
INxDimensionInfo
INxDownloadInfo
INxDownloadOptions
INxEngineSSESetting
INxEngineVersion
INxExpansionPath
INxExpressionCubeDef
INxExpressionCubeExpr
INxFeatureConfiguration
INxFieldDerivedDefinition
INxFieldDescription
INxFieldDescriptor
INxFieldProperties
INxFieldSelectionInfo
INxGeoBoundingBox
INxGeoCoordinate
INxGetBookmarkOptions
INxGetObjectOptions
INxGroupDerivedDefinition
INxGroupTail
INxHighlightRanges
INxInfo
INxInlineDimensionDef
INxInlineMeasureDef
INxLayoutErrors
INxLibraryDimension
INxLibraryDimensionDef
INxLibraryMeasure
INxLibraryMeasureDef
INxLinkedObjectInfo
INxListObjectExpression
INxListObjectExpressionDef
INxLocatedExpression
INxMatchingFieldInfo
INxMeasure
INxMeasureInfo
INxMeta
INxMetaDef
INxMiniChart
INxMiniChartCell
INxMiniChartData
INxMiniChartDef
INxMiniChartRows
INxMultiRangeSelectInfo
INxNotification
INxPage
INxPageTreeLevel
INxPageTreeNode
INxPatch
INxPatches
INxPivotDimensionCell
INxPivotPage
INxPivotValuePoint
INxQrsAddedDataSegment
INxQrsAddedObject
INxQrsApp
INxQrsAppContainer
INxQrsAppContentLibraryListItem
INxQrsAppDataSegmentOperation
INxQrsAppFileMeta
INxQrsAppObject
INxQrsAppObjectPrivileges
INxQrsAppResponse
INxQrsBulkRequest
INxQrsChunk
INxQrsConnection
INxQrsConnectionOperation
INxQrsContentLibraryListItem
INxQrsCreateResponse
INxQrsDatasegment
INxQrsEncryption
INxQrsEngineApp
INxQrsEngineService
INxQrsEngineSettings
INxQrsExternalChangeInfo
INxQrsMagicImportItem
INxQrsMediaListItem
INxQrsObjectOperation
INxQrsRestEndpointHandle
INxQrsRule
INxQrsStaticContentItem
INxQrsStaticContentListItem
INxQrsStaticContentOperation
INxQrsSyncTransaction
INxQrsUser
INxQrsUserFull
INxQvfBundledItem
INxRange
INxRangeSelectInfo
INxRules
INxSelectionCell
INxSelectionInfo
INxServiceConfiguration
INxSimpleDimValue
INxSimpleValue
INxStackedPivotCell
INxStackPage
INxStateCounts
INxStreamListEntry
INxSystemProperties
INxTickCell
INxTreeDataOption
INxTreeDimensionDef
INxTreeDimensionInfo
INxTreeMultiRangeSelectInfo
INxTreeNode
INxTreeRangeSelectInfo
INxTreeValue
INxTrendline
INxTrendlineDef
INxValidationError
INxVariableListItem
INxVariableProperties
INxViewPort
IObjectInterface
IOdbcDsn
IOleDbProvider
IOtherTotalSpecProp
IPersistedObjectMeta
IPoint
IPositionMark
IProgressData
IProgressMessage
IPropertyContainer
IQcsLocation

Interface for handling connections to Qlik Cloud Services.

IQixClassBase
IRange
IRangeSelectInfo
IRect
ISampleResult
IScriptSyntaxError
IScrollPosition
ISearchableObject
ISearchAssociationResult
ISearchAttribute
ISearchAttributeArray
ISearchCharRange
ISearchCombinationOptions
ISearchFieldDictionary
ISearchFieldMatch
ISearchFieldMatchesItem
ISearchFieldValueItem
ISearchGroup
ISearchGroupItem
ISearchGroupItemMatch
ISearchGroupItemOptions
ISearchGroupOptions
ISearchMatchCombination
ISearchMatchCombinations
ISearchObjectInternalOptions
ISearchObjectOptions
ISearchPage
ISearchResult
ISearchSuggestionResult
ISearchSuggestItem
ISearchTermResult
ISearchValueOptions
ISearchValuePage
ISearchValueResult
ISelectInfo
ISelectionObject
ISelectionObjectDef
ISession

Contains Information to attach to a specific qlik engine session When connecting to a Qlik Sense app you can work with sessions. Sessions specify who should see changes in an app, and are based on combining userId and session key.

ISize
ISortCriteria
ISourceKeyRecord
IStaticContentList
IStaticContentListItem
IStaticContentUrl
IStaticContentUrlDef
IStoreTempSelectionStateResult
IStringExpr
IStringExpression
IStringExpressionContainer
IStructureDiff
ISymbolFrequency
ISymbolValue
ITableProfilingData
ITableRecord
ITableRow
ITableViewBroomPointSaveInfo
ITableViewConnectionPointSaveInfo
ITableViewCtlSaveInfo
ITableViewDlgSaveInfo
ITableViewSaveInfo
ITableViewTableWinSaveInfo
ITextMacro
IThen
ITreeData
ITreeDataDef
IUndoExclude
IUndoInfo
IUndoInfoDef
IValueExpr
IValueExpression
IValueExpressionContainer
IVariable

This class describes all the methods that apply at variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the variable.

IVariableList
IVariableListDef

Enums

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!