API docs     >     Files

File

Description

The File class, which represents an instance of a File.

Methods

Constructor of the File class
Acquires a lock on the current instance of this Object
Approves the current/specified version of the Object instance
Calculates a unique permanent name for this File
Calls a specific Extension hook Callback method
Calls a specific Extension hook Callback method
Checks if the specified lock token is set on the current instance of this Object
Copies Extensions from another File to this File
Copies Properties, Extensions, Permissions, Views, Tags from another File into this File
Copies Permissions from another Object to this Object
Copies Properties from another Object to this Object
Copies Tags from another Object to this Object
Copies Views from another File to this File
Moves this File to the trashcan
Cleans up the provided permanent name
get
Gets basic information about this File
Gets the File prefix of this File
Gets the first approved version of the Object instance
Gets the Object Id of the current instance
Gets the latest approved version of the Object instance
Gets the latest version of the Object instance
Checks if the current instance of this Object is locked
Gets the name of the Properties Table for this Object
Gets the currently published version of the Object instance
Gets the URL of this File
Gets the version of the Object instance
Gets all versions of the Object instance
Checks if the published version of the Object instance is 999999 (ALWAYS_LATEST_APPROVED_VERSION) and thus the latest approved version of the Object will get published automatically on approval.
Generates a new version of this File by copying the currently instanced version and updates the currently instanced Object to the new version
Callback method which is executed when a Usergroup permission on a File changes
Callback method which is executed when Usergroup permissions on a File change
Helper method for processing of scheduled approvals
Sets the specified version of the Object instance to "published"
Releases a lock on the current instance of this Object
Sets Filename of this File
Sets filesize of this File
Sets Filetype of this File
Sets the permanent name of this File
Sets version of the Views of this File
Restores this File from the trashcan
Updates filename, filetype and source file of this File

Inherited from

Versionable