File.isOnline

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The Available without Login status of a file. If set to true, users can download the file outside of a current NetSuite login session.

The default value is false.

Important:

This property holds the value of the Available without Login setting found on the file record. It does not reflect the value of the Available Without Login setting found on the Suitelet script deployment record.

The Available without Login setting is primarily used for SuiteCommerce websites. When this setting is enabled, websites can access media files in the NetSuite File Cabinet without a current NetSuite login session.

Type

boolean

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.isOnline = true;
var fileId = fileObj.save();
...
//Add additional code 

        

Related Topics

file.File
N/file Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices