fakeEventCommand

fakeEventCommand

Contains constants and functions for a Fake Event Command.

The structure for a Fake Event Command is as follows:

{
  payload: {
    type: 'fakeEvent'
    detail: {
      eventName: <string>,
      eventType: <string>,
      eventSource: <string>,
      eventData: <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 Fake Event 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 Fake Event 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

Additional command detail.
Path is payload.detail.
eventName string

The name of the event.
Path is payload.detail.eventName.
eventType string

The event type.
Path is payload.detail.eventType.
eventSource string

The event source.
Path is payload.detail.eventSource.
eventData string

An object with the custom data describing the event.
Path is payload.detail.eventData.
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 Fake Event Command.

Path is type.

Source:

(static, constant) TYPE

The value for type for a Fake Event Command.

Path is payload,type.

Source:

(static, constant) VENDOR

The value for vendor for a Fake Event 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 Fake Event Command. This is the additional command detail.

Path is payload,detail.

Parameters:
Name Type Description
source object

The Fake Event Command instance
Source:

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

Returns the data using the specified path from the detail of the Fake Event Command.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Fake Event Command instance
Source:

(static) getEventData(source) → {object}

Returns the eventData from the Fake Event Command. This is the an object with the custom data describing the event.

Path is payload,detail,eventData.

Parameters:
Name Type Description
source object

The Fake Event Command instance
Source:

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

Returns the data using the specified path from the eventData of the Fake Event Command.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Fake Event Command instance
Source:

(static) getEventName(source) → {string}

Returns the eventName from the Fake Event Command. This is the the name of the event.

Path is payload,detail,eventName.

Parameters:
Name Type Description
source object

The Fake Event Command instance
Source:

(static) getEventSource(source) → {string}

Returns the eventSource from the Fake Event Command. This is the the event source.

Path is payload,detail,eventSource.

Parameters:
Name Type Description
source object

The Fake Event Command instance
Source:

(static) getEventType(source) → {string}

Returns the eventType from the Fake Event Command. This is the the event type.

Path is payload,detail,eventType.

Parameters:
Name Type Description
source object

The Fake Event Command instance
Source:

(static) getType(source) → {string}

Returns the type from the Fake Event Command. This is the the type of command.

Path is payload,type.

Parameters:
Name Type Description
source object

The Fake Event Command instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Fake Event Command event.

Parameters:
Name Type Description
source object

The Fake Event Command instance
Source:
See:
  • kit.isMatch

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

Generates a Fake Event 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 Fake Event 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: