# PreviewImageError

The parameter passed to the error callback of PreviewImageOptions.

Availability

0.8

Extends

NOTE

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

# Properties

Availability

0.8

code :Number

Error code, if applicable.

If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1.

This API can be assigned the following constants:

Availability

3.1.0

error :String

Error message, if any returned.

May be undefined.

Availability

0.8

message :String

DEPRECATED SINCE 3.1.0

Use error property instead

Description of the error.

Availability

3.1.0

success :Boolean

Indicates if the operation succeeded. Returns false.

Returns false.