OneDrive | Drafts Script Reference
Drafts Script Reference
    Preparing search index...

    Class OneDrive

    OneDrive objects can be used to work with files in a OneDrive account.

    // create OneDrive object
    let drive = OneDrive.create();

    // setup variables
    let path = "/test/file.txt";
    let content = "text to place in file";

    // write to file on OneDrive
    let 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();
    }

    Constructors

    • Create new instance.

      Parameters

      • Optionalidentifier: string

      Returns OneDrive

    Properties

    lastError: string | undefined

    If a function fails, this property will contain the last error as a string message, otherwise it will be undefined.

    Methods

    • 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 OneDrive.

      Parameters

      • path: string

      Returns string

    • 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!

      Parameters

      • path: string

        Paths should begin with a / and be relative to the root directory of your OneDrive

      • content: string

        Text to place in the file

      • Optionaloverwrite: boolean

        If false, an existing file will not be overwritten

      Returns boolean

    • Parameters

      • Optionalidentifier: string

        Optional identifier for OneDrive account to use. This string is an arbitrary value, but we recommend using the email address you wish to associate with the script. Each unique identifier will be associated with its own Credential.

      Returns OneDrive

    Constructors
    Properties
    Methods