Create new instance.
Reads the contents of the file at the path as a string. Returns undefined
value if the file does not exist or could not be read. Paths should begin with a /
and be relative to the root directory of your Box.com account.
Write the contents of the file at the path. Returns true if successful, false if the file could not be written successfully. This will override existing files!
Paths should begin with a /
and be relative to the root directory of your Box
Text to place in the file.
If false, an existing file will not be overwritten.
Creates a new Box object. Identifier is a optional string value used to identify a Box.com account. Typically this can be omitted if you only work with one Box.com account in Drafts.
Generated using TypeDoc
Box
Box objects can be used to work with files in a Box.com account.
Examples
// create Box object var drive = Box.create(); // setup variables var path = "/test/file.txt"; var content = "text to place in file"; // write to file on Box var success = drive.write(path, content, false); if (success) { // write worked! var driveContent = drive.read(path); if (driveContent) { // read worked! if (driveContent == content) { alert("File contents match!"); } else { console.log("File did not match"); context.fail(); } } else { // read failed, log error console.log(drive.lastError); context.fail(); } } else { // write failed, log error console.log(drive.lastError); context.fail(); }