ServerResponse Write File Method in SuiteScript

The writeFile method of the ServerResponse object in SuiteScript enables developers to write files to HTTP responses. This is useful when building Suitelets or server-side scripts that need to output files for download or inline display to users.

Method Overview

• Method Description: Writes a file to the response without returning any value.
• Supported Script Types: This method is compatible with server scripts.
• Governance: There are no governance limits associated with this method.

Parameters

The method accepts an options parameter, which is a JavaScript object comprising the following key properties:

Note: The options.file parameter must be specified as a file.File object, which you can create using the file module.

Error Handling

Several error codes may be thrown by the writeFile method:

• SSS_MISSING_REQD_ARGUMENT: Thrown if the required options.file parameter is missing.
• WRONG_PARAMETER_TYPE: Raised when the provided options.file is not a valid file.File object.

Usage Example

Here’s a basic example of how to use the writeFile method within a SuiteScript:

1// Sample code to write a file response
2var serverResponse; // Assume this is your instance of ServerResponse
3var myFileObj = file.load({ id: '12345' }); // Load your file object
4 
5serverResponse.writeFile({
6    file: myFileObj,
7    isInline: true
8});

This code demonstrates how to load a file and then write it to the response, which can be utilized in scenarios like file downloads or displaying files directly in a browser window.

Related Topics

• http.ServerResponse
• N/http Module
• SuiteScript 2.x Modules

Key Takeaways

• The writeFile method handles file outputs in server scripts, allowing dynamic file downloads.
• It's vital to ensure the file is loaded as a file.File object before using it.
• Error handling is important to manage required parameters and data types effectively.