Class BoardExportTaskResultInternal

Board export task results.

Hierarchy

  • BoardExportTaskResult

Constructors

constructor

Properties

boardId errorMessage? errorType? exportLink? status

Constructors

constructor

Properties

boardId

boardId: string

Unique identifier of the board.

Optional errorMessage

errorMessage?: string

Contains the description of the error that occurred during a board export task.

Optional errorType

errorType?: string

Indicates the type of error encountered during the board export task. Possible values: TEMPORARY: the board export task encountered a temporary error. Retry the board export task after some time. FATAL: the board export failed and cannot be retried. This export will never succeed due to issues such as board corruption, non-existence, or other unrecoverable errors. Please verify the board's state or contact support if assistance is needed. UNKNOWN: the board export task encountered an unexpected exception. Retry the board export task after some time.

Optional exportLink

exportLink?: string

URL of the S3 bucket that contains the exported files.

status

status: string

Indicates the status of the individual board export task. Possible values: SUCCESS: the board export task was completed successfully and the results are available. ERROR: the board export task encountered an error and failed to complete. The errorMessage field provides more information on the error.

@mirohq/miro-api