PreviewImageError
> PreviewImageError

The parameter passed to the error callback of PreviewImageOptions.

  • 0.8

NOTE This is an abstract type. Any object meeting this description can be used where this type is used.

Defined By

Properties

PreviewImageError
code : Number

Error code, if applicable.

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:

Overrides: FailureResponse.code

PreviewImageError
error : String

Error message, if any returned.

Error message, if any returned.

May be undefined.

  • 3.1.0

Overrides: FailureResponse.error

PreviewImageError
: Stringdeprecated
Description of the error. ...

Description of the error.

deprecated since 3.1.0

PreviewImageError
: Boolean
Indicates if the operation succeeded. ...

Indicates if the operation succeeded. Returns false.

Returns false.

  • 3.1.0

Overrides: FailureResponse.success