Class: ConfigObject

ConfigObject

new ConfigObject()

Extends

Members

category :String

The name of the category of the configuration object.

Type:
  • String

(readonly) id :Integer

The ID of this object.

Type:
  • Integer
Inherited From:

index :Integer

An index to allow ordering of multiple configuration objects with the same category to express preference. A lower value represents a higher priority.

Type:
  • Integer

name :String

The name of this object.

Type:
  • String
Inherited From:

properties :Object.<string, string>

A place to store arbitrary string properties. In some cases objects store their configuration inside this hash/dictionary. If you store custom properties make sure you prefix them with your moduleId.

Type:
  • Object.<string, string>
Inherited From:
See:
  • upgrade_module

reference :String

The reference of this object. May only contain the characters A-Za-z0-9_.+: -.

Type:
  • String
Inherited From:
Default Value:
  • ""

status :ElementStatus

The object status.

Type:
Inherited From:
Default Value:
  • ElementStatus.Active