Editor Scripting API
    Preparing search index...

    Class SecureLocalStorage

    Provides encrypted storage for each plugin module's sensitive data, like access tokens. It uses Keychain on macOS and Credentials Manager on Windows. The data can be stored and retrieved as string-to-string key value pairs via a global secureLocalStorage object. Data for each plugin module (module.json) is kept separate from all others. There is a 2KB limit on the string size because this is meant for small pieces of secure info rather than a generic container.

    secureLocalStorage.setItem('myLoginPassword', 'myPassword');
    console.log("My stored password is: " + secureLocalStorage.getItem('myLoginPassword'));
    secureLocalStorage.removeItem('myLoginPassword');
    console.log("My stored password is: " + secureLocalStorage.getItem('myLoginPassword'));

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    clear getItem getTypeName isOfType isSame length removeItem setItem

    Constructors

    Methods

    • Remove all values in the storage.

      Returns void

    • Get the value stored under keyName.

      Parameters

      • keyName: string

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Get the length of the storage.

      Returns number

    • Remove the stored value under keyName.

      Parameters

      • keyName: string

      Returns void

    • Sets the value stored under keyName.

      Parameters

      • keyName: string
      • keyValue: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods