diff --git a/types/qlik-engineapi/index.d.ts b/types/qlik-engineapi/index.d.ts index 8cb5d2e3c2..57066c4e94 100644 --- a/types/qlik-engineapi/index.d.ts +++ b/types/qlik-engineapi/index.d.ts @@ -420,9 +420,6 @@ declare namespace EngineAPI { */ qThou: string; - /** - * - */ qSAFEARRAY: any[]; } @@ -1036,7 +1033,7 @@ declare namespace EngineAPI { /** * String that marks the beginning of the comment line. - * Example: “#” or “//” + * Example: # or // * The engine ignores the commented lines during the data load. * This property is only used for delimited files. */ @@ -2135,11 +2132,11 @@ declare namespace EngineAPI { * For example, if the user requests SearchObjects with SearchObjectOptions.qAttributes = [], * then the outputted qAttributes will be empty. * - * Otherwise, if SearchObjectOptions.qAttributes = [“qProperty”], - * SearchGroupItemMatch.qAttributes = [“qProperty”, qMetaDef/title”] + * Otherwise, if SearchObjectOptions.qAttributes = [qProperty], + * SearchGroupItemMatch.qAttributes = [qProperty, qMetaDef/title] * if the match has been found in the title of the item. * - * For dimension values, the returned “qProperty” will be “*”. + * For dimension values, the returned qProperty will be *. */ qAttributes: ISearchAttribute[]; @@ -2298,44 +2295,44 @@ declare namespace EngineAPI { /** * Aborts any selection mode in an app. For more information about selection mode! - * @param {boolean} qAccept - Set this parameter to true to accept the selections before exiting the selection mode. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qAccept - Set this parameter to true to accept the selections before exiting the selection mode. + * @returns - A promise of a Qlik engine reply. */ abortModal(qAccept: boolean): Promise; /** * 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. - * @param {string} qStateName - Name of the alternate state. >> This parameter is mandatory. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qStateName - Name of the alternate state. >> This parameter is mandatory. + * @returns - A promise of a Qlik engine reply. */ addAlternateState(qStateName: string): Promise; /** * Adds a field on the fly. The expression of a field on the fly is persisted but not its values. - * @param {string} qName - Name of the field. - * @param {string} qExpr - Expression value. It is not possible to use all aggregation functions. + * @param qName - Name of the field. + * @param qExpr - 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 {Promise} - true or false + * @returns - true or false */ addFieldFromExpression(qName: string, qExpr: string): Promise; /** * Applies a bookmark. - * @param {string} qId - Identifier of the bookmark. - * @returns {Promise} - true or false + * @param qId - Identifier of the bookmark. + * @returns - true or false */ applyBookmark(qId: string): Promise; /** * Returns the number of entries on the Back stack.. - * @returns {Promise} - "qReturn": + * @returns - "qReturn": */ backCount(): Promise; /** * Loads the last logical operation (if any). - * @returns {Promise} - "{}" + * @returns - "{}" */ back(): Promise; @@ -2343,9 +2340,9 @@ declare namespace EngineAPI { * Checks if a given expression is valid. * * Note: The expression is correct if the parameters qErrorMsg, qBadFieldNames and qDangerousFieldNames are empty. - * @param {string} qExpr - Expression to check.. - * @param {Array} qLabels - (Array of String) List of labels. This parameter is optional. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qExpr - Expression to check.. + * @param qLabels - (Array of String) List of labels. This parameter is optional. + * @returns - A promise of a Qlik engine reply. */ checkExpression(qExpr: string, qLabels?: string[]): Promise; @@ -2356,8 +2353,8 @@ declare namespace EngineAPI { * - a number is correct according to the locale. * * Note: The expression is correct if the parameters qErrorMsg and qBadFieldNames are empty. - * @param {string} qExpr - Expression to check. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qExpr - Expression to check. + * @returns - A promise of a Qlik engine reply. */ checkNumberOrExpression(qExpr: string): Promise; @@ -2380,26 +2377,26 @@ declare namespace EngineAPI { /** * Clears all selections in all fields of the current app. - * @param {Boolean} qLockedAlso - This parameter is optional. Default is false. Selections on locked fields are not cleared. + * @param qLockedAlso - This parameter is optional. Default is false. Selections on locked fields are not cleared. * Set this parameter to true to clear all selections, including the locked fields. - * @param {String} qStateName - Name of the alternate state. If an alternate state is defined in qStateName, only the selections + * @param qStateName - Name of the alternate state. If an alternate state is defined in qStateName, only the selections * related to this alternate state are cleared. This parameter is optional. * Default state is current selections. - * @returns {Promise} - A promise of a Qlik engine reply. + * @returns - A promise of a Qlik engine reply. */ clearAll(qLockedAlso: boolean, qStateName?: string): Promise; /** * Clears entirely the undo and redo buffer. - * @returns {Promise} - A promise of a Qlik engine reply. + * @returns - A promise of a Qlik engine reply. */ clearUndoBuffer(): Promise; /** * Clones a bookmark. * - * @param {String} qId - Identifier of the object to clone - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qId - Identifier of the object to clone + * @returns - A promise of a Qlik engine reply. */ cloneBookmark(qId: string): Promise; @@ -2407,8 +2404,8 @@ declare namespace EngineAPI { * Clones a dimension. * * Note: The identifier is set by the engine. - * @param {String} qId - Identifier of the object to clone - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qId - Identifier of the object to clone + * @returns - A promise of a Qlik engine reply. */ cloneDimension(qId: string): Promise; @@ -2416,8 +2413,8 @@ declare namespace EngineAPI { * Clones a measure. * * Note: The identifier is set by the engine. - * @param {String} qId - Identifier of the object to clone - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qId - Identifier of the object to clone + * @returns - A promise of a Qlik engine reply. */ cloneMeasure(qId: string): Promise; @@ -2426,8 +2423,8 @@ declare namespace EngineAPI { * When you clone an object that contains children, the children are cloned as well. * * Note: The identifier is set by the engine. - * @param {String} qId - Identifier of the object to clone - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qId - Identifier of the object to clone + * @returns - A promise of a Qlik engine reply. */ cloneObject(qId: string): Promise; @@ -2436,22 +2433,22 @@ declare namespace EngineAPI { * Committing a draft replaces the corresponding published object. * * Note: The identifier is set by the engine. - * @param {String} qId - Identifier of the draft to commit. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qId - Identifier of the draft to commit. + * @returns - A promise of a Qlik engine reply. */ commitDraft(qId: string): Promise; /** * Creates a bookmark. - * @param {GenericBookmarkProperties} qProp - Information about the object. >> This parameter is mandatory. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qProp - Information about the object. >> This parameter is mandatory. + * @returns - A promise of a Qlik engine reply. */ createBookmark(qProp: IGenericBookmarkProperties): Promise; /** * Creates a connection. A connection indicates from which data source, the data should be taken. - * @param {Connection} qConnection - Information about the connection. >> This parameter is mandatory. - * @returns {Promise} - returns a ConnectionId + * @param qConnection - Information about the connection. >> This parameter is mandatory. + * @returns - returns a ConnectionId */ createConnection(qConnection: IConnection): Promise; @@ -2459,8 +2456,8 @@ declare namespace EngineAPI { * 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. - * @param {GenericDimensionProperties} qProp - Information about the properties. >> This parameter is mandatory. - * @returns {Promise} - returns a GenericDimension object + * @param qProp - Information about the properties. >> This parameter is mandatory. + * @returns - returns a GenericDimension object */ createDimension(qProp: IGenericDimensionProperties): Promise; @@ -2471,8 +2468,8 @@ declare namespace EngineAPI { * Replace the published object by the content of the draft by invoking the CommitDraft method. * * Note: The identifier is set by the engine. - * @param {String} qId - Identifier of the object to create a draft from. - * @returns {Promise} - returns a DraftId + * @param qId - Identifier of the object to create a draft from. + * @returns - returns a DraftId */ createDraft(qId: string): Promise; @@ -2480,8 +2477,8 @@ declare namespace EngineAPI { * 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. - * @param {GenericMeasureProperties} gProp - Information about the properties >> This parameter is mandatory. - * @returns {Promise} - returns a GenericMeasure + * @param gProp - Information about the properties >> This parameter is mandatory. + * @returns - returns a GenericMeasure */ createMeasure(qProp: IGenericMeasureProperties): Promise; @@ -2492,8 +2489,8 @@ declare namespace EngineAPI { * 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. * Notre: The linking object cannot be a transient object. - * @param {GenericObjectProperties} gProp - Information about the properties >> This parameter is mandatory. - * @returns {Promise} - returns a GenericObject + * @param gProp - Information about the properties >> This parameter is mandatory. + * @returns - returns a GenericObject */ createObject(qProp: IGenericObjectProperties): Promise; @@ -2503,24 +2500,24 @@ declare namespace EngineAPI { * 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. - * @param {GenericObjectProperties} gProp - Information about the properties >> This parameter is mandatory. - * @returns {Promise} - returns a GenericObject + * @param gProp - Information about the properties >> This parameter is mandatory. + * @returns - returns a GenericObject */ createSessionObject(qProp: IGenericObjectProperties): Promise; /** * Creates a transient variable. - * @param {GenericVariableProperties} gProp - Name of the variable. Variable names are case sensitive. + * @param gProp - Name of the variable. Variable names are case sensitive. * >> This parameter is mandatory. - * @returns {Promise} - returns a GenericVariable + * @returns - returns a GenericVariable */ createSessionVariable(qProp: IGenericVariableProperties): Promise; /** * Creates a variable. * * Note: This method is deprecated (not recommended to use). Use CreateVariableEx method instead. - * @param {String} qName - Name of the variable. Variable names are case sensitive. >> This parameter is mandatory. - * @returns {Promise} - returns a Boolean + * @param qName - Name of the variable. Variable names are case sensitive. >> This parameter is mandatory. + * @returns - returns a Boolean */ createVariable(qName: string): Promise; @@ -2528,9 +2525,9 @@ declare namespace EngineAPI { * Creates a variable. * * Note: This method is deprecated (not recommended to use). Use CreateVariableEx method instead. - * @param {GenericVariableProperties} qProp - Name of the variable. Variable names are case sensitive and must be unique. + * @param qProp - Name of the variable. Variable names are case sensitive and must be unique. * >> This parameter is mandatory. - * @returns {Promise} - returns a NxInfo. Identifier and type of the object. >> This parameter is mandatory. + * @returns - returns a NxInfo. Identifier and type of the object. >> This parameter is mandatory. */ createVariableEx(qProp: IGenericVariableProperties): Promise; @@ -2539,8 +2536,8 @@ declare namespace EngineAPI { * The AttachedFiles connection can only be removed by the administrator of the system. * * Note: In Qlik Sense Enterprise, there is an additional file connection named AttachedFiles. - * @param {String} qConnectionId - Identifier of the connection to remove. >> This parameter is mandatory. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qConnectionId - Identifier of the connection to remove. >> This parameter is mandatory. + * @returns - A promise of a Qlik engine reply. */ deleteConnection(qConnectionId: string): Promise; @@ -2548,8 +2545,8 @@ declare namespace EngineAPI { * Removes a bookmark. * * Note: The operation is successful if qSuccess is set to true. - * @param {String} qId - Identifier of the bookmark - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the bookmark + * @returns - A promise of Boolean */ destroyBookmark(qId: string): Promise; @@ -2557,8 +2554,8 @@ declare namespace EngineAPI { * Removes a dimension. * * Note: The operation is successful if qSuccess is set to true. - * @param {String} qId - Identifier of the dimension to remove. >> This parameter is mandatory. - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the dimension to remove. >> This parameter is mandatory. + * @returns - A promise of Boolean */ destroyDimension(qId: string): Promise; @@ -2566,9 +2563,9 @@ declare namespace EngineAPI { * Removes a dimension. * * Note: The operation is successful if qSuccess is set to true. - * @param {String} qId - Identifier of the draft object to remove. >> This parameter is mandatory. - * @param {String} qSourceId - Identifier of the source object (the object from which a draft was created). - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the draft object to remove. >> This parameter is mandatory. + * @param qSourceId - Identifier of the source object (the object from which a draft was created). + * @returns - A promise of Boolean */ destroyDraft(qId: string, qSourceId: string): Promise; @@ -2576,8 +2573,8 @@ declare namespace EngineAPI { * Removes a generic measure. * * Note: The operation is successful if qSuccess is set to true. - * @param {String} qId - Identifier of the measure to remove. >> This parameter is mandatory. - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the measure to remove. >> This parameter is mandatory. + * @returns - A promise of Boolean */ destroyMeasure(qId: string): Promise; @@ -2585,8 +2582,8 @@ declare namespace EngineAPI { * Removes an app object. * * Note: The operation is successful if qSuccess is set to true. - * @param {String} qId - Identifier of the object to remove. >> This parameter is mandatory. - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the object to remove. >> This parameter is mandatory. + * @returns - A promise of Boolean */ destroyObject(qId: string): Promise; @@ -2594,8 +2591,8 @@ declare namespace EngineAPI { * Removes a transient object. * * Note: The operation is successful if qSuccess is set to true. - * @param {String} qId - Identifier of the object to remove. >> This parameter is mandatory. - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the object to remove. >> This parameter is mandatory. + * @returns - A promise of Boolean */ destroySessionObject(qId: string): Promise; @@ -2603,8 +2600,8 @@ declare namespace EngineAPI { * Removes a transient variable. * * Note: The operation is successful if qSuccess is set to true. - * @param {String} qId - Identifier of the object to remove. >> This parameter is mandatory. - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the object to remove. >> This parameter is mandatory. + * @returns - A promise of Boolean */ destroySessionVariable(qId: string): Promise; @@ -2613,8 +2610,8 @@ declare namespace EngineAPI { * * Note: The operation is successful if qSuccess is set to true. * Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. - * @param {String} qId - Identifier of the variable. - * @returns {Promise} - A promise of Boolean + * @param qId - Identifier of the variable. + * @returns - A promise of Boolean */ destroyVariableById(qId: string): Promise; @@ -2623,8 +2620,8 @@ declare namespace EngineAPI { * * Note: The operation is successful if qSuccess is set to true. * Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. - * @param {String} qName - Name of the variable.. - * @returns {Promise} - A promise of Boolean + * @param qName - Name of the variable.. + * @returns - A promise of Boolean */ destroyVariableByName(qName: string): Promise; @@ -2632,19 +2629,19 @@ declare namespace EngineAPI { * Reloads the script that is set in an app. * * Note: The operation is successful if qSuccess is set to true. - * @param {Integer} qMode - Error handling mode. + * @param qMode - Error handling mode. * * 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. * * This parameter is optional. - * @param {Boolean} qPartial - Set to true for partial reload. This parameter is optional. + * @param qPartial - Set to true for partial reload. This parameter is optional. * The default value is false. - * @param {Boolean} qDebug - Set to true if debug breakpoints are to be honored. + * @param qDebug - Set to true if debug breakpoints are to be honored. * The execution of the script will be in debug mode. * This parameter is optional. The default value is false. - * @returns {Promise} - A promise of Boolean + * @returns - A promise of Boolean */ doReload(qMode?: number, qPartial?: boolean, qDebug?: boolean): Promise; @@ -2652,8 +2649,8 @@ declare namespace EngineAPI { * Reloads the script that is set in an app and returns the path to the script log file. * * Note: A log file is created per reload. - * @param {DoReloadExParams} qParams - This parameter is optional. - * @returns {Promise} - If the data load has successfully finished, no matter how the indexing behaves, true is returned. + * @param qParams - This parameter is optional. + * @returns - 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. */ doReloadEx(qParams?: IDoReloadExParams): Promise; @@ -2661,24 +2658,24 @@ declare namespace EngineAPI { /** * Saves an app. All objects and data in the data model are saved. * Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. - * @param {String} qFileName - Name of the file to save. This parameter is optional. - * @returns {Promise} - A promise of a Qlik engine reply. + * @param qFileName - Name of the file to save. This parameter is optional. + * @returns - A promise of a Qlik engine reply. */ doSave(qFileName?: string): Promise; /** * Evaluates an expression as a string. * Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. - * @param {String} qExpression - Expression to evaluate. - * @returns {Promise} - return a expression evaluated as a string + * @param qExpression - Expression to evaluate. + * @returns - return a expression evaluated as a string */ evaluate(qExpression: string): Promise; /** * Evaluates an expression as a dual. * Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. - * @param {String} qExpression - Expression to evaluate. - * @returns {Promise} - return a Promise width a FieldValue + * @param qExpression - Expression to evaluate. + * @returns - return a Promise width a FieldValue */ evaluateEx(qExpression: string): Promise; @@ -2686,65 +2683,65 @@ declare namespace EngineAPI { * 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. - * @param {String} qFieldName - Name of the field. This method looks for fields that + * @param qFieldName - Name of the field. This method looks for fields that * belong to the same archipelago as this specified field. - * @param {Array} qTags - List of tags. This method looks for fields that match at least one of the tags in this list. - * @returns {Promise} - A promise of FieldValue. + * @param qTags - List of tags. This method looks for fields that match at least one of the tags in this list. + * @returns - A promise of FieldValue. */ findMatchingFields(qFieldName: string, qTags: string[]): Promise; /** * Loads the next logical operation (if any). - * @returns {Promise} - A promise of a Qlik engine reply. + * @returns - A promise of a Qlik engine reply. */ forward(): Promise; /** * Returns the number of entries on the Forward stack. - * @returns {Promise} - A promise and Number of entries in the forward stack + * @returns - A promise and Number of entries in the forward stack */ forwardCount(): Promise; /** * Returns the identifier and the type of any generic object in the app. * Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. - * @param {Array} qInfos - (Array of NxInfo) Information about all generic objects in the app. - * @returns {Promise} - return a Promise Array of INxInfo + * @param qInfos - (Array of NxInfo) Information about all generic objects in the app. + * @returns - return a Promise Array of INxInfo */ getAllInfos(): Promise; /** * Returns dynamic properties (if any) in addition to the engine (fixed) properties. * Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. - * @returns {Promise} - return a Promise of a data set NxAppLayout + * @returns - return a Promise of a data set NxAppLayout */ getAppLayout(): Promise; /** * Gets the properties of an app. - * @returns {Promise} - return a Promise of NxAppProperties qProp. Information about the properties of the app. + * @returns - return a Promise of NxAppProperties qProp. Information about the properties of the app. */ getAppProperties(): Promise; /** * Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app. - * @param {String} qTable1 - Name of the first table. - * @param {String} qTable2 - Name of the second table. - * @returns {Promise} - return a Promise of IAssociationScore qScore. + * @param qTable1 - Name of the first table. + * @param qTable2 - Name of the second table. + * @returns - return a Promise of IAssociationScore qScore. */ getAssociationScores(qTable1: string, qTable2: string): Promise; /** * Returns the handle of a bookmark. - * @param {String} qId - Identifier of the bookmark. - * @returns {Promise} - return a Promise of IGenericBookmark. + * @param qId - Identifier of the bookmark. + * @returns - return a Promise of IGenericBookmark. */ getBookmark(qId: string): Promise; /** * Returns a list of bookmarks in the app. - * @param {INxGetBookmarkOptions} qOptions - Information about the list of bookmarks. - * @returns {Promise} - return a Promise of INxContainerEntry. + * @param qOptions - Information about the list of bookmarks. + * @returns - return a Promise of INxContainerEntry. */ getBookmarks(qOptions: INxGetBookmarkOptions): Promise>; @@ -2755,8 +2752,8 @@ declare namespace EngineAPI { * - The type of the connection * - The name of the connection * - The connection string - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @returns {Promise} - return a Connection. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @returns - return a Connection. */ getConnection(qConnectionId: string): Promise; @@ -2765,7 +2762,7 @@ declare namespace EngineAPI { * * Note: In Qlik Sense Enterprise, there is an additional file connection named AttachedFiles. * This connection is stored in the Qlik Sense repository. - * @returns {Promise} - return a Promise of Array of Connection. + * @returns - return a Promise of Array of Connection. */ getConnections(): Promise; @@ -2776,71 +2773,71 @@ declare namespace EngineAPI { * If this property is set to true, it means that the content library is app specific. * * Note: There is always one specific content library per app. - * @returns {Promise} - return a Promise of ContentLibraryList. + * @returns - return a Promise of ContentLibraryList. */ getContentLibraries(): Promise; /** * Gives information about an ODBC, OLEDB or CUSTOM connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @returns {Promise} - return a Promise of DatabaseInfo. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @returns - return a Promise of DatabaseInfo. */ getDatabaseInfo(qConnectionId: string): Promise; /** * Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qDatabase - Name of the database. >> This parameter is mandatory. - * @returns {Promise} - return a Promise Array of DatabaseOwner. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qDatabase - Name of the database. >> This parameter is mandatory. + * @returns - return a Promise Array of DatabaseOwner. */ getDatabaseOwners(qConnectionId: string, qDatabase?: string): Promise; /** * Lists the databases inside a ODBC, OLEDB or CUSTOM data source. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @returns {Promise} - return a Promise Array of Database. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @returns - return a Promise Array of Database. */ getDatabases(qConnectionId: string): Promise; /** * Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qDatabase - Name of the database. >> This parameter is mandatory. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qDatabase - Name of the database. >> This parameter is mandatory. * (If qDatabase is not set then qOwner must be set.) - * @param {String} qOwner - Owner of the database. >> This parameter is mandatory. + * @param qOwner - Owner of the database. >> This parameter is mandatory. * (If qOwner is not set then qDatabase must be set.) - * @param {String} qTable - Name of the table. >> This parameter is mandatory. - * @returns {Promise} - return a Promise Array of DataField. + * @param qTable - Name of the table. >> This parameter is mandatory. + * @returns - return a Promise Array of DataField. */ getDatabaseTableFields(qConnectionId: string, qTable: string, qDatabase?: string, qOwner?: string): Promise; /** * Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qDatabase - Name of the database. >> This parameter is mandatory. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qDatabase - Name of the database. >> This parameter is mandatory. * (If qDatabase is not set then qOwner must be set.) - * @param {String} qOwner - Owner of the database. >> This parameter is mandatory. + * @param qOwner - Owner of the database. >> This parameter is mandatory. * (If qOwner is not set then qDatabase must be set.) - * @param {String} qTable - Name of the table. >> This parameter is mandatory. - * @returns {Promise} - return a Promise Array of DataRecord. + * @param qTable - Name of the table. >> This parameter is mandatory. + * @returns - return a Promise Array of DataRecord. */ getDatabaseTablePreview(qConnectionId: string, qTable: string, qDatabase?: string, qOwner?: string): Promise; /** * Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qDatabase - Name of the database. >> This parameter is mandatory. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qDatabase - Name of the database. >> This parameter is mandatory. * (If qDatabase is not set then qOwner must be set.) - * @param {String} qOwner - Owner of the database. >> This parameter is mandatory. + * @param qOwner - Owner of the database. >> This parameter is mandatory. * (If qOwner is not set then qDatabase must be set.) - * @returns {Promise} - return a Promise Array of DataTable. + * @returns - return a Promise Array of DataTable. */ getDatabaseTables(qConnectionId: string, qDatabase?: string, qOwner?: string): Promise; /** * Returns the handle of a dimension. - * @param {String} qId - Identifier of the dimension. >> This parameter is mandatory. - * @returns {Promise} - return a Promise GenericDimension. + * @param qId - Identifier of the dimension. >> This parameter is mandatory. + * @returns - return a Promise GenericDimension. */ getDimension(qId: string): Promise; @@ -2849,67 +2846,67 @@ declare namespace EngineAPI { * This section contains Set statements that give localized information from the regional settings of the computer. * * Note: The computer regional settings are retrieved when the engine starts. - * @param {String} qLocalizedMainSection - Name of the script section. The default value is Main. This parameter is optional. - * @returns {Promise} - return a Promise . + * @param qLocalizedMainSection - Name of the script section. The default value is Main. This parameter is optional. + * @returns - return a Promise . */ getEmptyScript(qLocalizedMainSection?: string): Promise; /** * Retrieves the variables that are tagged as favorite. - * @returns {Promise} - return a Promise Array of String + * @returns - return a Promise Array of String */ getFavoriteVariables(): Promise; /** * Retrieves the description of a field. - * @param {String} qFieldName - Name of the field. >> This parameter is mandatory - * @returns {Promise} - return a Promise of FieldDescription. + * @param qFieldName - Name of the field. >> This parameter is mandatory + * @returns - return a Promise of FieldDescription. */ getFieldDescription(qFieldName: string): Promise; /** * Retrieves the description of a field. - * @param {String} qFieldName - Name of the field. >> This parameter is mandatory. - * @param {String} qStateName - Name of the alternate state. This parameter is optional. Default state is current selections. - * @returns {Promise} - return a Promise of FieldDescription. + * @param qFieldName - Name of the field. >> This parameter is mandatory. + * @param qStateName - Name of the alternate state. This parameter is optional. Default state is current selections. + * @returns - return a Promise of FieldDescription. */ getField(qFieldName: string, qStateName?: string): Promise; /** * Lists the fields of a table for a folder connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qRelativePath - Path of the connection file. This parameter is optional. - * @param {FileDataFormat} qDataFormat - Type of the file. - * @param {String} qTable - Name of the table. This parameter must be set for XLS, XLSX, HTML and XML files. - * @returns {Promise} - return a Promise Array of DataField or String. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qRelativePath - Path of the connection file. This parameter is optional. + * @param qDataFormat - Type of the file. + * @param qTable - Name of the table. This parameter must be set for XLS, XLSX, HTML and XML files. + * @returns - return a Promise Array of DataField or String. */ getFileTableFields(qConnectionId: string, qDataFormat: IFileDataFormat, qTable: string, qRelativePath?: string): Promise | Promise; /** * Lists the values in a table for a folder connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qRelativePath - Path of the connection file. This parameter is optional. - * @param {FileDataFormat} qDataFormat - Type of the file. - * @param {String} qTable - Name of the table. This parameter must be set for XLS, XLSX, HTML and XML files. - * @returns {Promise} - return a Promise or . + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qRelativePath - Path of the connection file. This parameter is optional. + * @param qDataFormat - Type of the file. + * @param qTable - Name of the table. This parameter must be set for XLS, XLSX, HTML and XML files. + * @returns - return a Promise or . */ getFileTablePreview(qConnectionId: string, qRelativePath: string, qDataFormat: IFileDataFormat, qTable: string): Promise | Promise; /** * Lists the tables and fields of a JSON or XML file for a folder connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qRelativePath - Path of the connection file. This parameter is optional. - * @param {FileDataFormat} qDataFormat - Type of the file. - * @returns {Promise} - return a Promise Array of DataTableEx. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qRelativePath - Path of the connection file. This parameter is optional. + * @param qDataFormat - Type of the file. + * @returns - return a Promise Array of DataTableEx. */ getFileTablesEx(qConnectionId: string, qRelativePath: string, qDataFormat: IFileDataFormat): Promise; /** * Lists the tables for a folder connection. - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qRelativePath - Path of the connection file. This parameter is optional. - * @param {FileDataFormat} qDataFormat - Type of the file. - * @returns {Promise} - return a Promise Array of DataTable. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qRelativePath - Path of the connection file. This parameter is optional. + * @param qDataFormat - Type of the file. + * @returns - return a Promise Array of DataTable. */ getFileTables(qConnectionId: string, qRelativePath: string, qDataFormat: IFileDataFormat): Promise; @@ -2917,32 +2914,32 @@ declare namespace EngineAPI { * There are two ways to specify the directory to retrieve the files from: * - Enter the connection identifier; the directory associated to the connection is used. * - Enter the connection identifier and a relative path - * @param {String} qConnectionId - Identifier of the connection. >> This parameter is mandatory. - * @param {String} qRelativePath - Path of the connection file. This parameter is optional. - * @returns {Promise} - return a Promise Array of FolderItem. + * @param qConnectionId - Identifier of the connection. >> This parameter is mandatory. + * @param qRelativePath - Path of the connection file. This parameter is optional. + * @returns - return a Promise Array of FolderItem. */ getFolderItemsForConnection(qConnectionId: string, qRelativePath: string): Promise; /** * Gets the content of a file. - * @param {String} qLibPath - ["lib://CONNECTION_NAME\\.txt"] or + * @param qLibPath - ["lib://CONNECTION_NAME\\.txt"] or * - ["lib://Connection_Name\\\\.txt"] * - [ ] should be used when having a lib reference in the first variable. - * @returns {Promise} - return a Promise of String. + * @returns - return a Promise of String. */ getIncludeFileContent(qLibPath: string): Promise; /** * Returns the content of a library. - * @param {String} qName - Name of the content library. It corresponds to the property + * @param qName - Name of the content library. It corresponds to the property * qContentLibraryListItem/qName returned by the GetContentLibraries method. - * @returns {Promise} - return a Promise of StaticContentList. + * @returns - return a Promise of StaticContentList. */ getLibraryContent(qName: string): Promise; /** * Retrieves locale information. - * @returns {Promise} - return a Promise of LocaleInfo. + * @returns - return a Promise of LocaleInfo. */ getLocaleInfo(): Promise; @@ -2957,7 +2954,7 @@ declare namespace EngineAPI { * * Note: The last three values in the vector are extra values. These values are for internal use. * Note: In case of circular references, the engine automatically create loosely coupled tables - * @returns {Promise} - return a Promise . + * @returns - return a Promise . */ getLooselyCoupledVector(): Promise; @@ -2965,13 +2962,13 @@ declare namespace EngineAPI { * Retrieves any fields that match all or one of the specified tags in the data model of an app. * * Note: Tags set by Qlik Sense are prefixed by the $ sign. - * @param {Array} qTags - List of tags. Array of String + * @param qTags - List of tags. Array of String * The GetMatchingFields method looks for fields that match one or all of the tags in this list, * depending on the value of qMatchingFieldMode. - * @param {String} qMatchingFieldMode - Matching field mode. + * @param qMatchingFieldMode - Matching field mode. * This parameter is optional. * The default value is 0. - * @returns {Promise} - return a Promise Array of NxMatchingFieldInfo. + * @returns - return a Promise Array of NxMatchingFieldInfo. */ getMatchingFields(qTags: string[], qMatchingFieldMode?: boolean): Promise; @@ -2979,31 +2976,31 @@ declare namespace EngineAPI { * Lists the media files. * * Note: This method is deprecated (not recommended to use). Use GetLibraryContent method instead. - * @returns {Promise} - return a Promise Boolean or MediaList + * @returns - return a Promise Boolean or MediaList */ getMediaList(): Promise | Promise; /** * Returns the handle of a measure. * - * @param {String} qId - Identifier of the measure. >> This parameter is mandatory. - * @returns {Promise} - return a Promise String GenericMeasure + * @param qId - Identifier of the measure. >> This parameter is mandatory. + * @returns - return a Promise String GenericMeasure */ getMeasure(qId: string): Promise; /** * Returns the type of the app object and the corresponding handle. * - * @param {String} qId - Identifier of the measure. >> This parameter is mandatory. - * @returns {Promise} - return a Promise String GenericObject + * @param qId - Identifier of the measure. >> This parameter is mandatory. + * @returns - return a Promise String GenericObject */ getObject(qId: string): Promise; /** * Returns a list of objects in the app. * - * @param {INxGetObjectOptions} qOptions - Information about the list of objects. - * @returns {Promise} - return a Promise array of NxContainerEntry. + * @param qOptions - Information about the list of objects. + * @returns - return a Promise array of NxContainerEntry. */ getObjects(qOptions: INxGetObjectOptions): Promise>; @@ -3013,7 +3010,7 @@ declare namespace EngineAPI { * Returns the identifier and the definition of the measure. * * Note: If the member delta is set to true in the request object, only the delta is retrieved. - * @returns {Promise} - return a Promise GenericObject + * @returns - return a Promise GenericObject */ getProperties(): Promise; @@ -3021,27 +3018,27 @@ declare namespace EngineAPI { * Lists the breakpoints in the script of an app. * * Returns information about the breakpoints. - * @returns {Promise} - return a Promise Array of EditorBreakpoint + * @returns - return a Promise Array of EditorBreakpoint */ getScriptBreakpoints(): Promise; /** * Gets values in script. - * @returns {Promise} - return a Promise String