[ { "__docId__": 0, "kind": "file", "static": true, "variation": null, "name": "esdoc/hal/config/hal.config.es6", "memberof": null, "longname": "esdoc/hal/config/hal.config.es6", "access": null, "description": null, "lineNumber": 4, "content": "/**\n * A standard or scoped role used when RBAC is turned on.\n */\nclass Role {\n\n /**\n * Has all permissions except cannot read or write resources related to the administrative audit logging system.\n */\n static get ADMINISTRATOR() {}\n\n /**\n * Can read anything. Can only modify the resources related to the administrative audit logging system.\n */\n static get AUDITOR() {}\n\n /**\n * Like a Maintainer, but with permission to modify persistent configuration constrained to resources that are\n * considered to be \"application resources\". A deployment is an application resource. The messaging server is not.\n * Items like datasources and JMS destinations are not considered to be application resources by default, but this\n * is configurable.\n */\n static get DEPLOYER() {}\n\n /**\n * Operator permissions, plus can modify the persistent configuration.\n */\n static get MAINTAINER() {}\n\n /**\n * A read-only role. Cannot modify any resource.\n */\n static get MONITOR() {}\n\n /**\n * Monitor permissions, plus can modify runtime state, but cannot modify anything that ends up in the persistent\n * configuration. Could, for example, restart a server.\n */\n static get OPERATOR() {}\n\n /**\n * Has all permissions. Equivalent to a JBoss AS 7 administrator.\n */\n static get SUPER_USER() {}\n\n /**\n * @return {string} the unique ID of this role.\n */\n get id() {}\n\n /**\n * @return {boolean} true if this is a standard role, false otherwise.\n */\n get standard() {}\n\n /**\n * @return {boolean} true if this is a scoped role, false otherwise.\n */\n get scoped() {}\n\n /**\n * @return {string} the name of this role.\n */\n get name() {}\n\n /**\n * @return {Role} the base role if this is a scoped role, null otherwise.\n */\n get baseRole() {}\n\n /**\n * @return {string[]} the scopes if this is a scoped role, an empty array otherwise.\n */\n get scope() {}\n\n /**\n * @return {string} a string representation of this role.\n */\n toString() {}\n}\n\n/**\n * Instance holding information about the console and its environment.\n */\nclass Environment {\n\n /**\n * @return {Version} the HAL version.\n */\n get halVersion() {}\n\n /**\n * @return {InstanceInfo} information about the server instance.\n */\n get instanceInfo() {}\n\n /**\n * @return {boolean} true for standalone mode, false otherwise.\n */\n get standalone() {}\n\n /**\n * @return {string} the name of the domain controller (DC).\n */\n get domainController() {}\n\n /**\n * @return {Version} the management model version.\n */\n get managementVersion() {}\n\n /**\n * @return {boolean} true if SSO is used, false otherwise.\n */\n get singleSignOn() {}\n\n /**\n * @return {Roles} the standard and scoped roles.\n */\n get roles() {}\n}\n\n/**\n * Holds information about an user.\n */\nclass User {\n\n /**\n * @return {string} the user name.\n */\n get name() {}\n\n /**\n * @return {boolean} true if this user belongs to the role SuperUser, false otherwise.\n */\n get superuser() {}\n\n /**\n * @return {boolean} true if this user belongs to the role Administrator, false otherwise.\n */\n get administrator() {}\n\n /**\n * @return {Role[]} the roles of this user.\n */\n get roles() {}\n\n /**\n * @return {User} the current user.\n */\n static current() {}\n}\n\n/**\n * Contains information about the server instance the console is connected to or loaded from (taken from the root\n * resource).\n */\nclass InstanceInfo {\n\n /**\n * @return {string} the product name.\n */\n get productName() {}\n\n /**\n * @return {string} the product version.\n */\n get productVersion() {}\n\n /**\n * @return {string} the release name.\n */\n get releaseName() {}\n\n /**\n * @return {string} the release version.\n */\n get releaseVersion() {}\n\n /**\n * @return {string} the server name.\n */\n get serverName() {}\n}\n\n/**\n * Provides access to all standard and scoped roles.\n */\nclass Roles {\n\n /**\n * @return {Role[]} all roles (standard and scoped).\n */\n get all() {}\n\n /**\n * @return {Role[]} standard roles.\n */\n get standardRoles() {}\n\n /**\n * @return {Role[]} scoped roles or an empty array if no scoped roles are defined.\n */\n get scopedRoles() {}\n\n /**\n * @param {string} id The unique ID of the role.\n * \n * @return {Role} the role for that ID or null if no such role was found.\n */\n get(id) {}\n}\n\n/**\n * Provides access to the endpoints used in HAL.\n */\nclass Endpoints {\n\n /**\n * @return {string} the endpoint used to execute management operations.\n */\n get dmr() {}\n\n /**\n * @return {string} the endpoint used for file uploads.\n */\n get upload() {}\n\n /**\n * @return {boolean} true if the console is served from a WildFly / EAP instance, false if it runs standalone and\n * connected to an arbitrary management endpoint.\n */\n get sameOrigin() {}\n}\n\n/**\n * Represents a version consisting of a major, minor and micro part.\n * \n * @since 0.1.0\n */\nclass Version {\n\n /**\n * @return {number} the major version number.\n */\n get major() {}\n\n /**\n * @return {number} the minor version number.\n */\n get minor() {}\n\n /**\n * @return {number} the patch version number.\n */\n get micro() {}\n\n /**\n * Creates a new version as a result of parsing the specified version string.\n * \n * @param {string} version The version string to parse\n * \n * @return {Version} a new version\n */\n static valueOf(version) {}\n\n /**\n * @return {string} <major>.<minor>.<micro>\n */\n toString() {}\n}\n\n" }, { "__docId__": 1, "kind": "class", "static": true, "variation": null, "name": "Role", "memberof": "esdoc/hal/config/hal.config.es6", "longname": "esdoc/hal/config/hal.config.es6~Role", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/config/hal.config.es6", "importStyle": null, "description": "A standard or scoped role used when RBAC is turned on.", "lineNumber": 4, "interface": false }, { "__docId__": 2, "kind": "get", "static": true, "variation": null, "name": "ADMINISTRATOR", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role.ADMINISTRATOR", "access": null, "description": "Has all permissions except cannot read or write resources related to the administrative audit logging system.", "lineNumber": 9, "generator": false }, { "__docId__": 3, "kind": "get", "static": true, "variation": null, "name": "AUDITOR", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role.AUDITOR", "access": null, "description": "Can read anything. Can only modify the resources related to the administrative audit logging system.", "lineNumber": 14, "generator": false }, { "__docId__": 4, "kind": "get", "static": true, "variation": null, "name": "DEPLOYER", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role.DEPLOYER", "access": null, "description": "Like a Maintainer, but with permission to modify persistent configuration constrained to resources that are\nconsidered to be \"application resources\". A deployment is an application resource. The messaging server is not.\nItems like datasources and JMS destinations are not considered to be application resources by default, but this\nis configurable.", "lineNumber": 22, "generator": false }, { "__docId__": 5, "kind": "get", "static": true, "variation": null, "name": "MAINTAINER", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role.MAINTAINER", "access": null, "description": "Operator permissions, plus can modify the persistent configuration.", "lineNumber": 27, "generator": false }, { "__docId__": 6, "kind": "get", "static": true, "variation": null, "name": "MONITOR", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role.MONITOR", "access": null, "description": "A read-only role. Cannot modify any resource.", "lineNumber": 32, "generator": false }, { "__docId__": 7, "kind": "get", "static": true, "variation": null, "name": "OPERATOR", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role.OPERATOR", "access": null, "description": "Monitor permissions, plus can modify runtime state, but cannot modify anything that ends up in the persistent\nconfiguration. Could, for example, restart a server.", "lineNumber": 38, "generator": false }, { "__docId__": 8, "kind": "get", "static": true, "variation": null, "name": "SUPER_USER", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role.SUPER_USER", "access": null, "description": "Has all permissions. Equivalent to a JBoss AS 7 administrator.", "lineNumber": 43, "generator": false }, { "__docId__": 9, "kind": "get", "static": false, "variation": null, "name": "id", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role#id", "access": null, "description": "", "lineNumber": 48, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the unique ID of this role." }, "generator": false }, { "__docId__": 10, "kind": "get", "static": false, "variation": null, "name": "standard", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role#standard", "access": null, "description": "", "lineNumber": 53, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if this is a standard role, false otherwise." }, "generator": false }, { "__docId__": 11, "kind": "get", "static": false, "variation": null, "name": "scoped", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role#scoped", "access": null, "description": "", "lineNumber": 58, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if this is a scoped role, false otherwise." }, "generator": false }, { "__docId__": 12, "kind": "get", "static": false, "variation": null, "name": "name", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role#name", "access": null, "description": "", "lineNumber": 63, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of this role." }, "generator": false }, { "__docId__": 13, "kind": "get", "static": false, "variation": null, "name": "baseRole", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role#baseRole", "access": null, "description": "", "lineNumber": 68, "return": { "nullable": null, "types": [ "Role" ], "spread": false, "description": "the base role if this is a scoped role, null otherwise." }, "generator": false }, { "__docId__": 14, "kind": "get", "static": false, "variation": null, "name": "scope", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role#scope", "access": null, "description": "", "lineNumber": 73, "return": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": "the scopes if this is a scoped role, an empty array otherwise." }, "generator": false }, { "__docId__": 15, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/config/hal.config.es6~Role", "longname": "esdoc/hal/config/hal.config.es6~Role#toString", "access": null, "description": "", "lineNumber": 78, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "a string representation of this role." }, "generator": false }, { "__docId__": 16, "kind": "class", "static": true, "variation": null, "name": "Environment", "memberof": "esdoc/hal/config/hal.config.es6", "longname": "esdoc/hal/config/hal.config.es6~Environment", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/config/hal.config.es6", "importStyle": null, "description": "Instance holding information about the console and its environment.", "lineNumber": 84, "interface": false }, { "__docId__": 17, "kind": "get", "static": false, "variation": null, "name": "halVersion", "memberof": "esdoc/hal/config/hal.config.es6~Environment", "longname": "esdoc/hal/config/hal.config.es6~Environment#halVersion", "access": null, "description": "", "lineNumber": 89, "return": { "nullable": null, "types": [ "Version" ], "spread": false, "description": "the HAL version." }, "generator": false }, { "__docId__": 18, "kind": "get", "static": false, "variation": null, "name": "instanceInfo", "memberof": "esdoc/hal/config/hal.config.es6~Environment", "longname": "esdoc/hal/config/hal.config.es6~Environment#instanceInfo", "access": null, "description": "", "lineNumber": 94, "return": { "nullable": null, "types": [ "InstanceInfo" ], "spread": false, "description": "information about the server instance." }, "generator": false }, { "__docId__": 19, "kind": "get", "static": false, "variation": null, "name": "standalone", "memberof": "esdoc/hal/config/hal.config.es6~Environment", "longname": "esdoc/hal/config/hal.config.es6~Environment#standalone", "access": null, "description": "", "lineNumber": 99, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true for standalone mode, false otherwise." }, "generator": false }, { "__docId__": 20, "kind": "get", "static": false, "variation": null, "name": "domainController", "memberof": "esdoc/hal/config/hal.config.es6~Environment", "longname": "esdoc/hal/config/hal.config.es6~Environment#domainController", "access": null, "description": "", "lineNumber": 104, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of the domain controller (DC)." }, "generator": false }, { "__docId__": 21, "kind": "get", "static": false, "variation": null, "name": "managementVersion", "memberof": "esdoc/hal/config/hal.config.es6~Environment", "longname": "esdoc/hal/config/hal.config.es6~Environment#managementVersion", "access": null, "description": "", "lineNumber": 109, "return": { "nullable": null, "types": [ "Version" ], "spread": false, "description": "the management model version." }, "generator": false }, { "__docId__": 22, "kind": "get", "static": false, "variation": null, "name": "singleSignOn", "memberof": "esdoc/hal/config/hal.config.es6~Environment", "longname": "esdoc/hal/config/hal.config.es6~Environment#singleSignOn", "access": null, "description": "", "lineNumber": 114, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if SSO is used, false otherwise." }, "generator": false }, { "__docId__": 23, "kind": "get", "static": false, "variation": null, "name": "roles", "memberof": "esdoc/hal/config/hal.config.es6~Environment", "longname": "esdoc/hal/config/hal.config.es6~Environment#roles", "access": null, "description": "", "lineNumber": 119, "return": { "nullable": null, "types": [ "Roles" ], "spread": false, "description": "the standard and scoped roles." }, "generator": false }, { "__docId__": 24, "kind": "class", "static": true, "variation": null, "name": "User", "memberof": "esdoc/hal/config/hal.config.es6", "longname": "esdoc/hal/config/hal.config.es6~User", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/config/hal.config.es6", "importStyle": null, "description": "Holds information about an user.", "lineNumber": 125, "interface": false }, { "__docId__": 25, "kind": "get", "static": false, "variation": null, "name": "name", "memberof": "esdoc/hal/config/hal.config.es6~User", "longname": "esdoc/hal/config/hal.config.es6~User#name", "access": null, "description": "", "lineNumber": 130, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the user name." }, "generator": false }, { "__docId__": 26, "kind": "get", "static": false, "variation": null, "name": "superuser", "memberof": "esdoc/hal/config/hal.config.es6~User", "longname": "esdoc/hal/config/hal.config.es6~User#superuser", "access": null, "description": "", "lineNumber": 135, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if this user belongs to the role SuperUser, false otherwise." }, "generator": false }, { "__docId__": 27, "kind": "get", "static": false, "variation": null, "name": "administrator", "memberof": "esdoc/hal/config/hal.config.es6~User", "longname": "esdoc/hal/config/hal.config.es6~User#administrator", "access": null, "description": "", "lineNumber": 140, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if this user belongs to the role Administrator, false otherwise." }, "generator": false }, { "__docId__": 28, "kind": "get", "static": false, "variation": null, "name": "roles", "memberof": "esdoc/hal/config/hal.config.es6~User", "longname": "esdoc/hal/config/hal.config.es6~User#roles", "access": null, "description": "", "lineNumber": 145, "return": { "nullable": null, "types": [ "Role[]" ], "spread": false, "description": "the roles of this user." }, "generator": false }, { "__docId__": 29, "kind": "method", "static": true, "variation": null, "name": "current", "memberof": "esdoc/hal/config/hal.config.es6~User", "longname": "esdoc/hal/config/hal.config.es6~User.current", "access": null, "description": "", "lineNumber": 150, "params": [], "return": { "nullable": null, "types": [ "User" ], "spread": false, "description": "the current user." }, "generator": false }, { "__docId__": 30, "kind": "class", "static": true, "variation": null, "name": "InstanceInfo", "memberof": "esdoc/hal/config/hal.config.es6", "longname": "esdoc/hal/config/hal.config.es6~InstanceInfo", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/config/hal.config.es6", "importStyle": null, "description": "Contains information about the server instance the console is connected to or loaded from (taken from the root\nresource).", "lineNumber": 157, "interface": false }, { "__docId__": 31, "kind": "get", "static": false, "variation": null, "name": "productName", "memberof": "esdoc/hal/config/hal.config.es6~InstanceInfo", "longname": "esdoc/hal/config/hal.config.es6~InstanceInfo#productName", "access": null, "description": "", "lineNumber": 162, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the product name." }, "generator": false }, { "__docId__": 32, "kind": "get", "static": false, "variation": null, "name": "productVersion", "memberof": "esdoc/hal/config/hal.config.es6~InstanceInfo", "longname": "esdoc/hal/config/hal.config.es6~InstanceInfo#productVersion", "access": null, "description": "", "lineNumber": 167, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the product version." }, "generator": false }, { "__docId__": 33, "kind": "get", "static": false, "variation": null, "name": "releaseName", "memberof": "esdoc/hal/config/hal.config.es6~InstanceInfo", "longname": "esdoc/hal/config/hal.config.es6~InstanceInfo#releaseName", "access": null, "description": "", "lineNumber": 172, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the release name." }, "generator": false }, { "__docId__": 34, "kind": "get", "static": false, "variation": null, "name": "releaseVersion", "memberof": "esdoc/hal/config/hal.config.es6~InstanceInfo", "longname": "esdoc/hal/config/hal.config.es6~InstanceInfo#releaseVersion", "access": null, "description": "", "lineNumber": 177, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the release version." }, "generator": false }, { "__docId__": 35, "kind": "get", "static": false, "variation": null, "name": "serverName", "memberof": "esdoc/hal/config/hal.config.es6~InstanceInfo", "longname": "esdoc/hal/config/hal.config.es6~InstanceInfo#serverName", "access": null, "description": "", "lineNumber": 182, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the server name." }, "generator": false }, { "__docId__": 36, "kind": "class", "static": true, "variation": null, "name": "Roles", "memberof": "esdoc/hal/config/hal.config.es6", "longname": "esdoc/hal/config/hal.config.es6~Roles", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/config/hal.config.es6", "importStyle": null, "description": "Provides access to all standard and scoped roles.", "lineNumber": 188, "interface": false }, { "__docId__": 37, "kind": "get", "static": false, "variation": null, "name": "all", "memberof": "esdoc/hal/config/hal.config.es6~Roles", "longname": "esdoc/hal/config/hal.config.es6~Roles#all", "access": null, "description": "", "lineNumber": 193, "return": { "nullable": null, "types": [ "Role[]" ], "spread": false, "description": "all roles (standard and scoped)." }, "generator": false }, { "__docId__": 38, "kind": "get", "static": false, "variation": null, "name": "standardRoles", "memberof": "esdoc/hal/config/hal.config.es6~Roles", "longname": "esdoc/hal/config/hal.config.es6~Roles#standardRoles", "access": null, "description": "", "lineNumber": 198, "return": { "nullable": null, "types": [ "Role[]" ], "spread": false, "description": "standard roles." }, "generator": false }, { "__docId__": 39, "kind": "get", "static": false, "variation": null, "name": "scopedRoles", "memberof": "esdoc/hal/config/hal.config.es6~Roles", "longname": "esdoc/hal/config/hal.config.es6~Roles#scopedRoles", "access": null, "description": "", "lineNumber": 203, "return": { "nullable": null, "types": [ "Role[]" ], "spread": false, "description": "scoped roles or an empty array if no scoped roles are defined." }, "generator": false }, { "__docId__": 40, "kind": "method", "static": false, "variation": null, "name": "get", "memberof": "esdoc/hal/config/hal.config.es6~Roles", "longname": "esdoc/hal/config/hal.config.es6~Roles#get", "access": null, "description": "", "lineNumber": 210, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "id", "description": "The unique ID of the role." } ], "return": { "nullable": null, "types": [ "Role" ], "spread": false, "description": "the role for that ID or null if no such role was found." }, "generator": false }, { "__docId__": 41, "kind": "class", "static": true, "variation": null, "name": "Endpoints", "memberof": "esdoc/hal/config/hal.config.es6", "longname": "esdoc/hal/config/hal.config.es6~Endpoints", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/config/hal.config.es6", "importStyle": null, "description": "Provides access to the endpoints used in HAL.", "lineNumber": 216, "interface": false }, { "__docId__": 42, "kind": "get", "static": false, "variation": null, "name": "dmr", "memberof": "esdoc/hal/config/hal.config.es6~Endpoints", "longname": "esdoc/hal/config/hal.config.es6~Endpoints#dmr", "access": null, "description": "", "lineNumber": 221, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the endpoint used to execute management operations." }, "generator": false }, { "__docId__": 43, "kind": "get", "static": false, "variation": null, "name": "upload", "memberof": "esdoc/hal/config/hal.config.es6~Endpoints", "longname": "esdoc/hal/config/hal.config.es6~Endpoints#upload", "access": null, "description": "", "lineNumber": 226, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the endpoint used for file uploads." }, "generator": false }, { "__docId__": 44, "kind": "get", "static": false, "variation": null, "name": "sameOrigin", "memberof": "esdoc/hal/config/hal.config.es6~Endpoints", "longname": "esdoc/hal/config/hal.config.es6~Endpoints#sameOrigin", "access": null, "description": "", "lineNumber": 232, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if the console is served from a WildFly / EAP instance, false if it runs standalone and\nconnected to an arbitrary management endpoint." }, "generator": false }, { "__docId__": 45, "kind": "class", "static": true, "variation": null, "name": "Version", "memberof": "esdoc/hal/config/hal.config.es6", "longname": "esdoc/hal/config/hal.config.es6~Version", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/config/hal.config.es6", "importStyle": null, "description": "Represents a version consisting of a major, minor and micro part.", "lineNumber": 240, "since": "0.1.0", "interface": false }, { "__docId__": 46, "kind": "get", "static": false, "variation": null, "name": "major", "memberof": "esdoc/hal/config/hal.config.es6~Version", "longname": "esdoc/hal/config/hal.config.es6~Version#major", "access": null, "description": "", "lineNumber": 245, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the major version number." }, "generator": false }, { "__docId__": 47, "kind": "get", "static": false, "variation": null, "name": "minor", "memberof": "esdoc/hal/config/hal.config.es6~Version", "longname": "esdoc/hal/config/hal.config.es6~Version#minor", "access": null, "description": "", "lineNumber": 250, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the minor version number." }, "generator": false }, { "__docId__": 48, "kind": "get", "static": false, "variation": null, "name": "micro", "memberof": "esdoc/hal/config/hal.config.es6~Version", "longname": "esdoc/hal/config/hal.config.es6~Version#micro", "access": null, "description": "", "lineNumber": 255, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the patch version number." }, "generator": false }, { "__docId__": 49, "kind": "method", "static": true, "variation": null, "name": "valueOf", "memberof": "esdoc/hal/config/hal.config.es6~Version", "longname": "esdoc/hal/config/hal.config.es6~Version.valueOf", "access": null, "description": "Creates a new version as a result of parsing the specified version string.", "lineNumber": 264, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "version", "description": "The version string to parse" } ], "return": { "nullable": null, "types": [ "Version" ], "spread": false, "description": "a new version" }, "generator": false }, { "__docId__": 50, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/config/hal.config.es6~Version", "longname": "esdoc/hal/config/hal.config.es6~Version#toString", "access": null, "description": "", "lineNumber": 269, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "<major>.<minor>.<micro>" }, "generator": false }, { "__docId__": 51, "kind": "file", "static": true, "variation": null, "name": "esdoc/hal/core/hal.core.es6", "memberof": null, "longname": "esdoc/hal/core/hal.core.es6", "access": null, "description": null, "lineNumber": 4, "content": "/**\n * Represents an extension written in JavaScript.\n */\nclass Extension {\n\n /**\n * Creates a header extension.\n * \n * @param {string} name A unique name of the extension.\n * @param {string} title The title of the menu item in the header.\n * @param {function()} entryPoint The entrypoint of the header extension.\n * \n * @return {Extension} the extension which can be registered using the {@link ExtensionRegistry}.\n */\n static header(name, title, entryPoint) {}\n\n /**\n * Creates a footer extension.\n * \n * @param {string} name A unique name of the extension.\n * @param {string} title The title of the menu item in the footer.\n * @param {function()} entryPoint The entrypoint of the footer extension.\n * \n * @return {Extension} the extension which can be registered using the {@link ExtensionRegistry}.\n */\n static footer(name, title, entryPoint) {}\n}\n\n/**\n * Contains generic CRUD methods to add, read, update and remove (singleton) resources. Some methods just execute the\n * underlying DMR operations, other methods also interact with the user by showing (confirmation) dialogs.\n */\nclass CrudOperations {\n\n /**\n * Opens an add-resource dialog for the given resource type. The dialog contains fields for all required request\n * properties. When clicking \"Add\", a new resource is added using the specified address. After the resource has been\n * added a success message is displayed and the callback is executed.\n * \n * @param {string} type The human readable resource type used in the dialog header and success message.\n * @param {AddressTemplate|ResourceAddress|string} address The address for the add operation. Must end in <resource type>=*.\n * @param {string[]} attributes Additional attributes (besides the required attributes) which should be part of the\n * add-resource dialog. May be null or empty.\n * @param {function(name: string, address: ResourceAddress)} callback The callback executed after the resource has been added.\n */\n addDialog(type, address, attributes, callback) {}\n\n /**\n * Executes an add operation using the specified name and payload. After the resource has been added a success\n * message is displayed and the callback is executed.\n * \n * @param {string} type The human readable resource type used in the dialog header and success message.\n * @param {string} name The resource name which is part of the add operation.\n * @param {AddressTemplate|ResourceAddress|string} address The address for the add operation. Must end in <resource type>=*.\n * @param {ModelNode} payload The optional payload of the add operation (may be null or undefined).\n * @param {function(name: string, address: ResourceAddress)} callback The callback executed after the resource has been added.\n */\n add(type, name, address, payload, callback) {}\n\n /**\n * Opens an add-resource dialog for the given singleton resource type. The dialog contains fields for all required\n * request properties. When clicking \"Add\", a new singleton resource is added using the specified address template.\n * After the singleton resource has been added a success message is displayed and the callback is executed.\n * \n * @param {string} type The human readable resource type used in the dialog header and success message.\n * @param {Object} address The address for the add operation. Must end in <resource type>=<resource\n * name>.\n * @param {string[]} attributes Additional attributes (besides the required attributes) which should be part of the\n * add-resource dialog. May be null or empty.\n * @param {function(address: ResourceAddress)} callback The callback executed after the singleton resource has been added.\n */\n addSingletonDialog(type, address, attributes, callback) {}\n\n /**\n * Executes an add operation using the specified payload. After the resource has been added a success message is\n * displayed and the callback is executed.\n * \n * @param {string} type The human readable resource type used in the dialog header and success message.\n * @param {AddressTemplate|ResourceAddress|string} address The address for the add operation. Must end in <resource type>=<resource\n * name>.\n * @param {ModelNode} payload The optional payload of the add operation (may be null or undefined).\n * @param {function(address: ResourceAddress)} callback The callback executed after the singleton resource has been added.\n */\n addSingleton(type, address, payload, callback) {}\n\n /**\n * Executes a read-resource operation on the specified address and passes the result to the callback.\n * \n * @param {AddressTemplate|ResourceAddress|string} address The address for the read-resource operation operation.\n * @param {function(result: ModelNode)} callback The callback which gets the result of the read-resource operation.\n */\n read(address, callback) {}\n\n /**\n * Executes a recursive read-resource operation on the specified address and passes the result to the callback.\n * \n * @param {AddressTemplate|ResourceAddress|string} address The address for the read-resource operation operation.\n * @param {function(result: ModelNode)} callback The callback which gets the result of the read-resource operation.\n */\n readRecursive(address, callback) {}\n\n /**\n * Executes a read-children-resources operation on the specified address and passes the result as {@link Property}\n * array to the callback.\n * \n * @param {AddressTemplate|ResourceAddress|string} address The address for the read-children-resources operation.\n * @param {string} childType The child resource type.\n * @param {function(children: Property[])} callback The callback which gets the result of the read-children-resources operation.\n */\n readChildren(address, childType, callback) {}\n\n /**\n * Writes the changed values to the specified resource. After the resource has been saved a standard success message\n * is displayed and the callback is executed. If the change set is empty, a warning message is displayed and the\n * callback is executed.\n * \n * @param {string} type The human readable resource type used in the success message.\n * @param {string} name The resource name.\n * @param {AddressTemplate|ResourceAddress|string} address The address for the operation.\n * @param {{key: string, value: object}} changeSet A key-value map containing the changes to the resource.\n * @param {function()} callback The callback executed after the resource has been saved.\n */\n save(type, name, address, changeSet, callback) {}\n\n /**\n * Writes the changed values to the specified singleton resource. After the resource has been saved a standard\n * success message is displayed and the callback is executed. If the change set is empty, a warning message is\n * displayed and the callback is executed.\n * \n * @param {string} type The human readable resource type used in the success message.\n * @param {AddressTemplate|ResourceAddress|string} address The address for the operation.\n * @param {{key: string, value: object}} changeSet A key-value map containing the changes to the resource.\n * @param {function()} callback The callback executed after the singleton resource has been saved.\n */\n saveSingleton(type, address, changeSet, callback) {}\n\n /**\n * Shows a confirmation dialog and removes the resource if confirmed by the user. After the resource has been\n * removed a success message is displayed and the callback is executed.\n * \n * @param {string} type The human readable resource type used in the success message.\n * @param {string} name The resource name.\n * @param {AddressTemplate|ResourceAddress|string} address The address for the operation.\n * @param {function()} callback The callback executed after the resource has been removed.\n */\n remove(type, name, address, callback) {}\n\n /**\n * Shows a confirmation dialog and removes the singleton resource if confirmed by the user. After the resource has\n * been removed a success message is displayed and the callback is executed.\n * \n * @param {string} type The human readable resource type used in the success message.\n * @param {AddressTemplate|ResourceAddress|string} address The address for the operation.\n * @param {function()} callback The callback executed after the resource has been removed.\n */\n removeSingleton(type, address, callback) {}\n}\n\n/**\n * Provides access to all important classes. Acts as an entry point for the JavaScript API.\n */\nclass Core {\n\n /**\n * @return {CrudOperations} crud operations\n */\n get crud() {}\n\n /**\n * @return {Dispatcher} dispatcher\n */\n get dispatcher() {}\n\n /**\n * @return {Endpoints} endpoints\n */\n get endpoints() {}\n\n /**\n * @return {Environment} environment\n */\n get environment() {}\n\n /**\n * @return {ExtensionRegistry} extension registry\n */\n get extensionRegistry() {}\n\n /**\n * @return {MetadataProcessor} metadata processor\n */\n get metadataProcessor() {}\n\n /**\n * @return {MetadataRegistry} metadata registry\n */\n get metadataRegistry() {}\n\n /**\n * @return {StatementContext} statement context\n */\n get statementContext() {}\n\n /**\n * @return {Core} the singleton core instance.\n */\n static getInstance() {}\n\n /**\n * Creates and returns a dialog builder using the specified title.\n * \n * @param {string} title The dialog title.\n * \n * @return {DialogBuilder} a builder to create dialogs\n */\n dialog(title) {}\n\n /**\n * Shows an error message.\n * \n * @param {string} message The error message.\n */\n error(message) {}\n\n /**\n * Returns a new form builder for a {@link ModelNode}.\n * \n * @param {Metadata|AddressTemplate|string} meta The metadata for the form.\n * \n * @return {FormBuilder} the form builder\n */\n form(meta) {}\n\n /**\n * Shows an info message.\n * \n * @param {string} message The info message.\n */\n info(message) {}\n\n /**\n * Returns a new form builder for a {@link NamedNode}.\n * \n * @param {Metadata|AddressTemplate|string} meta The metadata for the form.\n * \n * @return {FormBuilder} the form builder\n */\n namedForm(meta) {}\n\n /**\n * Returns a new table builder for a {@link NamedNode}.\n * \n * @param {Metadata|AddressTemplate|string} meta The metadata for the table.\n * \n * @return {TableBuilder} the table builder\n */\n namedTable(meta) {}\n\n /**\n * Returns a new operation builder.\n * \n * @param {AddressTemplate|ResourceAddress|string} address The address.\n * @param {string} name The operation name.\n * \n * @return {OperationBuilder} the operation builder\n */\n operation(address, name) {}\n\n /**\n * Shows a success message.\n * \n * @param {string} message The success message.\n */\n success(message) {}\n\n /**\n * Returns a new table builder for a {@link ModelNode}.\n * \n * @param {Object} meta The metadata for the table.\n * \n * @return {TableBuilder} the table builder\n */\n table(meta) {}\n\n /**\n * Shows a warning message.\n * \n * @param {string} message The warning message.\n */\n warning(message) {}\n}\n\n/**\n * Registry to manage HAL extensions written in JavaScript.\n */\nclass ExtensionRegistry {\n\n /**\n * Registers an extension. Use this method to register your extension.\n *

\n * If the extension is already registered, this method will do nothing.\n * \n * @param {Extension} extension the extension to register.\n */\n register(extension) {}\n\n /**\n * Injects the script and stylesheets of an extension. This method is used during development. Normally you don't\n * have to call this method.\n * \n * @param {string} script the extension's script.\n * @param {string[]} stylesheets an optional list of stylesheets.\n */\n inject(script, stylesheets) {}\n}\n\n" }, { "__docId__": 52, "kind": "class", "static": true, "variation": null, "name": "Extension", "memberof": "esdoc/hal/core/hal.core.es6", "longname": "esdoc/hal/core/hal.core.es6~Extension", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/core/hal.core.es6", "importStyle": null, "description": "Represents an extension written in JavaScript.", "lineNumber": 4, "interface": false }, { "__docId__": 53, "kind": "method", "static": true, "variation": null, "name": "header", "memberof": "esdoc/hal/core/hal.core.es6~Extension", "longname": "esdoc/hal/core/hal.core.es6~Extension.header", "access": null, "description": "Creates a header extension.", "lineNumber": 15, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "A unique name of the extension." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "The title of the menu item in the header." }, { "nullable": null, "types": [ "function()" ], "spread": false, "optional": false, "name": "entryPoint", "description": "The entrypoint of the header extension." } ], "return": { "nullable": null, "types": [ "Extension" ], "spread": false, "description": "the extension which can be registered using the {@link ExtensionRegistry}." }, "generator": false }, { "__docId__": 54, "kind": "method", "static": true, "variation": null, "name": "footer", "memberof": "esdoc/hal/core/hal.core.es6~Extension", "longname": "esdoc/hal/core/hal.core.es6~Extension.footer", "access": null, "description": "Creates a footer extension.", "lineNumber": 26, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "A unique name of the extension." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "The title of the menu item in the footer." }, { "nullable": null, "types": [ "function()" ], "spread": false, "optional": false, "name": "entryPoint", "description": "The entrypoint of the footer extension." } ], "return": { "nullable": null, "types": [ "Extension" ], "spread": false, "description": "the extension which can be registered using the {@link ExtensionRegistry}." }, "generator": false }, { "__docId__": 55, "kind": "class", "static": true, "variation": null, "name": "CrudOperations", "memberof": "esdoc/hal/core/hal.core.es6", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/core/hal.core.es6", "importStyle": null, "description": "Contains generic CRUD methods to add, read, update and remove (singleton) resources. Some methods just execute the\nunderlying DMR operations, other methods also interact with the user by showing (confirmation) dialogs.", "lineNumber": 33, "interface": false }, { "__docId__": 56, "kind": "method", "static": false, "variation": null, "name": "addDialog", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#addDialog", "access": null, "description": "Opens an add-resource dialog for the given resource type. The dialog contains fields for all required request\nproperties. When clicking \"Add\", a new resource is added using the specified address. After the resource has been\nadded a success message is displayed and the callback is executed.", "lineNumber": 46, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the dialog header and success message." }, { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the add operation. Must end in <resource type>=*." }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "attributes", "description": "Additional attributes (besides the required attributes) which should be part of the\nadd-resource dialog. May be null or empty." }, { "nullable": null, "types": [ "function(name: string, address: ResourceAddress)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the resource has been added." } ], "generator": false }, { "__docId__": 57, "kind": "method", "static": false, "variation": null, "name": "add", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#add", "access": null, "description": "Executes an add operation using the specified name and payload. After the resource has been added a success\nmessage is displayed and the callback is executed.", "lineNumber": 58, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the dialog header and success message." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The resource name which is part of the add operation." }, { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the add operation. Must end in <resource type>=*." }, { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "payload", "description": "The optional payload of the add operation (may be null or undefined)." }, { "nullable": null, "types": [ "function(name: string, address: ResourceAddress)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the resource has been added." } ], "generator": false }, { "__docId__": 58, "kind": "method", "static": false, "variation": null, "name": "addSingletonDialog", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#addSingletonDialog", "access": null, "description": "Opens an add-resource dialog for the given singleton resource type. The dialog contains fields for all required\nrequest properties. When clicking \"Add\", a new singleton resource is added using the specified address template.\nAfter the singleton resource has been added a success message is displayed and the callback is executed.", "lineNumber": 72, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the dialog header and success message." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "address", "description": "The address for the add operation. Must end in <resource type>=<resource\nname>." }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "attributes", "description": "Additional attributes (besides the required attributes) which should be part of the\nadd-resource dialog. May be null or empty." }, { "nullable": null, "types": [ "function(address: ResourceAddress)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the singleton resource has been added." } ], "generator": false }, { "__docId__": 59, "kind": "method", "static": false, "variation": null, "name": "addSingleton", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#addSingleton", "access": null, "description": "Executes an add operation using the specified payload. After the resource has been added a success message is\ndisplayed and the callback is executed.", "lineNumber": 84, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the dialog header and success message." }, { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the add operation. Must end in <resource type>=<resource\nname>." }, { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "payload", "description": "The optional payload of the add operation (may be null or undefined)." }, { "nullable": null, "types": [ "function(address: ResourceAddress)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the singleton resource has been added." } ], "generator": false }, { "__docId__": 60, "kind": "method", "static": false, "variation": null, "name": "read", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#read", "access": null, "description": "Executes a read-resource operation on the specified address and passes the result to the callback.", "lineNumber": 92, "params": [ { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the read-resource operation operation." }, { "nullable": null, "types": [ "function(result: ModelNode)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback which gets the result of the read-resource operation." } ], "generator": false }, { "__docId__": 61, "kind": "method", "static": false, "variation": null, "name": "readRecursive", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#readRecursive", "access": null, "description": "Executes a recursive read-resource operation on the specified address and passes the result to the callback.", "lineNumber": 100, "params": [ { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the read-resource operation operation." }, { "nullable": null, "types": [ "function(result: ModelNode)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback which gets the result of the read-resource operation." } ], "generator": false }, { "__docId__": 62, "kind": "method", "static": false, "variation": null, "name": "readChildren", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#readChildren", "access": null, "description": "Executes a read-children-resources operation on the specified address and passes the result as {@link Property}\narray to the callback.", "lineNumber": 110, "params": [ { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the read-children-resources operation." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "childType", "description": "The child resource type." }, { "nullable": null, "types": [ "function(children: Property[])" ], "spread": false, "optional": false, "name": "callback", "description": "The callback which gets the result of the read-children-resources operation." } ], "generator": false }, { "__docId__": 63, "kind": "method", "static": false, "variation": null, "name": "save", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#save", "access": null, "description": "Writes the changed values to the specified resource. After the resource has been saved a standard success message\nis displayed and the callback is executed. If the change set is empty, a warning message is displayed and the\ncallback is executed.", "lineNumber": 123, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the success message." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The resource name." }, { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the operation." }, { "nullable": null, "types": [ "{key: string, value: object}" ], "spread": false, "optional": false, "name": "changeSet", "description": "A key-value map containing the changes to the resource." }, { "nullable": null, "types": [ "function()" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the resource has been saved." } ], "generator": false }, { "__docId__": 64, "kind": "method", "static": false, "variation": null, "name": "saveSingleton", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#saveSingleton", "access": null, "description": "Writes the changed values to the specified singleton resource. After the resource has been saved a standard\nsuccess message is displayed and the callback is executed. If the change set is empty, a warning message is\ndisplayed and the callback is executed.", "lineNumber": 135, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the success message." }, { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the operation." }, { "nullable": null, "types": [ "{key: string, value: object}" ], "spread": false, "optional": false, "name": "changeSet", "description": "A key-value map containing the changes to the resource." }, { "nullable": null, "types": [ "function()" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the singleton resource has been saved." } ], "generator": false }, { "__docId__": 65, "kind": "method", "static": false, "variation": null, "name": "remove", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#remove", "access": null, "description": "Shows a confirmation dialog and removes the resource if confirmed by the user. After the resource has been\nremoved a success message is displayed and the callback is executed.", "lineNumber": 146, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the success message." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The resource name." }, { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the operation." }, { "nullable": null, "types": [ "function()" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the resource has been removed." } ], "generator": false }, { "__docId__": 66, "kind": "method", "static": false, "variation": null, "name": "removeSingleton", "memberof": "esdoc/hal/core/hal.core.es6~CrudOperations", "longname": "esdoc/hal/core/hal.core.es6~CrudOperations#removeSingleton", "access": null, "description": "Shows a confirmation dialog and removes the singleton resource if confirmed by the user. After the resource has\nbeen removed a success message is displayed and the callback is executed.", "lineNumber": 156, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The human readable resource type used in the success message." }, { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address for the operation." }, { "nullable": null, "types": [ "function()" ], "spread": false, "optional": false, "name": "callback", "description": "The callback executed after the resource has been removed." } ], "generator": false }, { "__docId__": 67, "kind": "class", "static": true, "variation": null, "name": "Core", "memberof": "esdoc/hal/core/hal.core.es6", "longname": "esdoc/hal/core/hal.core.es6~Core", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/core/hal.core.es6", "importStyle": null, "description": "Provides access to all important classes. Acts as an entry point for the JavaScript API.", "lineNumber": 162, "interface": false }, { "__docId__": 68, "kind": "get", "static": false, "variation": null, "name": "crud", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#crud", "access": null, "description": "", "lineNumber": 167, "return": { "nullable": null, "types": [ "CrudOperations" ], "spread": false, "description": "crud operations" }, "generator": false }, { "__docId__": 69, "kind": "get", "static": false, "variation": null, "name": "dispatcher", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#dispatcher", "access": null, "description": "", "lineNumber": 172, "return": { "nullable": null, "types": [ "Dispatcher" ], "spread": false, "description": "dispatcher" }, "generator": false }, { "__docId__": 70, "kind": "get", "static": false, "variation": null, "name": "endpoints", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#endpoints", "access": null, "description": "", "lineNumber": 177, "return": { "nullable": null, "types": [ "Endpoints" ], "spread": false, "description": "endpoints" }, "generator": false }, { "__docId__": 71, "kind": "get", "static": false, "variation": null, "name": "environment", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#environment", "access": null, "description": "", "lineNumber": 182, "return": { "nullable": null, "types": [ "Environment" ], "spread": false, "description": "environment" }, "generator": false }, { "__docId__": 72, "kind": "get", "static": false, "variation": null, "name": "extensionRegistry", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#extensionRegistry", "access": null, "description": "", "lineNumber": 187, "return": { "nullable": null, "types": [ "ExtensionRegistry" ], "spread": false, "description": "extension registry" }, "generator": false }, { "__docId__": 73, "kind": "get", "static": false, "variation": null, "name": "metadataProcessor", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#metadataProcessor", "access": null, "description": "", "lineNumber": 192, "return": { "nullable": null, "types": [ "MetadataProcessor" ], "spread": false, "description": "metadata processor" }, "generator": false }, { "__docId__": 74, "kind": "get", "static": false, "variation": null, "name": "metadataRegistry", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#metadataRegistry", "access": null, "description": "", "lineNumber": 197, "return": { "nullable": null, "types": [ "MetadataRegistry" ], "spread": false, "description": "metadata registry" }, "generator": false }, { "__docId__": 75, "kind": "get", "static": false, "variation": null, "name": "statementContext", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#statementContext", "access": null, "description": "", "lineNumber": 202, "return": { "nullable": null, "types": [ "StatementContext" ], "spread": false, "description": "statement context" }, "generator": false }, { "__docId__": 76, "kind": "method", "static": true, "variation": null, "name": "getInstance", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core.getInstance", "access": null, "description": "", "lineNumber": 207, "params": [], "return": { "nullable": null, "types": [ "Core" ], "spread": false, "description": "the singleton core instance." }, "generator": false }, { "__docId__": 77, "kind": "method", "static": false, "variation": null, "name": "dialog", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#dialog", "access": null, "description": "Creates and returns a dialog builder using the specified title.", "lineNumber": 216, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "The dialog title." } ], "return": { "nullable": null, "types": [ "DialogBuilder" ], "spread": false, "description": "a builder to create dialogs" }, "generator": false }, { "__docId__": 78, "kind": "method", "static": false, "variation": null, "name": "error", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#error", "access": null, "description": "Shows an error message.", "lineNumber": 223, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "message", "description": "The error message." } ], "generator": false }, { "__docId__": 79, "kind": "method", "static": false, "variation": null, "name": "form", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#form", "access": null, "description": "Returns a new form builder for a {@link ModelNode}.", "lineNumber": 232, "params": [ { "nullable": null, "types": [ "Metadata", "AddressTemplate", "string" ], "spread": false, "optional": false, "name": "meta", "description": "The metadata for the form." } ], "return": { "nullable": null, "types": [ "FormBuilder" ], "spread": false, "description": "the form builder" }, "generator": false }, { "__docId__": 80, "kind": "method", "static": false, "variation": null, "name": "info", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#info", "access": null, "description": "Shows an info message.", "lineNumber": 239, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "message", "description": "The info message." } ], "generator": false }, { "__docId__": 81, "kind": "method", "static": false, "variation": null, "name": "namedForm", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#namedForm", "access": null, "description": "Returns a new form builder for a {@link NamedNode}.", "lineNumber": 248, "params": [ { "nullable": null, "types": [ "Metadata", "AddressTemplate", "string" ], "spread": false, "optional": false, "name": "meta", "description": "The metadata for the form." } ], "return": { "nullable": null, "types": [ "FormBuilder" ], "spread": false, "description": "the form builder" }, "generator": false }, { "__docId__": 82, "kind": "method", "static": false, "variation": null, "name": "namedTable", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#namedTable", "access": null, "description": "Returns a new table builder for a {@link NamedNode}.", "lineNumber": 257, "params": [ { "nullable": null, "types": [ "Metadata", "AddressTemplate", "string" ], "spread": false, "optional": false, "name": "meta", "description": "The metadata for the table." } ], "return": { "nullable": null, "types": [ "TableBuilder" ], "spread": false, "description": "the table builder" }, "generator": false }, { "__docId__": 83, "kind": "method", "static": false, "variation": null, "name": "operation", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#operation", "access": null, "description": "Returns a new operation builder.", "lineNumber": 267, "params": [ { "nullable": null, "types": [ "AddressTemplate", "ResourceAddress", "string" ], "spread": false, "optional": false, "name": "address", "description": "The address." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The operation name." } ], "return": { "nullable": null, "types": [ "OperationBuilder" ], "spread": false, "description": "the operation builder" }, "generator": false }, { "__docId__": 84, "kind": "method", "static": false, "variation": null, "name": "success", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#success", "access": null, "description": "Shows a success message.", "lineNumber": 274, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "message", "description": "The success message." } ], "generator": false }, { "__docId__": 85, "kind": "method", "static": false, "variation": null, "name": "table", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#table", "access": null, "description": "Returns a new table builder for a {@link ModelNode}.", "lineNumber": 283, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "meta", "description": "The metadata for the table." } ], "return": { "nullable": null, "types": [ "TableBuilder" ], "spread": false, "description": "the table builder" }, "generator": false }, { "__docId__": 86, "kind": "method", "static": false, "variation": null, "name": "warning", "memberof": "esdoc/hal/core/hal.core.es6~Core", "longname": "esdoc/hal/core/hal.core.es6~Core#warning", "access": null, "description": "Shows a warning message.", "lineNumber": 290, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "message", "description": "The warning message." } ], "generator": false }, { "__docId__": 87, "kind": "class", "static": true, "variation": null, "name": "ExtensionRegistry", "memberof": "esdoc/hal/core/hal.core.es6", "longname": "esdoc/hal/core/hal.core.es6~ExtensionRegistry", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/core/hal.core.es6", "importStyle": null, "description": "Registry to manage HAL extensions written in JavaScript.", "lineNumber": 296, "interface": false }, { "__docId__": 88, "kind": "method", "static": false, "variation": null, "name": "register", "memberof": "esdoc/hal/core/hal.core.es6~ExtensionRegistry", "longname": "esdoc/hal/core/hal.core.es6~ExtensionRegistry#register", "access": null, "description": "Registers an extension. Use this method to register your extension.\n

\nIf the extension is already registered, this method will do nothing.", "lineNumber": 305, "params": [ { "nullable": null, "types": [ "Extension" ], "spread": false, "optional": false, "name": "extension", "description": "the extension to register." } ], "generator": false }, { "__docId__": 89, "kind": "method", "static": false, "variation": null, "name": "inject", "memberof": "esdoc/hal/core/hal.core.es6~ExtensionRegistry", "longname": "esdoc/hal/core/hal.core.es6~ExtensionRegistry#inject", "access": null, "description": "Injects the script and stylesheets of an extension. This method is used during development. Normally you don't\nhave to call this method.", "lineNumber": 314, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "script", "description": "the extension's script." }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "stylesheets", "description": "an optional list of stylesheets." } ], "generator": false }, { "__docId__": 90, "kind": "file", "static": true, "variation": null, "name": "esdoc/hal/dmr/hal.dmr.es6", "memberof": null, "longname": "esdoc/hal/dmr/hal.dmr.es6", "access": null, "description": null, "lineNumber": 4, "content": "/**\n * Executes operations against the management endpoint.\n */\nclass Dispatcher {\n\n /**\n * Executes the specified composite operation.\n * \n * @param {Composite} composite The composite operation to execute.\n * @param {function(result: CompositeResult)} callback The callback receiving the result.\n */\n executeComposite(composite, callback) {}\n\n /**\n * Executes the specified operation. The callback contains just the result w/o surrounding nodes like \"outcome\".\n * \n * @param {Operation} operation The operation to execute.\n * @param {function(result: ModelNode)} callback The callback receiving the result.\n */\n execute(operation, callback) {}\n}\n\n/**\n * Represents a composite operation consisting of n {@link Operation}s.\n */\nclass Composite {\n\n /**\n * @return {boolean} whether this composite contains operations\n */\n get empty() {}\n\n /**\n * @return {number} the number of operations\n */\n get size() {}\n\n /**\n * @return {Operation[]} the operations of this composite\n */\n get operations() {}\n\n /**\n * Adds the specified operation to this composite.\n * \n * @param {Operation} operation The operation to add.\n * \n * @return {Composite} this composite\n */\n addOperation(operation) {}\n\n /**\n * @return {string} a string representation of this composite\n */\n toString() {}\n\n /**\n * @return {string} the string representation of the operation as used in the CLI\n */\n asCli() {}\n}\n\n/**\n * Represents a DMR property.\n */\nclass Property {\n\n /**\n * Creates a new property\n * \n * @param {string} name The name of the property.\n * @param {ModelNode} value The value of the property.\n */\n constructor(name, value) {}\n\n /**\n * @return {string} the name of the property\n */\n get name() {}\n\n /**\n * @return {ModelNode} the value of the property\n */\n get value() {}\n}\n\n/**\n * Static helper methods for dealing with {@link ModelNode}s and {@link NamedNode}s. Some methods accept a path\n * parameter separated by \"/\" to get a deeply nested data.\n */\nclass ModelNodeHelper {\n\n /**\n * Tries to get a deeply nested model node from the specified model node. Nested paths must be separated with \"/\".\n * \n * @param {ModelNode} modelNode The model node to read from\n * @param {string} path A path separated with \"/\"\n * \n * @return {ModelNode} The nested node or an empty / undefined model node\n */\n static failSafeGet(modelNode, path) {}\n\n /**\n * Tries to get a deeply nested boolean value from the specified model node. Nested paths must be separated with\n * \"/\".\n * \n * @param {ModelNode} modelNode The model node to read from\n * @param {string} path A path separated with \"/\"\n * \n * @return {boolean} the boolean value or false.\n */\n static failSafeBoolean(modelNode, path) {}\n\n /**\n * Tries to get a deeply nested node array from the specified model node. Nested paths must be separated with \"/\".\n * \n * @param {ModelNode} modelNode The model node to read from\n * @param {string} path A path separated with \"/\"\n * \n * @return {ModelNode[]} the model nodes or an empty array\n */\n static failSafeList(modelNode, path) {}\n\n /**\n * Tries to get a deeply nested property array from the specified model node. Nested paths must be separated with\n * \"/\".\n * \n * @param {ModelNode} modelNode The model node to read from\n * @param {string} path A path separated with \"/\"\n * \n * @return {Property[]} the properties or an empty array\n */\n static failSafePropertyList(modelNode, path) {}\n\n /**\n * Turns an properties array into an array of names nodes.\n * \n * @param {Property[]} properties The properties\n * \n * @return {NamedNode[]} the array of named nodes\n */\n static asNamedNodes(properties) {}\n}\n\n/**\n * Represents a fully qualified DMR address ready to be put into a DMR operation. The address consists of 0-n segments\n * with a name and a value for each segment.\n */\nclass ResourceAddress {\n\n /**\n * @return {string} the value of the first segment or null if this address is empty.\n */\n get firstValue() {}\n\n /**\n * @return {string} the name of the last segment or null if this address is empty.\n */\n get lastName() {}\n\n /**\n * @return {string} the value of the last segment or null if this address is empty.\n */\n get lastValue() {}\n\n /**\n * @return {ResourceAddress} the parent address or the root address if this address has no parent.\n */\n get parent() {}\n\n /**\n * @return {number} the number of segments.\n */\n get size() {}\n\n /**\n * @return {boolean} whether this address is empty.\n */\n get empty() {}\n\n /**\n * @return {ResourceAddress} the empty (root) address\n */\n static root() {}\n\n /**\n * Adds the specified segment to this address.\n * \n * @param {string} propertyName the property name\n * @param {string} propertyValue the property value\n * \n * @return {ResourceAddress} this address with the specified segment added\n */\n addSegment(propertyName, propertyValue) {}\n\n /**\n * Adds the specified address to this address.\n * \n * @param {ResourceAddress} address The address to add.\n * \n * @return {ResourceAddress} this address with the specified address added\n */\n addAddress(address) {}\n\n /**\n * Replaces the value in the specified segment\n * \n * @param {string} name The name of the segment.\n * @param {string} newValue The new value.\n * \n * @return {ResourceAddress} this address containing the replaced value\n */\n replaceValue(name, newValue) {}\n\n /**\n * @return {string} the address as string\n */\n toString() {}\n}\n\n/**\n * Represents a DMR operation.\n */\nclass Operation {\n\n /**\n * @return {string} the name of the operation\n */\n get name() {}\n\n /**\n * @return {ResourceAddress} the address of the operation\n */\n get address() {}\n\n /**\n * @return {ModelNode} the parameters of the operation\n */\n get parameter() {}\n\n /**\n * @return {ModelNode} the header of the operation\n */\n get header() {}\n\n /**\n * @return {string} the string representation of the operation as used in the CLI\n */\n toString() {}\n\n /**\n * @return {string} the string representation of the operation as used in the CLI\n */\n asCli() {}\n}\n\n/**\n * A dynamic model representation node object.\n */\nclass ModelNode {\n\n /**\n * Determine whether this node is defined.\n * \n * @return {boolean} true if this node's value is defined, false otherwise\n */\n get defined() {}\n\n /**\n * @return {boolean} true if this node has an outcome and the outcome does not equal \"success\"\n */\n get failure() {}\n\n /**\n * @return {string} the failure description or \"No failure-description provided\"\n */\n get failureDescription() {}\n\n /**\n * Creates a new node from a base64 encoded string\n * \n * @param {string} encoded The base64 encoded string.\n * \n * @return {ModelNode} the new model node\n */\n static fromBase64(encoded) {}\n\n /**\n * Get the value of this node as number. Collection types will return the size\n * of the collection for this value. Other types may attempt a string conversion.\n * \n * @return {number} the numeric value\n * \n * @throws IllegalArgumentException if no conversion is possible\n */\n asInt() {}\n\n /**\n * Get the value of this node as a boolean. Collection types return true for non-empty collections. Numerical types\n * return true for non-zero values.\n * \n * @return {boolean} the boolean value\n * \n * @throws IllegalArgumentException if no conversion is possible\n */\n asBoolean() {}\n\n /**\n * Get the value as a string. This is the literal value of this model node. More than one node type may\n * yield the same value for this method.\n * \n * @return {string} the string value\n */\n asString() {}\n\n /**\n * Get the value of this node as a property. Object values will return a property if there is exactly one\n * property in the object. List values will return a property if there are exactly two items in the list,\n * and if the first is convertible to a string.\n * \n * @return {Property} the property value\n * \n * @throws IllegalArgumentException if no conversion is possible\n */\n asProperty() {}\n\n /**\n * Get a copy of this value as an object. Object values will simply copy themselves.\n *

\n * Property values will return a single-entry object whose key and value are copied from the property key and value.\n *

\n * List values will attempt to interpolate the list into an object by iterating each item, mapping each property\n * into an object entry and otherwise taking pairs of list entries, converting the first to a string, and using the\n * pair of entries as a single object entry. If an object key appears more than once in the source object, the\n * last key takes precedence.\n * \n * @return {ModelNode} the object value\n * \n * @throws IllegalArgumentException if no conversion is possible\n */\n asObject() {}\n\n /**\n * Change this node's value to the given value.\n * \n * @param {number} newValue the new value\n * \n * @return {ModelNode} this node\n */\n setNumber(newValue) {}\n\n /**\n * Change this node's value to the given value.\n * \n * @param {boolean} newValue the new value\n * \n * @return {ModelNode} this node\n */\n setBoolean(newValue) {}\n\n /**\n * Change this node's value to the given expression value.\n * \n * @param {string} newValue the new value\n * \n * @return {ModelNode} this node\n */\n setExpression(newValue) {}\n\n /**\n * Change this node's value to the given value.\n * \n * @param {string} newValue the new value\n * \n * @return {ModelNode} this node\n */\n setString(newValue) {}\n\n /**\n * Change this node's value to the given value. The value is copied from the parameter.\n * \n * @param {ModelNode} newValue the new value\n * \n * @return {ModelNode} this node\n */\n setNode(newValue) {}\n\n /**\n * Change this node's value to the given value.\n * \n * @param {Property} newValue the new value\n * \n * @return {ModelNode} this node\n */\n setProperty(newValue) {}\n\n /**\n * Change this node's value to an empty list.\n * \n * @return {ModelNode} this node\n */\n setEmptyList() {}\n\n /**\n * Change this node's value to an empty object.\n * \n * @return {ModelNode} this node\n */\n setEmptyObject() {}\n\n /**\n * Clear this node's value and change its type to undefined.\n * \n * @return {ModelNode} this node\n */\n clear() {}\n\n /**\n * Get the child of this node with the given name. If no such child exists, create it. If the node is undefined,\n * it will be initialized to be of type object.\n *

\n * When called on property values, the name must match the property name.\n * \n * @param {string} name the child name\n * \n * @return {ModelNode} the child\n * \n * @throws IllegalArgumentException if this node does not support getting a child with the given name\n */\n get(name) {}\n\n /**\n * Add a node to the end of this node's value list and return it. If the node is undefined, it will be initialized\n * to be of type list.\n * \n * @return {ModelNode} the new node\n */\n add() {}\n\n /**\n * Determine whether this node has a child with the given name. Property node types always contain exactly one\n * value with a key equal to the property name.\n * \n * @param {string} key the name\n * \n * @return {boolean} true if there is a (possibly undefined) node at the given key\n */\n has(key) {}\n\n /**\n * Determine whether this node has a defined child with the given name. Property node types always contain exactly\n * one value with a key equal to the property name.\n * \n * @param {string} key the name\n * \n * @return {boolean} true if there is a node at the given index and its type is not undefined\n */\n hasDefined(key) {}\n\n /**\n * Get a human-readable string representation of this model node, formatted nicely (possibly on multiple lines).\n * \n * @return {string} the string representation\n */\n toString() {}\n\n \n toBase64String() {}\n\n /**\n * Creates a new undefined model node\n * @return {ModelNode} the new model node\n */\n static create() {}\n\n /**\n * @return {json} the model node as JSON\n */\n getJSON() {}\n\n /**\n * @return {Property[]} this model node as an {@link Property} array\n */\n asProperties() {}\n\n /**\n * @return {ModelNode[]} this model node as an array.\n */\n asList() {}\n}\n\n/**\n * A model node with a name.\n */\nclass NamedNode {\n\n /**\n * @return {string} the name of this named node\n */\n get name() {}\n\n /**\n * @return {ModelNode} the model node of this named node\n */\n get modelNode() {}\n\n /**\n * @return {string} a string representation of this model node\n */\n toString() {}\n\n \n setName(name) {}\n\n \n update(node) {}\n\n \n static create(name) {}\n}\n\n/**\n * Represents the result of a composite operation.\n */\nclass CompositeResult {\n\n /**\n * @return {number} the number of steps\n */\n get size() {}\n\n /**\n * @return {boolean} whether this composite result contains steps\n */\n get empty() {}\n\n /**\n * @return {ModelNode[]} the steps of this composite result\n */\n get steps() {}\n\n /**\n * @param {string} step Step as \"step-n\" (one-based!)\n * \n * @return {ModelNode} the related step result\n */\n step(step) {}\n}\n\n/**\n * A builder for operations.\n */\nclass OperationBuilder {\n\n /**\n * Uses the specified payload for the operation.\n * \n * @param {ModelNode} payload The operation as model node.\n * \n * @return {OperationBuilder} this builder\n */\n payload(payload) {}\n\n /**\n * @return {Operation} builds and returns the operation\n */\n build() {}\n\n /**\n * Add a parameter to the operation\n * \n * @param {string} name The name of the parameter.\n * @param {boolean|int|string} value The value of the parameter.\n * \n * @return {OperationBuilder} this builder\n */\n param(name, value) {}\n\n /**\n * Add a header to the operation\n * \n * @param {string} name The name of the header.\n * @param {boolean|int|string} value The value of the header.\n * \n * @return {OperationBuilder} this builder\n */\n header(name, value) {}\n}\n\n" }, { "__docId__": 91, "kind": "class", "static": true, "variation": null, "name": "Dispatcher", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~Dispatcher", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "Executes operations against the management endpoint.", "lineNumber": 4, "interface": false }, { "__docId__": 92, "kind": "method", "static": false, "variation": null, "name": "executeComposite", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Dispatcher", "longname": "esdoc/hal/dmr/hal.dmr.es6~Dispatcher#executeComposite", "access": null, "description": "Executes the specified composite operation.", "lineNumber": 12, "params": [ { "nullable": null, "types": [ "Composite" ], "spread": false, "optional": false, "name": "composite", "description": "The composite operation to execute." }, { "nullable": null, "types": [ "function(result: CompositeResult)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback receiving the result." } ], "generator": false }, { "__docId__": 93, "kind": "method", "static": false, "variation": null, "name": "execute", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Dispatcher", "longname": "esdoc/hal/dmr/hal.dmr.es6~Dispatcher#execute", "access": null, "description": "Executes the specified operation. The callback contains just the result w/o surrounding nodes like \"outcome\".", "lineNumber": 20, "params": [ { "nullable": null, "types": [ "Operation" ], "spread": false, "optional": false, "name": "operation", "description": "The operation to execute." }, { "nullable": null, "types": [ "function(result: ModelNode)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback receiving the result." } ], "generator": false }, { "__docId__": 94, "kind": "class", "static": true, "variation": null, "name": "Composite", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~Composite", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "Represents a composite operation consisting of n {@link Operation}s.", "lineNumber": 26, "interface": false }, { "__docId__": 95, "kind": "get", "static": false, "variation": null, "name": "empty", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Composite", "longname": "esdoc/hal/dmr/hal.dmr.es6~Composite#empty", "access": null, "description": "", "lineNumber": 31, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether this composite contains operations" }, "generator": false }, { "__docId__": 96, "kind": "get", "static": false, "variation": null, "name": "size", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Composite", "longname": "esdoc/hal/dmr/hal.dmr.es6~Composite#size", "access": null, "description": "", "lineNumber": 36, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the number of operations" }, "generator": false }, { "__docId__": 97, "kind": "get", "static": false, "variation": null, "name": "operations", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Composite", "longname": "esdoc/hal/dmr/hal.dmr.es6~Composite#operations", "access": null, "description": "", "lineNumber": 41, "return": { "nullable": null, "types": [ "Operation[]" ], "spread": false, "description": "the operations of this composite" }, "generator": false }, { "__docId__": 98, "kind": "method", "static": false, "variation": null, "name": "addOperation", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Composite", "longname": "esdoc/hal/dmr/hal.dmr.es6~Composite#addOperation", "access": null, "description": "Adds the specified operation to this composite.", "lineNumber": 50, "params": [ { "nullable": null, "types": [ "Operation" ], "spread": false, "optional": false, "name": "operation", "description": "The operation to add." } ], "return": { "nullable": null, "types": [ "Composite" ], "spread": false, "description": "this composite" }, "generator": false }, { "__docId__": 99, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Composite", "longname": "esdoc/hal/dmr/hal.dmr.es6~Composite#toString", "access": null, "description": "", "lineNumber": 55, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "a string representation of this composite" }, "generator": false }, { "__docId__": 100, "kind": "method", "static": false, "variation": null, "name": "asCli", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Composite", "longname": "esdoc/hal/dmr/hal.dmr.es6~Composite#asCli", "access": null, "description": "", "lineNumber": 60, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the string representation of the operation as used in the CLI" }, "generator": false }, { "__docId__": 101, "kind": "class", "static": true, "variation": null, "name": "Property", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~Property", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "Represents a DMR property.", "lineNumber": 66, "interface": false }, { "__docId__": 102, "kind": "constructor", "static": false, "variation": null, "name": "constructor", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Property", "longname": "esdoc/hal/dmr/hal.dmr.es6~Property#constructor", "access": null, "description": "Creates a new property", "lineNumber": 74, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The name of the property." }, { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "value", "description": "The value of the property." } ], "generator": false }, { "__docId__": 103, "kind": "get", "static": false, "variation": null, "name": "name", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Property", "longname": "esdoc/hal/dmr/hal.dmr.es6~Property#name", "access": null, "description": "", "lineNumber": 79, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of the property" }, "generator": false }, { "__docId__": 104, "kind": "get", "static": false, "variation": null, "name": "value", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Property", "longname": "esdoc/hal/dmr/hal.dmr.es6~Property#value", "access": null, "description": "", "lineNumber": 84, "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the value of the property" }, "generator": false }, { "__docId__": 105, "kind": "class", "static": true, "variation": null, "name": "ModelNodeHelper", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "Static helper methods for dealing with {@link ModelNode}s and {@link NamedNode}s. Some methods accept a path\nparameter separated by \"/\" to get a deeply nested data.", "lineNumber": 91, "interface": false }, { "__docId__": 106, "kind": "method", "static": true, "variation": null, "name": "failSafeGet", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper.failSafeGet", "access": null, "description": "Tries to get a deeply nested model node from the specified model node. Nested paths must be separated with \"/\".", "lineNumber": 101, "params": [ { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "modelNode", "description": "The model node to read from" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "A path separated with \"/\"" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "The nested node or an empty / undefined model node" }, "generator": false }, { "__docId__": 107, "kind": "method", "static": true, "variation": null, "name": "failSafeBoolean", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper.failSafeBoolean", "access": null, "description": "Tries to get a deeply nested boolean value from the specified model node. Nested paths must be separated with\n\"/\".", "lineNumber": 112, "params": [ { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "modelNode", "description": "The model node to read from" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "A path separated with \"/\"" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "the boolean value or false." }, "generator": false }, { "__docId__": 108, "kind": "method", "static": true, "variation": null, "name": "failSafeList", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper.failSafeList", "access": null, "description": "Tries to get a deeply nested node array from the specified model node. Nested paths must be separated with \"/\".", "lineNumber": 122, "params": [ { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "modelNode", "description": "The model node to read from" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "A path separated with \"/\"" } ], "return": { "nullable": null, "types": [ "ModelNode[]" ], "spread": false, "description": "the model nodes or an empty array" }, "generator": false }, { "__docId__": 109, "kind": "method", "static": true, "variation": null, "name": "failSafePropertyList", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper.failSafePropertyList", "access": null, "description": "Tries to get a deeply nested property array from the specified model node. Nested paths must be separated with\n\"/\".", "lineNumber": 133, "params": [ { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "modelNode", "description": "The model node to read from" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "A path separated with \"/\"" } ], "return": { "nullable": null, "types": [ "Property[]" ], "spread": false, "description": "the properties or an empty array" }, "generator": false }, { "__docId__": 110, "kind": "method", "static": true, "variation": null, "name": "asNamedNodes", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNodeHelper.asNamedNodes", "access": null, "description": "Turns an properties array into an array of names nodes.", "lineNumber": 142, "params": [ { "nullable": null, "types": [ "Property[]" ], "spread": false, "optional": false, "name": "properties", "description": "The properties" } ], "return": { "nullable": null, "types": [ "NamedNode[]" ], "spread": false, "description": "the array of named nodes" }, "generator": false }, { "__docId__": 111, "kind": "class", "static": true, "variation": null, "name": "ResourceAddress", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "Represents a fully qualified DMR address ready to be put into a DMR operation. The address consists of 0-n segments\nwith a name and a value for each segment.", "lineNumber": 149, "interface": false }, { "__docId__": 112, "kind": "get", "static": false, "variation": null, "name": "firstValue", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#firstValue", "access": null, "description": "", "lineNumber": 154, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the value of the first segment or null if this address is empty." }, "generator": false }, { "__docId__": 113, "kind": "get", "static": false, "variation": null, "name": "lastName", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#lastName", "access": null, "description": "", "lineNumber": 159, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of the last segment or null if this address is empty." }, "generator": false }, { "__docId__": 114, "kind": "get", "static": false, "variation": null, "name": "lastValue", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#lastValue", "access": null, "description": "", "lineNumber": 164, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the value of the last segment or null if this address is empty." }, "generator": false }, { "__docId__": 115, "kind": "get", "static": false, "variation": null, "name": "parent", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#parent", "access": null, "description": "", "lineNumber": 169, "return": { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "description": "the parent address or the root address if this address has no parent." }, "generator": false }, { "__docId__": 116, "kind": "get", "static": false, "variation": null, "name": "size", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#size", "access": null, "description": "", "lineNumber": 174, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the number of segments." }, "generator": false }, { "__docId__": 117, "kind": "get", "static": false, "variation": null, "name": "empty", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#empty", "access": null, "description": "", "lineNumber": 179, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether this address is empty." }, "generator": false }, { "__docId__": 118, "kind": "method", "static": true, "variation": null, "name": "root", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress.root", "access": null, "description": "", "lineNumber": 184, "params": [], "return": { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "description": "the empty (root) address" }, "generator": false }, { "__docId__": 119, "kind": "method", "static": false, "variation": null, "name": "addSegment", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#addSegment", "access": null, "description": "Adds the specified segment to this address.", "lineNumber": 194, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "propertyName", "description": "the property name" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "propertyValue", "description": "the property value" } ], "return": { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "description": "this address with the specified segment added" }, "generator": false }, { "__docId__": 120, "kind": "method", "static": false, "variation": null, "name": "addAddress", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#addAddress", "access": null, "description": "Adds the specified address to this address.", "lineNumber": 203, "params": [ { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "optional": false, "name": "address", "description": "The address to add." } ], "return": { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "description": "this address with the specified address added" }, "generator": false }, { "__docId__": 121, "kind": "method", "static": false, "variation": null, "name": "replaceValue", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#replaceValue", "access": null, "description": "Replaces the value in the specified segment", "lineNumber": 213, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The name of the segment." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "newValue", "description": "The new value." } ], "return": { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "description": "this address containing the replaced value" }, "generator": false }, { "__docId__": 122, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress", "longname": "esdoc/hal/dmr/hal.dmr.es6~ResourceAddress#toString", "access": null, "description": "", "lineNumber": 218, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the address as string" }, "generator": false }, { "__docId__": 123, "kind": "class", "static": true, "variation": null, "name": "Operation", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~Operation", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "Represents a DMR operation.", "lineNumber": 224, "interface": false }, { "__docId__": 124, "kind": "get", "static": false, "variation": null, "name": "name", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Operation", "longname": "esdoc/hal/dmr/hal.dmr.es6~Operation#name", "access": null, "description": "", "lineNumber": 229, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of the operation" }, "generator": false }, { "__docId__": 125, "kind": "get", "static": false, "variation": null, "name": "address", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Operation", "longname": "esdoc/hal/dmr/hal.dmr.es6~Operation#address", "access": null, "description": "", "lineNumber": 234, "return": { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "description": "the address of the operation" }, "generator": false }, { "__docId__": 126, "kind": "get", "static": false, "variation": null, "name": "parameter", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Operation", "longname": "esdoc/hal/dmr/hal.dmr.es6~Operation#parameter", "access": null, "description": "", "lineNumber": 239, "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the parameters of the operation" }, "generator": false }, { "__docId__": 127, "kind": "get", "static": false, "variation": null, "name": "header", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Operation", "longname": "esdoc/hal/dmr/hal.dmr.es6~Operation#header", "access": null, "description": "", "lineNumber": 244, "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the header of the operation" }, "generator": false }, { "__docId__": 128, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Operation", "longname": "esdoc/hal/dmr/hal.dmr.es6~Operation#toString", "access": null, "description": "", "lineNumber": 249, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the string representation of the operation as used in the CLI" }, "generator": false }, { "__docId__": 129, "kind": "method", "static": false, "variation": null, "name": "asCli", "memberof": "esdoc/hal/dmr/hal.dmr.es6~Operation", "longname": "esdoc/hal/dmr/hal.dmr.es6~Operation#asCli", "access": null, "description": "", "lineNumber": 254, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the string representation of the operation as used in the CLI" }, "generator": false }, { "__docId__": 130, "kind": "class", "static": true, "variation": null, "name": "ModelNode", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "A dynamic model representation node object.", "lineNumber": 260, "interface": false }, { "__docId__": 131, "kind": "get", "static": false, "variation": null, "name": "defined", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#defined", "access": null, "description": "Determine whether this node is defined.", "lineNumber": 267, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if this node's value is defined, false otherwise" }, "generator": false }, { "__docId__": 132, "kind": "get", "static": false, "variation": null, "name": "failure", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#failure", "access": null, "description": "", "lineNumber": 272, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if this node has an outcome and the outcome does not equal \"success\"" }, "generator": false }, { "__docId__": 133, "kind": "get", "static": false, "variation": null, "name": "failureDescription", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#failureDescription", "access": null, "description": "", "lineNumber": 277, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the failure description or \"No failure-description provided\"" }, "generator": false }, { "__docId__": 134, "kind": "method", "static": true, "variation": null, "name": "fromBase64", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode.fromBase64", "access": null, "description": "Creates a new node from a base64 encoded string", "lineNumber": 286, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "encoded", "description": "The base64 encoded string." } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the new model node" }, "generator": false }, { "__docId__": 135, "kind": "method", "static": false, "variation": null, "name": "asInt", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#asInt", "access": null, "description": "Get the value of this node as number. Collection types will return the size\nof the collection for this value. Other types may attempt a string conversion.", "lineNumber": 296, "params": [], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the numeric value" }, "throws": [ { "types": [ "*" ], "description": "IllegalArgumentException if no conversion is possible" } ], "generator": false }, { "__docId__": 136, "kind": "method", "static": false, "variation": null, "name": "asBoolean", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#asBoolean", "access": null, "description": "Get the value of this node as a boolean. Collection types return true for non-empty collections. Numerical types\nreturn true for non-zero values.", "lineNumber": 306, "params": [], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "the boolean value" }, "throws": [ { "types": [ "*" ], "description": "IllegalArgumentException if no conversion is possible" } ], "generator": false }, { "__docId__": 137, "kind": "method", "static": false, "variation": null, "name": "asString", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#asString", "access": null, "description": "Get the value as a string. This is the literal value of this model node. More than one node type may\nyield the same value for this method.", "lineNumber": 314, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the string value" }, "generator": false }, { "__docId__": 138, "kind": "method", "static": false, "variation": null, "name": "asProperty", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#asProperty", "access": null, "description": "Get the value of this node as a property. Object values will return a property if there is exactly one\nproperty in the object. List values will return a property if there are exactly two items in the list,\nand if the first is convertible to a string.", "lineNumber": 325, "params": [], "return": { "nullable": null, "types": [ "Property" ], "spread": false, "description": "the property value" }, "throws": [ { "types": [ "*" ], "description": "IllegalArgumentException if no conversion is possible" } ], "generator": false }, { "__docId__": 139, "kind": "method", "static": false, "variation": null, "name": "asObject", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#asObject", "access": null, "description": "Get a copy of this value as an object. Object values will simply copy themselves.\n

\nProperty values will return a single-entry object whose key and value are copied from the property key and value.\n

\nList values will attempt to interpolate the list into an object by iterating each item, mapping each property\ninto an object entry and otherwise taking pairs of list entries, converting the first to a string, and using the\npair of entries as a single object entry. If an object key appears more than once in the source object, the\nlast key takes precedence.", "lineNumber": 341, "params": [], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the object value" }, "throws": [ { "types": [ "*" ], "description": "IllegalArgumentException if no conversion is possible" } ], "generator": false }, { "__docId__": 140, "kind": "method", "static": false, "variation": null, "name": "setNumber", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setNumber", "access": null, "description": "Change this node's value to the given value.", "lineNumber": 350, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "newValue", "description": "the new value" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 141, "kind": "method", "static": false, "variation": null, "name": "setBoolean", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setBoolean", "access": null, "description": "Change this node's value to the given value.", "lineNumber": 359, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "newValue", "description": "the new value" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 142, "kind": "method", "static": false, "variation": null, "name": "setExpression", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setExpression", "access": null, "description": "Change this node's value to the given expression value.", "lineNumber": 368, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "newValue", "description": "the new value" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 143, "kind": "method", "static": false, "variation": null, "name": "setString", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setString", "access": null, "description": "Change this node's value to the given value.", "lineNumber": 377, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "newValue", "description": "the new value" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 144, "kind": "method", "static": false, "variation": null, "name": "setNode", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setNode", "access": null, "description": "Change this node's value to the given value. The value is copied from the parameter.", "lineNumber": 386, "params": [ { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "newValue", "description": "the new value" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 145, "kind": "method", "static": false, "variation": null, "name": "setProperty", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setProperty", "access": null, "description": "Change this node's value to the given value.", "lineNumber": 395, "params": [ { "nullable": null, "types": [ "Property" ], "spread": false, "optional": false, "name": "newValue", "description": "the new value" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 146, "kind": "method", "static": false, "variation": null, "name": "setEmptyList", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setEmptyList", "access": null, "description": "Change this node's value to an empty list.", "lineNumber": 402, "params": [], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 147, "kind": "method", "static": false, "variation": null, "name": "setEmptyObject", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#setEmptyObject", "access": null, "description": "Change this node's value to an empty object.", "lineNumber": 409, "params": [], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 148, "kind": "method", "static": false, "variation": null, "name": "clear", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#clear", "access": null, "description": "Clear this node's value and change its type to undefined.", "lineNumber": 416, "params": [], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "this node" }, "generator": false }, { "__docId__": 149, "kind": "method", "static": false, "variation": null, "name": "get", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#get", "access": null, "description": "Get the child of this node with the given name. If no such child exists, create it. If the node is undefined,\nit will be initialized to be of type object.\n

\nWhen called on property values, the name must match the property name.", "lineNumber": 430, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "the child name" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the child" }, "throws": [ { "types": [ "*" ], "description": "IllegalArgumentException if this node does not support getting a child with the given name" } ], "generator": false }, { "__docId__": 150, "kind": "method", "static": false, "variation": null, "name": "add", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#add", "access": null, "description": "Add a node to the end of this node's value list and return it. If the node is undefined, it will be initialized\nto be of type list.", "lineNumber": 438, "params": [], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the new node" }, "generator": false }, { "__docId__": 151, "kind": "method", "static": false, "variation": null, "name": "has", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#has", "access": null, "description": "Determine whether this node has a child with the given name. Property node types always contain exactly one\nvalue with a key equal to the property name.", "lineNumber": 448, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "key", "description": "the name" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if there is a (possibly undefined) node at the given key" }, "generator": false }, { "__docId__": 152, "kind": "method", "static": false, "variation": null, "name": "hasDefined", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#hasDefined", "access": null, "description": "Determine whether this node has a defined child with the given name. Property node types always contain exactly\none value with a key equal to the property name.", "lineNumber": 458, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "key", "description": "the name" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if there is a node at the given index and its type is not undefined" }, "generator": false }, { "__docId__": 153, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#toString", "access": null, "description": "Get a human-readable string representation of this model node, formatted nicely (possibly on multiple lines).", "lineNumber": 465, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the string representation" }, "generator": false }, { "__docId__": 154, "kind": "method", "static": false, "variation": null, "name": "toBase64String", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#toBase64String", "access": null, "description": null, "lineNumber": 468, "undocument": true, "params": [], "generator": false }, { "__docId__": 155, "kind": "method", "static": true, "variation": null, "name": "create", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode.create", "access": null, "description": "Creates a new undefined model node", "lineNumber": 474, "params": [], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the new model node" }, "generator": false }, { "__docId__": 156, "kind": "method", "static": false, "variation": null, "name": "getJSON", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#getJSON", "access": null, "description": "", "lineNumber": 479, "params": [], "return": { "nullable": null, "types": [ "json" ], "spread": false, "description": "the model node as JSON" }, "generator": false }, { "__docId__": 157, "kind": "method", "static": false, "variation": null, "name": "asProperties", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#asProperties", "access": null, "description": "", "lineNumber": 484, "params": [], "return": { "nullable": null, "types": [ "Property[]" ], "spread": false, "description": "this model node as an {@link Property} array" }, "generator": false }, { "__docId__": 158, "kind": "method", "static": false, "variation": null, "name": "asList", "memberof": "esdoc/hal/dmr/hal.dmr.es6~ModelNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~ModelNode#asList", "access": null, "description": "", "lineNumber": 489, "params": [], "return": { "nullable": null, "types": [ "ModelNode[]" ], "spread": false, "description": "this model node as an array." }, "generator": false }, { "__docId__": 159, "kind": "class", "static": true, "variation": null, "name": "NamedNode", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~NamedNode", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "A model node with a name.", "lineNumber": 495, "interface": false }, { "__docId__": 160, "kind": "get", "static": false, "variation": null, "name": "name", "memberof": "esdoc/hal/dmr/hal.dmr.es6~NamedNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~NamedNode#name", "access": null, "description": "", "lineNumber": 500, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of this named node" }, "generator": false }, { "__docId__": 161, "kind": "get", "static": false, "variation": null, "name": "modelNode", "memberof": "esdoc/hal/dmr/hal.dmr.es6~NamedNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~NamedNode#modelNode", "access": null, "description": "", "lineNumber": 505, "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the model node of this named node" }, "generator": false }, { "__docId__": 162, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/dmr/hal.dmr.es6~NamedNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~NamedNode#toString", "access": null, "description": "", "lineNumber": 510, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "a string representation of this model node" }, "generator": false }, { "__docId__": 163, "kind": "method", "static": false, "variation": null, "name": "setName", "memberof": "esdoc/hal/dmr/hal.dmr.es6~NamedNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~NamedNode#setName", "access": null, "description": null, "lineNumber": 513, "undocument": true, "params": [ { "name": "name", "types": [ "*" ] } ], "generator": false }, { "__docId__": 164, "kind": "method", "static": false, "variation": null, "name": "update", "memberof": "esdoc/hal/dmr/hal.dmr.es6~NamedNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~NamedNode#update", "access": null, "description": null, "lineNumber": 516, "undocument": true, "params": [ { "name": "node", "types": [ "*" ] } ], "generator": false }, { "__docId__": 165, "kind": "method", "static": true, "variation": null, "name": "create", "memberof": "esdoc/hal/dmr/hal.dmr.es6~NamedNode", "longname": "esdoc/hal/dmr/hal.dmr.es6~NamedNode.create", "access": null, "description": null, "lineNumber": 519, "undocument": true, "params": [ { "name": "name", "types": [ "*" ] } ], "generator": false }, { "__docId__": 166, "kind": "class", "static": true, "variation": null, "name": "CompositeResult", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "Represents the result of a composite operation.", "lineNumber": 525, "interface": false }, { "__docId__": 167, "kind": "get", "static": false, "variation": null, "name": "size", "memberof": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult", "longname": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult#size", "access": null, "description": "", "lineNumber": 530, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the number of steps" }, "generator": false }, { "__docId__": 168, "kind": "get", "static": false, "variation": null, "name": "empty", "memberof": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult", "longname": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult#empty", "access": null, "description": "", "lineNumber": 535, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether this composite result contains steps" }, "generator": false }, { "__docId__": 169, "kind": "get", "static": false, "variation": null, "name": "steps", "memberof": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult", "longname": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult#steps", "access": null, "description": "", "lineNumber": 540, "return": { "nullable": null, "types": [ "ModelNode[]" ], "spread": false, "description": "the steps of this composite result" }, "generator": false }, { "__docId__": 170, "kind": "method", "static": false, "variation": null, "name": "step", "memberof": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult", "longname": "esdoc/hal/dmr/hal.dmr.es6~CompositeResult#step", "access": null, "description": "", "lineNumber": 547, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "step", "description": "Step as \"step-n\" (one-based!)" } ], "return": { "nullable": null, "types": [ "ModelNode" ], "spread": false, "description": "the related step result" }, "generator": false }, { "__docId__": 171, "kind": "class", "static": true, "variation": null, "name": "OperationBuilder", "memberof": "esdoc/hal/dmr/hal.dmr.es6", "longname": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/dmr/hal.dmr.es6", "importStyle": null, "description": "A builder for operations.", "lineNumber": 553, "interface": false }, { "__docId__": 172, "kind": "method", "static": false, "variation": null, "name": "payload", "memberof": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder", "longname": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder#payload", "access": null, "description": "Uses the specified payload for the operation.", "lineNumber": 562, "params": [ { "nullable": null, "types": [ "ModelNode" ], "spread": false, "optional": false, "name": "payload", "description": "The operation as model node." } ], "return": { "nullable": null, "types": [ "OperationBuilder" ], "spread": false, "description": "this builder" }, "generator": false }, { "__docId__": 173, "kind": "method", "static": false, "variation": null, "name": "build", "memberof": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder", "longname": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder#build", "access": null, "description": "", "lineNumber": 567, "params": [], "return": { "nullable": null, "types": [ "Operation" ], "spread": false, "description": "builds and returns the operation" }, "generator": false }, { "__docId__": 174, "kind": "method", "static": false, "variation": null, "name": "param", "memberof": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder", "longname": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder#param", "access": null, "description": "Add a parameter to the operation", "lineNumber": 577, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The name of the parameter." }, { "nullable": null, "types": [ "boolean", "int", "string" ], "spread": false, "optional": false, "name": "value", "description": "The value of the parameter." } ], "return": { "nullable": null, "types": [ "OperationBuilder" ], "spread": false, "description": "this builder" }, "generator": false }, { "__docId__": 175, "kind": "method", "static": false, "variation": null, "name": "header", "memberof": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder", "longname": "esdoc/hal/dmr/hal.dmr.es6~OperationBuilder#header", "access": null, "description": "Add a header to the operation", "lineNumber": 587, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The name of the header." }, { "nullable": null, "types": [ "boolean", "int", "string" ], "spread": false, "optional": false, "name": "value", "description": "The value of the header." } ], "return": { "nullable": null, "types": [ "OperationBuilder" ], "spread": false, "description": "this builder" }, "generator": false }, { "__docId__": 176, "kind": "file", "static": true, "variation": null, "name": "esdoc/hal/meta/hal.meta.es6", "memberof": null, "longname": "esdoc/hal/meta/hal.meta.es6", "access": null, "description": null, "lineNumber": 32, "content": "/**\n * Template for a DMR address which might contain multiple variable parts.\n * \n * An address template can be defined using the following BNF:\n * 

\n * <address template> ::= \"/\" | <segment>\n * <segment>          ::= <tuple> | <segment>\"/\"<tuple>\n * <tuple>            ::= <variable> | <key>\"=\"<value>\n * <variable>         ::= \"{\"<alpha>\"}\"\n * <key>              ::= <alpha>\n * <value>            ::= <variable> | <alpha> | \"*\"\n * <alpha>            ::= <upper> | <lower>\n * <upper>            ::= \"A\" | \"B\" | … | \"Z\"\n * <lower>            ::= \"a\" | \"b\" | … | \"z\"\n *
\n * \n * Following variables are supported:\n * - {domain.controller}\n * - {selected.profile}\n * - {selected.group}\n * - {selected.server-config}\n * - {selected.server}\n * \n * To get a fully qualified address from an address template use the method resolve(). For standalone mode\n * the variables will resolve to an empty string. The values of the variables are managed by the {@link\n * StatementContext}.\n * \n * @example AddressTemplate a2 = AddressTemplate.of(\"{selected.profile}\");\n * AddressTemplate a3 = AddressTemplate.of(\"{selected.profile}/subsystem=mail\");\n * AddressTemplate a4 = AddressTemplate.of(\"{selected.profile}/subsystem=mail/mail-session=*\");\n */\nclass AddressTemplate {\n\n /**\n * The root template\n */\n static get ROOT() {}\n\n /**\n * @return {boolean} true if this template contains no tokens, false otherwise\n */\n get empty() {}\n\n /**\n * @return {number} the number of tokens\n */\n get size() {}\n\n /**\n * @return {AddressTemplate} the parent address template or the root template\n */\n get parent() {}\n\n /**\n * @return {string} the name of the first segment or null if this address template is empty.\n */\n get firstName() {}\n\n /**\n * @return {string} the value of the first segment or null if this address template is empty.\n */\n get firstValue() {}\n\n /**\n * @return {string} the name of the last segment or null if this address template is empty.\n */\n get lastName() {}\n\n /**\n * @return {string} the value of the last segment or null if this address template is empty.\n */\n get lastValue() {}\n\n /**\n * Creates a new address template from an encoded string template.\n */\n static of(template) {}\n\n /**\n * @return {string} the string representation of this address template\n */\n toString() {}\n\n /**\n * Resolve this address template against the specified statement context.\n * \n * @param {StatementContext} context the statement context\n * @param {...string} wildcards An optional list of wildcards which are used to resolve any wildcards in this address template\n * from left to right\n * \n * @return {ResourceAddress} a fully qualified resource address which might be empty, but which does not contain any tokens\n */\n resolve(context, wildcards) {}\n\n /**\n * Append an address to this addrress template and return a new one.\n * \n * @param {string|AddressTemplate} address The address to append.\n * \n * @return {AddressTemplate} a new address template with the specified address added at the end.\n */\n append(address) {}\n}\n\n/**\n * Registry for existing resource {@link Metadata}.\n */\nclass MetadataRegistry {\n\n /**\n * Checks whether there's a metadata for the specified template.\n * \n * @param {AddressTemplate|String} template The address template to check.\n * \n * @return {boolean} true if the registry contains metadata for the given template, false otherwise\n */\n contains(template) {}\n\n /**\n * Returns metadata associated with the specified address template.\n * \n * @param {AddressTemplate|String} template The address template to lookup.\n * \n * @return {Metadata} the metadata for the specified template\n * \n * @throws MissingMetadataException if no metadata for the given template exists\n */\n lookup(template) {}\n}\n\n/**\n * Contains global state which is updated as you navigate in the console. In standalone mode most of the methods return\n * null.\n */\nclass StatementContext {\n\n /**\n * @return {string} the domain controller\n */\n get domainController() {}\n\n /**\n * @return {string} the selected profile\n */\n get selectedProfile() {}\n\n /**\n * @return {string} the selected server group\n */\n get selectedServerGroup() {}\n\n /**\n * @return {string} the selected host\n */\n get selectedHost() {}\n\n /**\n * @return {string} the selected server config\n */\n get selectedServerConfig() {}\n\n /**\n * @return {string} the selected server\n */\n get selectedServer() {}\n}\n\n/**\n * Represents the RBAC related payload from the read-resource-description operation.\n */\nclass SecurityContext {\n\n /**\n * A security context with hardcoded permissions to read resources, write and execute operations are not allowed.\n */\n static get READ_ONLY() {}\n\n /**\n * A security context with hardcoded permissions to read, write and execute any resource.\n */\n static get RWX() {}\n\n /**\n * @return {boolean} whether the security context is readable\n */\n get readable() {}\n\n /**\n * @return {boolean} whether the security context is writable\n */\n get writable() {}\n\n /**\n * @param {string} attribute The attribute to check.\n * \n * @return {boolean} whether the attribute is readable\n */\n isReadable(attribute) {}\n\n /**\n * @param {string} attribute The attribute to check.\n * \n * @return {boolean} whether the attribute is writable\n */\n isWritable(attribute) {}\n\n /**\n * @param {string} operation The operation to check.\n * \n * @return {boolean} whether the operation is executable\n */\n isExecutable(operation) {}\n}\n\n/**\n * Reads resource {@link Metadata} using read-resource-description operations and stores it into the {@link\n * MetadataRegistry}. If you're sure the metadata is present you can use the {@link MetadataRegistry} instead.\n */\nclass MetadataProcessor {\n\n /**\n * Reads the metadata for the template, stores it in the registry and passes it to the callback. If the metadata is\n * already in the registry it's passed directly to the callback.\n * \n * @param {AddressTemplate|String} template The address template to lookup.\n * @param {function(metadata: Metadata)} callback The callback which receives the metadata.\n */\n lookup(template, callback) {}\n}\n\n/**\n * Contains the resource and attribute descriptions from the read-resource-description operation.\n */\nclass ResourceDescription {\n\n /**\n * @return {string} the resource description\n */\n get description() {}\n\n /**\n * @return {Property[]} the operation descriptions\n */\n get operations() {}\n\n /**\n * @return {Property[]} the attribute descriptions\n */\n getAttributes() {}\n\n /**\n * @return {Property[]} the request properties of the add operation\n */\n getRequestProperties() {}\n}\n\n/**\n * Simple data struct for common metadata. Used to keep the method signatures small and tidy.\n */\nclass Metadata {\n\n /**\n * @return {AddressTemplate} the address template\n */\n get template() {}\n\n /**\n * @return {SecurityContext} the security context\n */\n get securityContext() {}\n\n /**\n * @return {ResourceDescription} the resource description\n */\n get description() {}\n}\n\n" }, { "__docId__": 177, "kind": "class", "static": true, "variation": null, "name": "AddressTemplate", "memberof": "esdoc/hal/meta/hal.meta.es6", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/meta/hal.meta.es6", "importStyle": null, "description": "Template for a DMR address which might contain multiple variable parts.\n\nAn address template can be defined using the following BNF:\n
\n<address template> ::= \"/\" | <segment>\n<segment>          ::= <tuple> | <segment>\"/\"<tuple>\n<tuple>            ::= <variable> | <key>\"=\"<value>\n<variable>         ::= \"{\"<alpha>\"}\"\n<key>              ::= <alpha>\n<value>            ::= <variable> | <alpha> | \"*\"\n<alpha>            ::= <upper> | <lower>\n<upper>            ::= \"A\" | \"B\" | … | \"Z\"\n<lower>            ::= \"a\" | \"b\" | … | \"z\"\n
\n\nFollowing variables are supported:\n- {domain.controller}\n- {selected.profile}\n- {selected.group}\n- {selected.server-config}\n- {selected.server}\n\nTo get a fully qualified address from an address template use the method resolve(). For standalone mode\nthe variables will resolve to an empty string. The values of the variables are managed by the {@link\nStatementContext}.", "examples": [ "AddressTemplate a2 = AddressTemplate.of(\"{selected.profile}\");\nAddressTemplate a3 = AddressTemplate.of(\"{selected.profile}/subsystem=mail\");\nAddressTemplate a4 = AddressTemplate.of(\"{selected.profile}/subsystem=mail/mail-session=*\");" ], "lineNumber": 32, "interface": false }, { "__docId__": 178, "kind": "get", "static": true, "variation": null, "name": "ROOT", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate.ROOT", "access": null, "description": "The root template", "lineNumber": 37, "generator": false }, { "__docId__": 179, "kind": "get", "static": false, "variation": null, "name": "empty", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#empty", "access": null, "description": "", "lineNumber": 42, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if this template contains no tokens, false otherwise" }, "generator": false }, { "__docId__": 180, "kind": "get", "static": false, "variation": null, "name": "size", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#size", "access": null, "description": "", "lineNumber": 47, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "the number of tokens" }, "generator": false }, { "__docId__": 181, "kind": "get", "static": false, "variation": null, "name": "parent", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#parent", "access": null, "description": "", "lineNumber": 52, "return": { "nullable": null, "types": [ "AddressTemplate" ], "spread": false, "description": "the parent address template or the root template" }, "generator": false }, { "__docId__": 182, "kind": "get", "static": false, "variation": null, "name": "firstName", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#firstName", "access": null, "description": "", "lineNumber": 57, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of the first segment or null if this address template is empty." }, "generator": false }, { "__docId__": 183, "kind": "get", "static": false, "variation": null, "name": "firstValue", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#firstValue", "access": null, "description": "", "lineNumber": 62, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the value of the first segment or null if this address template is empty." }, "generator": false }, { "__docId__": 184, "kind": "get", "static": false, "variation": null, "name": "lastName", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#lastName", "access": null, "description": "", "lineNumber": 67, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the name of the last segment or null if this address template is empty." }, "generator": false }, { "__docId__": 185, "kind": "get", "static": false, "variation": null, "name": "lastValue", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#lastValue", "access": null, "description": "", "lineNumber": 72, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the value of the last segment or null if this address template is empty." }, "generator": false }, { "__docId__": 186, "kind": "method", "static": true, "variation": null, "name": "of", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate.of", "access": null, "description": "Creates a new address template from an encoded string template.", "lineNumber": 77, "params": [ { "name": "template", "types": [ "*" ] } ], "generator": false }, { "__docId__": 187, "kind": "method", "static": false, "variation": null, "name": "toString", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#toString", "access": null, "description": "", "lineNumber": 82, "params": [], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the string representation of this address template" }, "generator": false }, { "__docId__": 188, "kind": "method", "static": false, "variation": null, "name": "resolve", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#resolve", "access": null, "description": "Resolve this address template against the specified statement context.", "lineNumber": 93, "params": [ { "nullable": null, "types": [ "StatementContext" ], "spread": false, "optional": false, "name": "context", "description": "the statement context" }, { "nullable": null, "types": [ "...string" ], "spread": true, "optional": false, "name": "wildcards", "description": "An optional list of wildcards which are used to resolve any wildcards in this address template\nfrom left to right" } ], "return": { "nullable": null, "types": [ "ResourceAddress" ], "spread": false, "description": "a fully qualified resource address which might be empty, but which does not contain any tokens" }, "generator": false }, { "__docId__": 189, "kind": "method", "static": false, "variation": null, "name": "append", "memberof": "esdoc/hal/meta/hal.meta.es6~AddressTemplate", "longname": "esdoc/hal/meta/hal.meta.es6~AddressTemplate#append", "access": null, "description": "Append an address to this addrress template and return a new one.", "lineNumber": 102, "params": [ { "nullable": null, "types": [ "string", "AddressTemplate" ], "spread": false, "optional": false, "name": "address", "description": "The address to append." } ], "return": { "nullable": null, "types": [ "AddressTemplate" ], "spread": false, "description": "a new address template with the specified address added at the end." }, "generator": false }, { "__docId__": 190, "kind": "class", "static": true, "variation": null, "name": "MetadataRegistry", "memberof": "esdoc/hal/meta/hal.meta.es6", "longname": "esdoc/hal/meta/hal.meta.es6~MetadataRegistry", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/meta/hal.meta.es6", "importStyle": null, "description": "Registry for existing resource {@link Metadata}.", "lineNumber": 108, "interface": false }, { "__docId__": 191, "kind": "method", "static": false, "variation": null, "name": "contains", "memberof": "esdoc/hal/meta/hal.meta.es6~MetadataRegistry", "longname": "esdoc/hal/meta/hal.meta.es6~MetadataRegistry#contains", "access": null, "description": "Checks whether there's a metadata for the specified template.", "lineNumber": 117, "params": [ { "nullable": null, "types": [ "AddressTemplate", "String" ], "spread": false, "optional": false, "name": "template", "description": "The address template to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "true if the registry contains metadata for the given template, false otherwise" }, "generator": false }, { "__docId__": 192, "kind": "method", "static": false, "variation": null, "name": "lookup", "memberof": "esdoc/hal/meta/hal.meta.es6~MetadataRegistry", "longname": "esdoc/hal/meta/hal.meta.es6~MetadataRegistry#lookup", "access": null, "description": "Returns metadata associated with the specified address template.", "lineNumber": 128, "params": [ { "nullable": null, "types": [ "AddressTemplate", "String" ], "spread": false, "optional": false, "name": "template", "description": "The address template to lookup." } ], "return": { "nullable": null, "types": [ "Metadata" ], "spread": false, "description": "the metadata for the specified template" }, "throws": [ { "types": [ "*" ], "description": "MissingMetadataException if no metadata for the given template exists" } ], "generator": false }, { "__docId__": 193, "kind": "class", "static": true, "variation": null, "name": "StatementContext", "memberof": "esdoc/hal/meta/hal.meta.es6", "longname": "esdoc/hal/meta/hal.meta.es6~StatementContext", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/meta/hal.meta.es6", "importStyle": null, "description": "Contains global state which is updated as you navigate in the console. In standalone mode most of the methods return\nnull.", "lineNumber": 135, "interface": false }, { "__docId__": 194, "kind": "get", "static": false, "variation": null, "name": "domainController", "memberof": "esdoc/hal/meta/hal.meta.es6~StatementContext", "longname": "esdoc/hal/meta/hal.meta.es6~StatementContext#domainController", "access": null, "description": "", "lineNumber": 140, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the domain controller" }, "generator": false }, { "__docId__": 195, "kind": "get", "static": false, "variation": null, "name": "selectedProfile", "memberof": "esdoc/hal/meta/hal.meta.es6~StatementContext", "longname": "esdoc/hal/meta/hal.meta.es6~StatementContext#selectedProfile", "access": null, "description": "", "lineNumber": 145, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the selected profile" }, "generator": false }, { "__docId__": 196, "kind": "get", "static": false, "variation": null, "name": "selectedServerGroup", "memberof": "esdoc/hal/meta/hal.meta.es6~StatementContext", "longname": "esdoc/hal/meta/hal.meta.es6~StatementContext#selectedServerGroup", "access": null, "description": "", "lineNumber": 150, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the selected server group" }, "generator": false }, { "__docId__": 197, "kind": "get", "static": false, "variation": null, "name": "selectedHost", "memberof": "esdoc/hal/meta/hal.meta.es6~StatementContext", "longname": "esdoc/hal/meta/hal.meta.es6~StatementContext#selectedHost", "access": null, "description": "", "lineNumber": 155, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the selected host" }, "generator": false }, { "__docId__": 198, "kind": "get", "static": false, "variation": null, "name": "selectedServerConfig", "memberof": "esdoc/hal/meta/hal.meta.es6~StatementContext", "longname": "esdoc/hal/meta/hal.meta.es6~StatementContext#selectedServerConfig", "access": null, "description": "", "lineNumber": 160, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the selected server config" }, "generator": false }, { "__docId__": 199, "kind": "get", "static": false, "variation": null, "name": "selectedServer", "memberof": "esdoc/hal/meta/hal.meta.es6~StatementContext", "longname": "esdoc/hal/meta/hal.meta.es6~StatementContext#selectedServer", "access": null, "description": "", "lineNumber": 165, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the selected server" }, "generator": false }, { "__docId__": 200, "kind": "class", "static": true, "variation": null, "name": "SecurityContext", "memberof": "esdoc/hal/meta/hal.meta.es6", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/meta/hal.meta.es6", "importStyle": null, "description": "Represents the RBAC related payload from the read-resource-description operation.", "lineNumber": 171, "interface": false }, { "__docId__": 201, "kind": "get", "static": true, "variation": null, "name": "READ_ONLY", "memberof": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext.READ_ONLY", "access": null, "description": "A security context with hardcoded permissions to read resources, write and execute operations are not allowed.", "lineNumber": 176, "generator": false }, { "__docId__": 202, "kind": "get", "static": true, "variation": null, "name": "RWX", "memberof": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext.RWX", "access": null, "description": "A security context with hardcoded permissions to read, write and execute any resource.", "lineNumber": 181, "generator": false }, { "__docId__": 203, "kind": "get", "static": false, "variation": null, "name": "readable", "memberof": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext#readable", "access": null, "description": "", "lineNumber": 186, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether the security context is readable" }, "generator": false }, { "__docId__": 204, "kind": "get", "static": false, "variation": null, "name": "writable", "memberof": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext#writable", "access": null, "description": "", "lineNumber": 191, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether the security context is writable" }, "generator": false }, { "__docId__": 205, "kind": "method", "static": false, "variation": null, "name": "isReadable", "memberof": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext#isReadable", "access": null, "description": "", "lineNumber": 198, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "attribute", "description": "The attribute to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether the attribute is readable" }, "generator": false }, { "__docId__": 206, "kind": "method", "static": false, "variation": null, "name": "isWritable", "memberof": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext#isWritable", "access": null, "description": "", "lineNumber": 205, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "attribute", "description": "The attribute to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether the attribute is writable" }, "generator": false }, { "__docId__": 207, "kind": "method", "static": false, "variation": null, "name": "isExecutable", "memberof": "esdoc/hal/meta/hal.meta.es6~SecurityContext", "longname": "esdoc/hal/meta/hal.meta.es6~SecurityContext#isExecutable", "access": null, "description": "", "lineNumber": 212, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "operation", "description": "The operation to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether the operation is executable" }, "generator": false }, { "__docId__": 208, "kind": "class", "static": true, "variation": null, "name": "MetadataProcessor", "memberof": "esdoc/hal/meta/hal.meta.es6", "longname": "esdoc/hal/meta/hal.meta.es6~MetadataProcessor", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/meta/hal.meta.es6", "importStyle": null, "description": "Reads resource {@link Metadata} using read-resource-description operations and stores it into the {@link\nMetadataRegistry}. If you're sure the metadata is present you can use the {@link MetadataRegistry} instead.", "lineNumber": 219, "interface": false }, { "__docId__": 209, "kind": "method", "static": false, "variation": null, "name": "lookup", "memberof": "esdoc/hal/meta/hal.meta.es6~MetadataProcessor", "longname": "esdoc/hal/meta/hal.meta.es6~MetadataProcessor#lookup", "access": null, "description": "Reads the metadata for the template, stores it in the registry and passes it to the callback. If the metadata is\nalready in the registry it's passed directly to the callback.", "lineNumber": 228, "params": [ { "nullable": null, "types": [ "AddressTemplate", "String" ], "spread": false, "optional": false, "name": "template", "description": "The address template to lookup." }, { "nullable": null, "types": [ "function(metadata: Metadata)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback which receives the metadata." } ], "generator": false }, { "__docId__": 210, "kind": "class", "static": true, "variation": null, "name": "ResourceDescription", "memberof": "esdoc/hal/meta/hal.meta.es6", "longname": "esdoc/hal/meta/hal.meta.es6~ResourceDescription", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/meta/hal.meta.es6", "importStyle": null, "description": "Contains the resource and attribute descriptions from the read-resource-description operation.", "lineNumber": 234, "interface": false }, { "__docId__": 211, "kind": "get", "static": false, "variation": null, "name": "description", "memberof": "esdoc/hal/meta/hal.meta.es6~ResourceDescription", "longname": "esdoc/hal/meta/hal.meta.es6~ResourceDescription#description", "access": null, "description": "", "lineNumber": 239, "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "the resource description" }, "generator": false }, { "__docId__": 212, "kind": "get", "static": false, "variation": null, "name": "operations", "memberof": "esdoc/hal/meta/hal.meta.es6~ResourceDescription", "longname": "esdoc/hal/meta/hal.meta.es6~ResourceDescription#operations", "access": null, "description": "", "lineNumber": 244, "return": { "nullable": null, "types": [ "Property[]" ], "spread": false, "description": "the operation descriptions" }, "generator": false }, { "__docId__": 213, "kind": "method", "static": false, "variation": null, "name": "getAttributes", "memberof": "esdoc/hal/meta/hal.meta.es6~ResourceDescription", "longname": "esdoc/hal/meta/hal.meta.es6~ResourceDescription#getAttributes", "access": null, "description": "", "lineNumber": 249, "params": [], "return": { "nullable": null, "types": [ "Property[]" ], "spread": false, "description": "the attribute descriptions" }, "generator": false }, { "__docId__": 214, "kind": "method", "static": false, "variation": null, "name": "getRequestProperties", "memberof": "esdoc/hal/meta/hal.meta.es6~ResourceDescription", "longname": "esdoc/hal/meta/hal.meta.es6~ResourceDescription#getRequestProperties", "access": null, "description": "", "lineNumber": 254, "params": [], "return": { "nullable": null, "types": [ "Property[]" ], "spread": false, "description": "the request properties of the add operation" }, "generator": false }, { "__docId__": 215, "kind": "class", "static": true, "variation": null, "name": "Metadata", "memberof": "esdoc/hal/meta/hal.meta.es6", "longname": "esdoc/hal/meta/hal.meta.es6~Metadata", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/meta/hal.meta.es6", "importStyle": null, "description": "Simple data struct for common metadata. Used to keep the method signatures small and tidy.", "lineNumber": 260, "interface": false }, { "__docId__": 216, "kind": "get", "static": false, "variation": null, "name": "template", "memberof": "esdoc/hal/meta/hal.meta.es6~Metadata", "longname": "esdoc/hal/meta/hal.meta.es6~Metadata#template", "access": null, "description": "", "lineNumber": 265, "return": { "nullable": null, "types": [ "AddressTemplate" ], "spread": false, "description": "the address template" }, "generator": false }, { "__docId__": 217, "kind": "get", "static": false, "variation": null, "name": "securityContext", "memberof": "esdoc/hal/meta/hal.meta.es6~Metadata", "longname": "esdoc/hal/meta/hal.meta.es6~Metadata#securityContext", "access": null, "description": "", "lineNumber": 270, "return": { "nullable": null, "types": [ "SecurityContext" ], "spread": false, "description": "the security context" }, "generator": false }, { "__docId__": 218, "kind": "get", "static": false, "variation": null, "name": "description", "memberof": "esdoc/hal/meta/hal.meta.es6~Metadata", "longname": "esdoc/hal/meta/hal.meta.es6~Metadata#description", "access": null, "description": "", "lineNumber": 275, "return": { "nullable": null, "types": [ "ResourceDescription" ], "spread": false, "description": "the resource description" }, "generator": false }, { "__docId__": 219, "kind": "file", "static": true, "variation": null, "name": "esdoc/hal/ui/hal.ui.es6", "memberof": null, "longname": "esdoc/hal/ui/hal.ui.es6", "access": null, "description": null, "lineNumber": 9, "content": "/**\n * A form bound to a model using well defined states and operations. The form contains a list of form items which are\n * used to view and modify the attributes of the model. Form item can be bound or unbound. Bound form items show the\n * attributes of the model (text input, check boxes or select boxes), whereas unbound form items have no relation to\n * the model (static text or buttons).\n * \n * @param The model for this form\n */\nclass Form {\n\n \n get undefined() {}\n\n \n get transient() {}\n\n /**\n * @return {T} the current model.\n */\n get model() {}\n\n /**\n * Takes the specified model and updates the read-only state with the values from the model.\n * \n * @param {T} model the model to view.\n */\n view(model) {}\n\n /**\n * Clears this form by removing the model reference and by clearing all form fields.\n */\n clear() {}\n\n /**\n * Takes the specified model and populates the editing state with the values from the model.\n * \n * @param {T} model the model to edit.\n */\n edit(model) {}\n\n /**\n * Validates the form and its fields and upon successful validation persists the changes to the model and\n * calls the save callback.\n */\n save() {}\n\n /**\n * Cancels any modifications to the model.\n */\n cancel() {}\n}\n\n\nclass Table {\n\n \n get selectedRow() {}\n\n \n bindForm(form) {}\n\n \n clear() {}\n\n \n onSelectionChange(handler) {}\n}\n\n\nclass DialogBuilder {\n\n /**\n * Shortcut for a dialog with one 'Close' button.\n */\n closeOnly() {}\n\n /**\n * Shortcut for a dialog with a 'Save' and 'Cancel' button. Clicking on save will execute the specified\n * callback.\n */\n saveCancel(saveCallback) {}\n\n \n primary(label, callback) {}\n\n \n cancel() {}\n\n \n secondary(label, callback) {}\n\n \n build() {}\n\n \n add(element) {}\n\n \n okCancel(okCallback) {}\n\n \n size(size) {}\n}\n\n/**\n * A modal dialog with optional secondary and primary buttons. Only one dialog can be open at a time. The buttons can\n * be placed on the left or the right side. Each button has a callback. The callback is either a {@link Callback}\n * which always closes the dialog or a {@link ResultCallback} with a boolean return value. A value of {@code true}\n * indicates that the dialog should be closed whereas {@code false} keeps the dialog open. You can add as many buttons\n * as you like, but only one of them should be the primary button.\n *

\n * There are convenience methods to add primary and secondary buttons which come with pre-defined placements. If\n * you want to define the placement by yourself use negative numbers to place the buttons on the left side and positive\n * numbers for the right side. On each side the buttons are ordered according to the placement.\n */\nclass Dialog {\n\n \n show() {}\n}\n\n\nclass TableBuilder {\n\n \n column(attribute) {}\n\n \n build() {}\n\n \n add(type, template, attributes, callback) {}\n\n \n remove(type, template, name, callback) {}\n\n \n button(text, scope, handler) {}\n\n \n columns(columns) {}\n}\n\n/**\n * Builder useful to automatically inspect the read-resource-description and associate the\n * attributes (by calling: include, customFormItem). Creates the required form items and help texts.\n */\nclass FormBuilder {\n\n /**\n * Use this flag if you just want to use the form to add model nodes. This will create a form with an\n * {@link AddOnlyStateMachine}.\n *

\n * The attributes will be taken from the {@code ATTRIBUTES} child node.\n */\n addOnly() {}\n\n /**\n * Use this flag if you just want to use the form to add model nodes. This will create a form with an\n * {@link AddOnlyStateMachine}.\n *

\n * The attributes will be taken from the {@code REQUEST_PROPERTIES} node of the {@code ADD} operation.\n */\n fromRequestProperties() {}\n\n \n readOnly() {}\n\n \n unsorted() {}\n\n \n requiredOnly() {}\n\n \n includeRuntime() {}\n\n \n showDeprecated() {}\n\n \n build() {}\n\n \n include(attributes) {}\n\n \n exclude(attributes) {}\n\n \n onSave(callback) {}\n}\n\n" }, { "__docId__": 220, "kind": "class", "static": true, "variation": null, "name": "Form", "memberof": "esdoc/hal/ui/hal.ui.es6", "longname": "esdoc/hal/ui/hal.ui.es6~Form", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/ui/hal.ui.es6", "importStyle": null, "description": "A form bound to a model using well defined states and operations. The form contains a list of form items which are\nused to view and modify the attributes of the model. Form item can be bound or unbound. Bound form items show the\nattributes of the model (text input, check boxes or select boxes), whereas unbound form items have no relation to\nthe model (static text or buttons).", "lineNumber": 9, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "", "description": "The model for this form" } ], "interface": false }, { "__docId__": 221, "kind": "get", "static": false, "variation": null, "name": "undefined", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#undefined", "access": null, "description": null, "lineNumber": 12, "undocument": true, "generator": false }, { "__docId__": 222, "kind": "get", "static": false, "variation": null, "name": "transient", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#transient", "access": null, "description": null, "lineNumber": 15, "undocument": true, "generator": false }, { "__docId__": 223, "kind": "get", "static": false, "variation": null, "name": "model", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#model", "access": null, "description": "", "lineNumber": 20, "return": { "nullable": null, "types": [ "T" ], "spread": false, "description": "the current model." }, "generator": false }, { "__docId__": 224, "kind": "method", "static": false, "variation": null, "name": "view", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#view", "access": null, "description": "Takes the specified model and updates the read-only state with the values from the model.", "lineNumber": 27, "params": [ { "nullable": null, "types": [ "T" ], "spread": false, "optional": false, "name": "model", "description": "the model to view." } ], "generator": false }, { "__docId__": 225, "kind": "method", "static": false, "variation": null, "name": "clear", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#clear", "access": null, "description": "Clears this form by removing the model reference and by clearing all form fields.", "lineNumber": 32, "params": [], "generator": false }, { "__docId__": 226, "kind": "method", "static": false, "variation": null, "name": "edit", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#edit", "access": null, "description": "Takes the specified model and populates the editing state with the values from the model.", "lineNumber": 39, "params": [ { "nullable": null, "types": [ "T" ], "spread": false, "optional": false, "name": "model", "description": "the model to edit." } ], "generator": false }, { "__docId__": 227, "kind": "method", "static": false, "variation": null, "name": "save", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#save", "access": null, "description": "Validates the form and its fields and upon successful validation persists the changes to the model and\ncalls the save callback.", "lineNumber": 45, "params": [], "generator": false }, { "__docId__": 228, "kind": "method", "static": false, "variation": null, "name": "cancel", "memberof": "esdoc/hal/ui/hal.ui.es6~Form", "longname": "esdoc/hal/ui/hal.ui.es6~Form#cancel", "access": null, "description": "Cancels any modifications to the model.", "lineNumber": 50, "params": [], "generator": false }, { "__docId__": 229, "kind": "class", "static": true, "variation": null, "name": "Table", "memberof": "esdoc/hal/ui/hal.ui.es6", "longname": "esdoc/hal/ui/hal.ui.es6~Table", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/ui/hal.ui.es6", "importStyle": null, "description": null, "lineNumber": 54, "undocument": true, "interface": false }, { "__docId__": 230, "kind": "get", "static": false, "variation": null, "name": "selectedRow", "memberof": "esdoc/hal/ui/hal.ui.es6~Table", "longname": "esdoc/hal/ui/hal.ui.es6~Table#selectedRow", "access": null, "description": null, "lineNumber": 57, "undocument": true, "generator": false }, { "__docId__": 231, "kind": "method", "static": false, "variation": null, "name": "bindForm", "memberof": "esdoc/hal/ui/hal.ui.es6~Table", "longname": "esdoc/hal/ui/hal.ui.es6~Table#bindForm", "access": null, "description": null, "lineNumber": 60, "undocument": true, "params": [ { "name": "form", "types": [ "*" ] } ], "generator": false }, { "__docId__": 232, "kind": "method", "static": false, "variation": null, "name": "clear", "memberof": "esdoc/hal/ui/hal.ui.es6~Table", "longname": "esdoc/hal/ui/hal.ui.es6~Table#clear", "access": null, "description": null, "lineNumber": 63, "undocument": true, "params": [], "generator": false }, { "__docId__": 233, "kind": "method", "static": false, "variation": null, "name": "onSelectionChange", "memberof": "esdoc/hal/ui/hal.ui.es6~Table", "longname": "esdoc/hal/ui/hal.ui.es6~Table#onSelectionChange", "access": null, "description": null, "lineNumber": 66, "undocument": true, "params": [ { "name": "handler", "types": [ "*" ] } ], "generator": false }, { "__docId__": 234, "kind": "class", "static": true, "variation": null, "name": "DialogBuilder", "memberof": "esdoc/hal/ui/hal.ui.es6", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/ui/hal.ui.es6", "importStyle": null, "description": null, "lineNumber": 70, "undocument": true, "interface": false }, { "__docId__": 235, "kind": "method", "static": false, "variation": null, "name": "closeOnly", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#closeOnly", "access": null, "description": "Shortcut for a dialog with one 'Close' button.", "lineNumber": 75, "params": [], "generator": false }, { "__docId__": 236, "kind": "method", "static": false, "variation": null, "name": "saveCancel", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#saveCancel", "access": null, "description": "Shortcut for a dialog with a 'Save' and 'Cancel' button. Clicking on save will execute the specified\ncallback.", "lineNumber": 81, "params": [ { "name": "saveCallback", "types": [ "*" ] } ], "generator": false }, { "__docId__": 237, "kind": "method", "static": false, "variation": null, "name": "primary", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#primary", "access": null, "description": null, "lineNumber": 84, "undocument": true, "params": [ { "name": "label", "types": [ "*" ] }, { "name": "callback", "types": [ "*" ] } ], "generator": false }, { "__docId__": 238, "kind": "method", "static": false, "variation": null, "name": "cancel", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#cancel", "access": null, "description": null, "lineNumber": 87, "undocument": true, "params": [], "generator": false }, { "__docId__": 239, "kind": "method", "static": false, "variation": null, "name": "secondary", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#secondary", "access": null, "description": null, "lineNumber": 90, "undocument": true, "params": [ { "name": "label", "types": [ "*" ] }, { "name": "callback", "types": [ "*" ] } ], "generator": false }, { "__docId__": 240, "kind": "method", "static": false, "variation": null, "name": "build", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#build", "access": null, "description": null, "lineNumber": 93, "undocument": true, "params": [], "generator": false }, { "__docId__": 241, "kind": "method", "static": false, "variation": null, "name": "add", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#add", "access": null, "description": null, "lineNumber": 96, "undocument": true, "params": [ { "name": "element", "types": [ "*" ] } ], "generator": false }, { "__docId__": 242, "kind": "method", "static": false, "variation": null, "name": "okCancel", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#okCancel", "access": null, "description": null, "lineNumber": 99, "undocument": true, "params": [ { "name": "okCallback", "types": [ "*" ] } ], "generator": false }, { "__docId__": 243, "kind": "method", "static": false, "variation": null, "name": "size", "memberof": "esdoc/hal/ui/hal.ui.es6~DialogBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~DialogBuilder#size", "access": null, "description": null, "lineNumber": 102, "undocument": true, "params": [ { "name": "size", "types": [ "*" ] } ], "generator": false }, { "__docId__": 244, "kind": "class", "static": true, "variation": null, "name": "Dialog", "memberof": "esdoc/hal/ui/hal.ui.es6", "longname": "esdoc/hal/ui/hal.ui.es6~Dialog", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/ui/hal.ui.es6", "importStyle": null, "description": "A modal dialog with optional secondary and primary buttons. Only one dialog can be open at a time. The buttons can\nbe placed on the left or the right side. Each button has a callback. The callback is either a {@link Callback}\nwhich always closes the dialog or a {@link ResultCallback} with a boolean return value. A value of {@code true}\nindicates that the dialog should be closed whereas {@code false} keeps the dialog open. You can add as many buttons\nas you like, but only one of them should be the primary button.\n

\nThere are convenience methods to add primary and secondary buttons which come with pre-defined placements. If\nyou want to define the placement by yourself use negative numbers to place the buttons on the left side and positive\nnumbers for the right side. On each side the buttons are ordered according to the placement.", "lineNumber": 116, "interface": false }, { "__docId__": 245, "kind": "method", "static": false, "variation": null, "name": "show", "memberof": "esdoc/hal/ui/hal.ui.es6~Dialog", "longname": "esdoc/hal/ui/hal.ui.es6~Dialog#show", "access": null, "description": null, "lineNumber": 119, "undocument": true, "params": [], "generator": false }, { "__docId__": 246, "kind": "class", "static": true, "variation": null, "name": "TableBuilder", "memberof": "esdoc/hal/ui/hal.ui.es6", "longname": "esdoc/hal/ui/hal.ui.es6~TableBuilder", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/ui/hal.ui.es6", "importStyle": null, "description": null, "lineNumber": 123, "undocument": true, "interface": false }, { "__docId__": 247, "kind": "method", "static": false, "variation": null, "name": "column", "memberof": "esdoc/hal/ui/hal.ui.es6~TableBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~TableBuilder#column", "access": null, "description": null, "lineNumber": 126, "undocument": true, "params": [ { "name": "attribute", "types": [ "*" ] } ], "generator": false }, { "__docId__": 248, "kind": "method", "static": false, "variation": null, "name": "build", "memberof": "esdoc/hal/ui/hal.ui.es6~TableBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~TableBuilder#build", "access": null, "description": null, "lineNumber": 129, "undocument": true, "params": [], "generator": false }, { "__docId__": 249, "kind": "method", "static": false, "variation": null, "name": "add", "memberof": "esdoc/hal/ui/hal.ui.es6~TableBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~TableBuilder#add", "access": null, "description": null, "lineNumber": 132, "undocument": true, "params": [ { "name": "type", "types": [ "*" ] }, { "name": "template", "types": [ "*" ] }, { "name": "attributes", "types": [ "*" ] }, { "name": "callback", "types": [ "*" ] } ], "generator": false }, { "__docId__": 250, "kind": "method", "static": false, "variation": null, "name": "remove", "memberof": "esdoc/hal/ui/hal.ui.es6~TableBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~TableBuilder#remove", "access": null, "description": null, "lineNumber": 135, "undocument": true, "params": [ { "name": "type", "types": [ "*" ] }, { "name": "template", "types": [ "*" ] }, { "name": "name", "types": [ "*" ] }, { "name": "callback", "types": [ "*" ] } ], "generator": false }, { "__docId__": 251, "kind": "method", "static": false, "variation": null, "name": "button", "memberof": "esdoc/hal/ui/hal.ui.es6~TableBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~TableBuilder#button", "access": null, "description": null, "lineNumber": 138, "undocument": true, "params": [ { "name": "text", "types": [ "*" ] }, { "name": "scope", "types": [ "*" ] }, { "name": "handler", "types": [ "*" ] } ], "generator": false }, { "__docId__": 252, "kind": "method", "static": false, "variation": null, "name": "columns", "memberof": "esdoc/hal/ui/hal.ui.es6~TableBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~TableBuilder#columns", "access": null, "description": null, "lineNumber": 141, "undocument": true, "params": [ { "name": "columns", "types": [ "*" ] } ], "generator": false }, { "__docId__": 253, "kind": "class", "static": true, "variation": null, "name": "FormBuilder", "memberof": "esdoc/hal/ui/hal.ui.es6", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "access": null, "export": false, "importPath": "org.jboss.hal.npm/esdoc/hal/ui/hal.ui.es6", "importStyle": null, "description": "Builder useful to automatically inspect the read-resource-description and associate the\nattributes (by calling: include, customFormItem). Creates the required form items and help texts.", "lineNumber": 148, "interface": false }, { "__docId__": 254, "kind": "method", "static": false, "variation": null, "name": "addOnly", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#addOnly", "access": null, "description": "Use this flag if you just want to use the form to add model nodes. This will create a form with an\n{@link AddOnlyStateMachine}.\n

\nThe attributes will be taken from the {@code ATTRIBUTES} child node.", "lineNumber": 156, "params": [], "generator": false }, { "__docId__": 255, "kind": "method", "static": false, "variation": null, "name": "fromRequestProperties", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#fromRequestProperties", "access": null, "description": "Use this flag if you just want to use the form to add model nodes. This will create a form with an\n{@link AddOnlyStateMachine}.\n

\nThe attributes will be taken from the {@code REQUEST_PROPERTIES} node of the {@code ADD} operation.", "lineNumber": 164, "params": [], "generator": false }, { "__docId__": 256, "kind": "method", "static": false, "variation": null, "name": "readOnly", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#readOnly", "access": null, "description": null, "lineNumber": 167, "undocument": true, "params": [], "generator": false }, { "__docId__": 257, "kind": "method", "static": false, "variation": null, "name": "unsorted", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#unsorted", "access": null, "description": null, "lineNumber": 170, "undocument": true, "params": [], "generator": false }, { "__docId__": 258, "kind": "method", "static": false, "variation": null, "name": "requiredOnly", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#requiredOnly", "access": null, "description": null, "lineNumber": 173, "undocument": true, "params": [], "generator": false }, { "__docId__": 259, "kind": "method", "static": false, "variation": null, "name": "includeRuntime", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#includeRuntime", "access": null, "description": null, "lineNumber": 176, "undocument": true, "params": [], "generator": false }, { "__docId__": 260, "kind": "method", "static": false, "variation": null, "name": "showDeprecated", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#showDeprecated", "access": null, "description": null, "lineNumber": 179, "undocument": true, "params": [], "generator": false }, { "__docId__": 261, "kind": "method", "static": false, "variation": null, "name": "build", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#build", "access": null, "description": null, "lineNumber": 182, "undocument": true, "params": [], "generator": false }, { "__docId__": 262, "kind": "method", "static": false, "variation": null, "name": "include", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#include", "access": null, "description": null, "lineNumber": 185, "undocument": true, "params": [ { "name": "attributes", "types": [ "*" ] } ], "generator": false }, { "__docId__": 263, "kind": "method", "static": false, "variation": null, "name": "exclude", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#exclude", "access": null, "description": null, "lineNumber": 188, "undocument": true, "params": [ { "name": "attributes", "types": [ "*" ] } ], "generator": false }, { "__docId__": 264, "kind": "method", "static": false, "variation": null, "name": "onSave", "memberof": "esdoc/hal/ui/hal.ui.es6~FormBuilder", "longname": "esdoc/hal/ui/hal.ui.es6~FormBuilder#onSave", "access": null, "description": null, "lineNumber": 191, "undocument": true, "params": [ { "name": "callback", "types": [ "*" ] } ], "generator": false }, { "__docId__": 266, "kind": "external", "static": true, "variation": null, "name": "Infinity", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Infinity", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Infinity", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 267, "kind": "external", "static": true, "variation": null, "name": "NaN", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~NaN", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 268, "kind": "external", "static": true, "variation": null, "name": "undefined", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~undefined", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 269, "kind": "external", "static": true, "variation": null, "name": "null", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~null", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 270, "kind": "external", "static": true, "variation": null, "name": "Object", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Object", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 271, "kind": "external", "static": true, "variation": null, "name": "object", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~object", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 272, "kind": "external", "static": true, "variation": null, "name": "Function", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Function", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 273, "kind": "external", "static": true, "variation": null, "name": "function", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~function", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 274, "kind": "external", "static": true, "variation": null, "name": "Boolean", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Boolean", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 275, "kind": "external", "static": true, "variation": null, "name": "boolean", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~boolean", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 276, "kind": "external", "static": true, "variation": null, "name": "Symbol", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Symbol", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 277, "kind": "external", "static": true, "variation": null, "name": "Error", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Error", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 278, "kind": "external", "static": true, "variation": null, "name": "EvalError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~EvalError", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 279, "kind": "external", "static": true, "variation": null, "name": "InternalError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/InternalError", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~InternalError", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 280, "kind": "external", "static": true, "variation": null, "name": "RangeError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~RangeError", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 281, "kind": "external", "static": true, "variation": null, "name": "ReferenceError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~ReferenceError", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 282, "kind": "external", "static": true, "variation": null, "name": "SyntaxError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~SyntaxError", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 283, "kind": "external", "static": true, "variation": null, "name": "TypeError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~TypeError", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 284, "kind": "external", "static": true, "variation": null, "name": "URIError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~URIError", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 285, "kind": "external", "static": true, "variation": null, "name": "Number", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Number", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 286, "kind": "external", "static": true, "variation": null, "name": "number", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~number", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 287, "kind": "external", "static": true, "variation": null, "name": "Date", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Date", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 288, "kind": "external", "static": true, "variation": null, "name": "String", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~String", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 289, "kind": "external", "static": true, "variation": null, "name": "string", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~string", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 290, "kind": "external", "static": true, "variation": null, "name": "RegExp", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~RegExp", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 291, "kind": "external", "static": true, "variation": null, "name": "Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 292, "kind": "external", "static": true, "variation": null, "name": "Int8Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Int8Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 293, "kind": "external", "static": true, "variation": null, "name": "Uint8Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Uint8Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 294, "kind": "external", "static": true, "variation": null, "name": "Uint8ClampedArray", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Uint8ClampedArray", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 295, "kind": "external", "static": true, "variation": null, "name": "Int16Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Int16Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 296, "kind": "external", "static": true, "variation": null, "name": "Uint16Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Uint16Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 297, "kind": "external", "static": true, "variation": null, "name": "Int32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Int32Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 298, "kind": "external", "static": true, "variation": null, "name": "Uint32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Uint32Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 299, "kind": "external", "static": true, "variation": null, "name": "Float32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Float32Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 300, "kind": "external", "static": true, "variation": null, "name": "Float64Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Float64Array", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 301, "kind": "external", "static": true, "variation": null, "name": "Map", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Map", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 302, "kind": "external", "static": true, "variation": null, "name": "Set", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Set", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 303, "kind": "external", "static": true, "variation": null, "name": "WeakMap", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~WeakMap", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 304, "kind": "external", "static": true, "variation": null, "name": "WeakSet", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~WeakSet", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 305, "kind": "external", "static": true, "variation": null, "name": "ArrayBuffer", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~ArrayBuffer", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 306, "kind": "external", "static": true, "variation": null, "name": "DataView", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~DataView", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 307, "kind": "external", "static": true, "variation": null, "name": "JSON", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~JSON", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 308, "kind": "external", "static": true, "variation": null, "name": "Promise", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Promise", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 309, "kind": "external", "static": true, "variation": null, "name": "Generator", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Generator", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 310, "kind": "external", "static": true, "variation": null, "name": "GeneratorFunction", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/GeneratorFunction", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~GeneratorFunction", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 311, "kind": "external", "static": true, "variation": null, "name": "Reflect", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Reflect", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Reflect", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 312, "kind": "external", "static": true, "variation": null, "name": "Proxy", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy", "memberof": "BuiltinExternal/ECMAScriptExternal.js", "longname": "BuiltinExternal/ECMAScriptExternal.js~Proxy", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 314, "kind": "external", "static": true, "variation": null, "name": "CanvasRenderingContext2D", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~CanvasRenderingContext2D", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 315, "kind": "external", "static": true, "variation": null, "name": "DocumentFragment", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/API/DocumentFragment", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~DocumentFragment", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 316, "kind": "external", "static": true, "variation": null, "name": "Element", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/API/Element", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~Element", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 317, "kind": "external", "static": true, "variation": null, "name": "Event", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/API/Event", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~Event", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 318, "kind": "external", "static": true, "variation": null, "name": "Node", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/API/Node", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~Node", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 319, "kind": "external", "static": true, "variation": null, "name": "NodeList", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/API/NodeList", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~NodeList", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 320, "kind": "external", "static": true, "variation": null, "name": "XMLHttpRequest", "externalLink": "https://developer.mozilla.org/en/docs/Web/API/XMLHttpRequest", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~XMLHttpRequest", "access": null, "description": "", "builtinExternal": true }, { "__docId__": 321, "kind": "external", "static": true, "variation": null, "name": "AudioContext", "externalLink": "https://developer.mozilla.org/en/docs/Web/API/AudioContext", "memberof": "BuiltinExternal/WebAPIExternal.js", "longname": "BuiltinExternal/WebAPIExternal.js~AudioContext", "access": null, "description": "", "builtinExternal": true } ]