new nlobjFile() → {nlobjFile}
Return a new instance of nlobjFile used for accessing and manipulating files in the file cabinet.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2174
Returns:
- Type
- nlobjFile
Methods
-
getDescription() → {string}
-
return the file description.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2289
Returns:
- Type
- string
-
getFolder() → {int}
-
return the internal ID of the folder that this file is in.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2208
Returns:
- Type
- int
-
getId() → {int}
-
Return the id of the file (if stored in the FC).
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2312
Returns:
- Type
- int
-
getName() → {string}
-
Return the name of the file.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2185
Returns:
- Type
- string
-
getSize() → {int}
-
Return the size of the file in bytes.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2323
Returns:
- Type
- int
-
getType() → {string}
-
Return the type of the file.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2345
Returns:
- Type
- string
-
getURL() → {string}
-
Return the URL of the file (if stored in the FC).
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2334
Returns:
- Type
- string
-
getValue() → {string}
-
Return the value (base64 encoded for binary types) of the file.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2356
Returns:
- Type
- string
-
isInactive() → {boolean}
-
return true if the file is inactive.
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2266
Returns:
- Type
- boolean
-
isOnline() → {boolean}
-
return true if the file is "Available without Login".
- Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2243
Returns:
- Type
- boolean
-
setDescription(descr) → {void}
-
sets the file's description.
Parameters:
Name Type Description descr
string the file description - Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2301
Returns:
- Type
- void
-
setEncoding(encoding) → {void}
-
sets the character encoding for the file.
Parameters:
Name Type Description encoding
String - Since:
- 2010.2
- Source:
- nlapihandler_stubs.js, line 2232
Returns:
- Type
- void
-
setFolder(folder) → {void}
-
sets the internal ID of the folder that this file is in.
Parameters:
Name Type Description folder
int - Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2220
Returns:
- Type
- void
-
setIsInactive(inactive) → {void}
-
sets the file's inactive status.
Parameters:
Name Type Description inactive
boolean - Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2278
Returns:
- Type
- void
-
setIsOnline(online) → {void}
-
sets the file's "Available without Login" status.
Parameters:
Name Type Description online
boolean - Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2255
Returns:
- Type
- void
-
setName(name) → {void}
-
Sets the name of a file.
Parameters:
Name Type Description name
string the name of the file - Since:
- 2009.1
- Source:
- nlapihandler_stubs.js, line 2197
Returns:
- Type
- void