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

public class | source

Proof

Member Summary

Public Members
public	approvedDate: Date The time/date the proof was approved.
public	canDownload: boolean Whether the original file can be downloaded by the user.
public	commentCount: number The number of comments on the proof.
public	createdDate: Date The time/date the proof was created.
public	dueDate: Date The date the proof is due.
public	editorUserId: string If a user has been assigned to make changes to the file (when to-dos have been requested), this is their user id.
public	fileExtension: string The uploaded file extension.
public	fileId: string The unique file identifier.
public	fileMessage: string The message describing how the file was processed.
public	fileStatus: FileStatus The status of the uploaded file.
public	id: string The proof unique identifier (16 characters, beginning with P).
public	isArchived: boolean Whether the proof has been manually archived.
public	isLocked: boolean Whether the proof has been locked by a user.
public	isOverdue: boolean Whether the proof has passed it's due date.
public	lockerUserId: string The user id of the user who last locked the proof.
public	messageToEditor: string This message is directed at a user when an owner makes them the editor.
public	messageToOwners: string This message is from the approver/gatekeeper when they send to-dos back to the proof owners.
public	messageToReviewers: string The message which is sent to all reviewers in the invitation to proof email.
public	name: string The name of the proof.
public	ownerUserIds: Array<string> The user ids of the user's who own the proof.
public	pageCount: number The number of pages (for static proofs).
public	state: ProofState The proof state.
public	status: number The numeric value of the proofs status.
public	uploaderUserId: string The user id of the user who originally uploaded the proof.
public	version: number The version number of the proof.
public	workflowId: string The workflow identifier.

Method Summary

Public Methods
public	canUserUploadNewVersion(userId: string): boolean Whether a user has the ability to upload a new version of the proof.
public	getProcessingProgress(): number The processing progress (float between -1, 0 and 1).
public	hasEditor(): boolean Whether the proof currently has an editor attached to it.
public	hasFile(): boolean Whether the proof has a file attached to it.
public	hasFileError(): boolean Whether the file attached to the proof errored during processing.
public	hasThumbnail(): boolean Whether the proof has a usable thumbnail that the user should be presented with.
public	hasWorkflow(): boolean Whether the proof has a workflow attached it it.
public	hasWorkflowStarted(): boolean Whether the workflow has started.
public	isOwner(userId: string): boolean Whether the user is an owner on the proof.
public	isProcessing(): boolean Whether the proof is currently processing.

Public Members

public approvedDate: Date source

The time/date the proof was approved.

public canDownload: boolean source

Whether the original file can be downloaded by the user.

public commentCount: number source

The number of comments on the proof. This number only consists of comments, not replies.

public createdDate: Date source

The time/date the proof was created.

public dueDate: Date source

The date the proof is due.

public editorUserId: string source

If a user has been assigned to make changes to the file (when to-dos have been requested), this is their user id.

public fileExtension: string source

The uploaded file extension.

public fileId: string source

The unique file identifier.

public fileMessage: string source

The message describing how the file was processed. If this field is empty, it usually means that there was no issue processing the file - if not, the Proof.fileStatus will be FileStatus.ERROR.

public fileStatus: FileStatus source

The status of the uploaded file.

public id: string source

The proof unique identifier (16 characters, beginning with P).

public isArchived: boolean source

Whether the proof has been manually archived. This field doesn't cover when the proof is automatically "archived"/hidden from the dashboard.

public isLocked: boolean source

Whether the proof has been locked by a user.

See:

Proof.lockerUserId

public isOverdue: boolean source

Whether the proof has passed it's due date.

public lockerUserId: string source

The user id of the user who last locked the proof.

public messageToEditor: string source

This message is directed at a user when an owner makes them the editor.

public messageToOwners: string source

This message is from the approver/gatekeeper when they send to-dos back to the proof owners.

public messageToReviewers: string source

The message which is sent to all reviewers in the invitation to proof email.

Note: This message is available to all reviewers, owners and editor in the proof info pane in the app.

public name: string source

The name of the proof.

This field cannot be blank. In the app, this field is automatically pre-populated with the file name minus the extension.

public ownerUserIds: Array<string> source

The user ids of the user's who own the proof.

public pageCount: number source

The number of pages (for static proofs). This is always set to "1" for video & web proofs.

public state: ProofState source

The proof state. This field is preferred over using Proof.status, as it's calculated from a number of different factors.

public status: number source

The numeric value of the proofs status. It is not recommended you use this field, it's better to use the Proof.state field - which is calculated from a number of different factors.

public uploaderUserId: string source

The user id of the user who originally uploaded the proof.

If the file failed to process, any owner also has the ability to re-upload it - not just the original uploader.

When an editor is assigned to make changes, and uploads a new version, the original owner of the previous proof is used - not the editor.

public version: number source

The version number of the proof.

Version numbers start at "1", so even if a proof has no versions, this value will be "1" (truthy).

public workflowId: string source

The workflow identifier.

The only time this field is empty is when the Proof.uploaderUserId user uploads the proof and attaches an owner (or owner(s)) to complete the proof setup.

Public Methods

public canUserUploadNewVersion(userId: string): boolean source

Whether a user has the ability to upload a new version of the proof.

Params:

Name	Type	Attribute	Description
userId	string		The user id