cepheusEvent

cepheusEvent

Contains constants and functions for a Generic Cepheus Event.

The structure for a Generic Cepheus Event is as follows:

{
  type: 'Push Service'
  vendor: 'com.adobe.cepheus'
  annotations: <array>,
  clientId: <string>,
  payload: <object>,
  timestamp: <number>,
  uuid: <string>,
}
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 Generic Cepheus Event 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 Generic Cepheus Event

Properties:
Name Type Description
rootType string

The type of event.
Path is type.
vendor string

The vendor of the service that sent the event.
Path is vendor.
annotations string

Array of Annotation objects.
Path is annotations.
clientId string

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

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

When the event occurred.
Path is timestamp.
rootId string

Uniquely identifies each event.
Path is uuid.
Source:

(static, constant) ROOT_TYPE

The value for rootType for a Generic Cepheus Event.

Path is type.

Source:

(static, constant) VENDOR

The value for vendor for a Generic Cepheus Event.

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) getVendor(source) → {string}

Returns the vendor from the Generic Cepheus Event. This is the the vendor of the service that sent the event.

Path is vendor.

Parameters:
Name Type Description
source object

The Generic Cepheus Event instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Generic Cepheus Event event.

Parameters:
Name Type Description
source object

The Generic Cepheus Event instance
Source:
See:
  • kit.isMatch

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

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