# SnapshotResult

The parameter passed to the takeSnapshot callback.

Availability

8.0.0

9.2.0

Extends

Object

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

Availability

8.0.0

9.2.0

error :String

Error message, if any returned.

May be undefined.

Availability

8.0.0

9.2.0

The snapshot image.

Availability

8.0.0

9.2.0

success :Boolean

Indicates if the snapshot taken.

Returns true on successful snapshot captured, otherwise false.