pushFeedback

pushFeedback

Contains constants and functions for a Push Request Feedback.

The structure for a Push Request Feedback is as follows:

{
  payload: {
    event: 'feedback sent to pipeline'
    responseCode: <integer>,
    responseMessage: <string>,
    feedback: {
      groupID: <string>,
      platform: <string>,
      status: <string>,
    },
  },
  type: 'Push Service'
  vendor: 'com.adobe.cepheus'
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(static, constant) EVENT_NAME

The value for eventName for a Push Request Feedback.

Path is payload,event.

Source:

(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 Push Request Feedback 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 Push Request Feedback

Properties:
Name Type Description
payload string

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

The name of the event.
Path is payload.event.
responseCode string

Response code.
Path is payload.responseCode.
responseMessage string

Response message.
Path is payload.responseMessage.
feedback string

The response.
Path is payload.feedback.
groupId string

id to stitch the requests together.
Path is payload.feedback.groupID.
platform string

The platform to send the push to.
Path is payload.feedback.platform.
status string

The status of the request.
Path is payload.feedback.status.
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.
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 Push Request Feedback.

Path is type.

Source:

(static, constant) VENDOR

The value for vendor for a Push Request Feedback.

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

Returns the eventName from the Push Request Feedback. This is the the name of the event.

Path is payload,event.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:

(static) getFeedback(source) → {object}

Returns the feedback from the Push Request Feedback. This is the the response.

Path is payload,feedback.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:

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

Returns the data using the specified path from the feedback of the Push Request Feedback.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Push Request Feedback instance
Source:

(static) getGroupId(source) → {string}

Returns the groupId from the Push Request Feedback. This is the id to stitch the requests together.

Path is payload,feedback,groupID.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:

(static) getPlatform(source) → {string}

Returns the platform from the Push Request Feedback. This is the the platform to send the push to.

Path is payload,feedback,platform.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:

(static) getResponseCode(source) → {number}

Returns the responseCode from the Push Request Feedback. This is the response code.

Path is payload,responseCode.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:

(static) getResponseMessage(source) → {string}

Returns the responseMessage from the Push Request Feedback. This is the response message.

Path is payload,responseMessage.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:

(static) getStatus(source) → {string}

Returns the status from the Push Request Feedback. This is the the status of the request.

Path is payload,feedback,status.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Push Request Feedback event.

Parameters:
Name Type Description
source object

The Push Request Feedback instance
Source:
See:
  • kit.isMatch

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

Generates a Push Request Feedback 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 Push Request Feedback 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: