configUpdateCommand

configUpdateCommand

Contains constants and functions for a Config Update Command.

The structure for a Config Update Command is as follows:

{
  payload: {
    type: 'configUpdate'
    detail: <object>,
  },
  vendor: 'com.adobe.griffon.mobile'
  clientId: <string>,
  timestamp: <number>,
  type: 'control'
}
Source:

Members

(static, constant) group

A grouping for this object

Source:

(static, constant) label

A label that can be used when describing this object

Source:

(static, constant) matcher

Matcher can be used to find matching Config Update Command objects.

Source:
See:
  • kit.match

(static, constant) parentDepth

Describes the number of parents this object has based off schema references. When checking for matches for example, we want to use a schema that is more specific over a more generic schema

Source:

(static, constant) path :string

Paths for the keys on a Config Update Command

Properties:
Name Type Description
payload string

An object with custom data describing the event.
Path is payload.
type string

The type of command.
Path is payload.type.
detail string

Object containing the config paths and values to update.
Path is payload.detail.
vendor string

The vendor of the plugin to receive the command.
Path is vendor.
clientId string

A unique id that differentiates clients from one another.
Path is clientId.
timestamp string

When the command was triggered.
Path is timestamp.
rootType string

The type of event. For commands it's always 'control'..
Path is type.
Source:

(static, constant) ROOT_TYPE

The value for rootType for a Config Update Command.

Path is type.

Source:

(static, constant) TYPE

The value for type for a Config Update Command.

Path is payload,type.

Source:

(static, constant) VENDOR

The value for vendor for a Config Update Command.

Path is vendor.

Source:

Methods

(static) get(alias, data) → {*}

Retrieves a value from the object. You can provide either a path or an alias.

Parameters:
Name Type Description
alias string

Path or alias
data *

Data to search
Source:

(static) getDetail(source) → {object}

Returns the detail from the Config Update Command. This is the object containing the config paths and values to update.

Path is payload,detail.

Parameters:
Name Type Description
source object

The Config Update Command instance
Source:

(static) getDetailKey(…path, source) → {*}

Returns the data using the specified path from the detail of the Config Update Command.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Config Update Command instance
Source:

(static) getType(source) → {string}

Returns the type from the Config Update Command. This is the the type of command.

Path is payload,type.

Parameters:
Name Type Description
source object

The Config Update Command instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Config Update Command event.

Parameters:
Name Type Description
source object

The Config Update Command instance
Source:
See:
  • kit.isMatch

(static) make(…input) → {object}

Generates a Config Update Command with the const values set. Can be useful in testing. Can provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source:

(static) mock(…input) → {object}

Generates a Config Update Command with some default values set. Can be useful in testing. Can override defaults and provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source: