Plugin API » Schema » SCHEMA (global) » Query functions » Aliased attribute queries

Aliased attribute queries

Plugins can query the schema to find out more information about the aliased attributes defined in the current application.

Schema query

function SCHEMA.getAliasedAttributeInfo(aliasedAttribute)

Returns a JavaScript object with properties describing the aliased attribute, described below.

aliasedAttribute must be one of the ALIASED_ATTR properties. You should not rely on the exact underlying type of this value in your code.

Info properties

Each attribute information object contains the following keys:

key name

The name of the aliased attribute, suitable for displaying to the user.

key code

The API code for the attribute, eg "std:aliased-attribute:name". May be undefined if the aliased attribute does not have an API code.

key aliasOf

The underlying attribute this value is an alias for. Returns one of the ATTR properties.

key shortName

The short name, or “search name”, of the aliased attribute. Used in search constraints.