ServerResponse.writeFile(options)
Method Description |
Writes a file to the response. Textual files are re-encoded to UTF-8 by default. If you want to preserve the file's encoding, you must specify the same charset in the response's Content-Type header using ServerResponse.setHeader(options) before calling this method. To see an example, refer to Return a File with Alternative Character Encoding. |
Returns |
void |
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Since |
2015.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
Since |
---|---|---|---|---|
|
required |
A file.File Object that encapsulates the file to be written. |
2015.2 |
|
|
boolean |
optional |
Determines whether the field is inline. If true, the file is inline. |
2015.2 |
Errors
Error Code |
Message |
Thrown If |
---|---|---|
|
Missing a required argument: {param name} |
The |
|
{param name} |
The value input for |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/https Module Script Samples.
// Add additional code
...
serverResponse.writeFile({
file: myFileObj,
isInline: true
});
...
// Add additional code