screenshotResponse

screenshotResponse

Contains constants and functions for a Screenshot Response Event.

The structure for a Screenshot Response Event is as follows:

{
  payload: {
    blobId: <string>,
    mimeType: <string>,
  },
  type: 'blob'
  annotations: <array>,
  clientId: <string>,
  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 Screenshot Response 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 Screenshot Response Event

Properties:
Name Type Description
payload string

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

ID returned from the blob service.
Path is payload.blobId.
mimeType string

Describes the type of blob content uploaded.
Path is payload.mimeType.
rootType string

The type of event.
Path is type.
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 Screenshot Response Event.

Path is type.

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

Returns the blobId from the Screenshot Response Event. This is the iD returned from the blob service.

Path is payload,blobId.

Parameters:
Name Type Description
source object

The Screenshot Response Event instance
Source:

(static) getMimeType(source) → {string}

Returns the mimeType from the Screenshot Response Event. This is the describes the type of blob content uploaded.

Path is payload,mimeType.

Parameters:
Name Type Description
source object

The Screenshot Response Event instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Screenshot Response Event event.

Parameters:
Name Type Description
source object

The Screenshot Response Event instance
Source:
See:
  • kit.isMatch

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

Generates a Screenshot Response 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 Screenshot Response 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: