import File from '@pageproof/sdk/src/models/File.js'

public class | source

File

Member Summary

Public Members
public	assignedTo: string \| null The entity identifier the file is assigned to (like a proof or comment).
public	assignedType: FileAssignee The type of entity the file is assigned to.
public	downloadable: boolean Whether the file can be downloaded by the user.
public	id: string The file's unique identifer, often referred to the file token.
public	message: string The file's error message (if the file status is FileStatus.ERROR). This field should only be used for debugging purposes. Not to be presented to the user.
public	name: string The file name (containing the file's extension).
public	status: FileStatus The file status.

Public Members

public assignedTo: string | null source

The entity identifier the file is assigned to (like a proof or comment).

public assignedType: FileAssignee source

The type of entity the file is assigned to.

A comment, for example can have an attachment and (in some cases) a snapshot, which is like an attachment, but is used in HTML proofs as the "screenshot" to represent the view at the time of creating the comment.

public downloadable: boolean source

Whether the file can be downloaded by the user.

public id: string source

The file's unique identifer, often referred to the file token.

public message: string source

The file's error message (if the file status is FileStatus.ERROR).

This field should only be used for debugging purposes. Not to be presented to the user.

public name: string source

The file name (containing the file's extension).

public status: FileStatus source

The file status.