Document Actions

• os.getLocalDocument(name: string): Promise<SharedDocument>

  Gets a shared document that is only stored locally on this device.

  The first parameter is a string and is the name of the document.

• os.getMemoryDocument(): Promise<SharedDocument>

  Gets a document that is not shared or saved to the device.

• os.getSharedDocument(name: string): Promise<SharedDocument>

  Gets a shared document record from this inst by its name.

  Shared documents are a way to share data across insts in a easy and secure manner.

  Returns a promise that resolves with the shared document.

  The first parameter is a string and is the name of the shared document.

  Examples

  Get a shared document from the current inst by name.

  const sharedDocument = await os.getSharedDocument('myDocument');

• os.getSharedDocument(recordName: string, inst: string, name: string): Promise<SharedDocument>

  Gets a shared document record from the given inst by its name.

  Shared documents are a way to share data across insts in a easy and secure manner.

  Returns a promise that resolves with the shared document.

  The first parameter is a string and is the name of the record. If null, then a public inst will be used.

  The second parameter is a string and is the name of the inst that the shared document is in.

  The third parameter is a string and