File.isInactive

Property Description

The inactive status of a file. If set to true, the file is inactive.

The default value is false.

When a file is inactive, it does not display in the UI unless you select Show Inactives on the File Cabinet page.

Type

boolean

Module

N/file Module

Since

2015.2

Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/file Module Script Samples.

          //Add additional code 
...
var fileObj = file.load({
    id: 'Images/myImageFile.jpg'
});
fileObj.name = 'myOldImageFile.jpg';
fileObj.isInactive = true;
var fileId = fileObj.save();
...
//Add additional code 

        

Related Topics

General Notices