Files

Table of contents

• Global functions
  • file(name)
• File Object
  • close()
  • getLineNumber()
  • readAll()
  • readChar()
  • readLine()
  • readLines()
  • write(text)
  • writeLine(text)
  • appendMode()
• Examples

The File API enables reading and writing files on the device’s internal memory or SD card. All file operations are performed through the File object, which is obtained using the global file() function.

Scripts require read/write file permissions. In the Android app, you must select a folder that your script will have access to through the script permission dialog.

Global functions

file(name)

Creates or opens a file for read/write operations.

Parameters

Parameter	Type	Description
name	String	File name in the chosen accessible folder. For Desktop app, specify full file path.

Returns

Returns a File object for the specified file.

Example

let f = file("data.txt");
f.writeLine("Hello World");
f.close();
log("File created successfully");

File Object

Represents a file on the device’s storage system and provides methods for reading and writing operations.

Properties

Property	Type	Description
exists	Boolean	true if the file exists, false otherwise
length	Number	Size of the file in bytes. Returns 0 if file doesn’t exist

close()

Closes the file and saves any written content. The file must be closed after writing operations.

Example

let f = file("test.txt");
f.writeLine("Some content");
f.close();
log("File closed successfully");

getLineNumber()

Returns the current line position in the file.

Returns

Returns a number representing the current line position.

Example

let f = file("test.txt");
f.readLine();
log("Current line: " + f.getLineNumber());
f.close();

readAll()

Reads all lines from the file and automatically closes it.

Returns

Returns an array containing all lines from the file.

Example

let f = file("test.txt");
let lines = f.readAll();
log("File contents: " + lines.join(", "));

readChar()

Reads the next character from the file stream.

Returns

Returns a single character as a string.

Example

let f = file("test.txt");
let char = f.readChar();
log("First character: " + char);
f.close();

readLine()

Reads the next line from the file stream.

Returns

Returns a string containing the next line.

Example

let f = file("test.txt");
let line = f.readLine();
log("First line: " + line);
f.close();

readLines()

Reads all remaining lines from the current position.

Returns

Returns an array containing the remaining lines.

Example

let f = file("test.txt");
let lines = f.readLines();
log("Remaining lines: " + lines.join(", "));
f.close();

write(text)

Writes text to the file stream without adding a newline.

Parameters

Parameter	Type	Description
text	String	Content to write to the file

Example

let f = file("test.txt");
f.write("Hello ");
f.write("World");
f.close();
log("Content written successfully");

writeLine(text)

Writes text followed by a newline character.

Parameters

Parameter	Type	Description
text	String	Content to write to the file

Example

let f = file("test.txt");
f.writeLine("First line");
f.writeLine("Second line");
f.close();
log("Lines written successfully");

appendMode()

Switches the file to append mode, allowing new content to be added to the end.

Example

let f = file("log.txt");
f.appendMode();
f.writeLine("New log entry");
f.close();
log("Content appended successfully");

Examples

Writing and Reading a File

let f = file("myfile.txt");
f.writeLine("one");
f.writeLine("two");
f.writeLine("three");
f.close();

f = file("myfile.txt");
let lines = f.readLines();
log("File contents: " + lines.join(", "));
f.close();

Saving Entry Data as XML

let xml = '<record id="' + entry().field("id") + '">' +
          '<title>' + entry().field("title") + '</title>' +
          '<date>' + entry().field("date") + '</date>' +
          '</record>';

let f = file(entry().field("title") + ".xml");
f.write(xml);
f.close();
log("Entry saved as XML");