File.description

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The description of a file. In the UI, the value of description displays in the Description field on the file record.

Type

string

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

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.description = 'my test file';
var fileId = fileObj.save();
...
//Add additional code

Syntax

Related Topics