The interface for a contents manager.

Hierarchy

Implemented by

Properties

A signal emitted when a file operation takes place.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

serverSettings: ServerConnection.ISettings

The server settings associated with the manager.

Methods

  • Add an IDrive to the manager.

    Parameters

    Returns void

  • Copy a file into a given directory.

    Parameters

    • path: string

      The original file path.

    • toDir: string

      The destination directory path.

    Returns Promise<Contents.IModel>

    A promise which resolves with the new content model when the file is copied.

  • Create a checkpoint for a file.

    Parameters

    • path: string

      The path of the file.

    Returns Promise<ICheckpointModel>

    A promise which resolves with the new checkpoint model when the checkpoint is created.

  • Delete a file.

    Parameters

    • path: string

      The path to the file.

    Returns Promise<void>

    A promise which resolves when the file is deleted.

  • Delete a checkpoint for a file.

    Parameters

    • path: string

      The path of the file.

    • checkpointID: string

      The id of the checkpoint to delete.

    Returns Promise<void>

    A promise which resolves when the checkpoint is deleted.

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

  • Given a path of the form drive:local/portion/of/it.txt get the name of the drive. If the path is missing a drive portion, returns an empty string.

    Parameters

    • path: string

    Returns string

    The drive name for the path, or the empty string.

  • Get an encoded download url given a file path.

    Parameters

    • path: string

    Returns Promise<string>

  • Given a path, get a shared model IFactory from the relevant backend. Returns null if the backend does not provide one.

    Parameters

    • path: string

    Returns ISharedFactory

  • List available checkpoints for a file.

    Parameters

    • path: string

      The path of the file.

    Returns Promise<ICheckpointModel[]>

    A promise which resolves with a list of checkpoint models for the file.

  • Given a path of the form drive:local/portion/of/it.txt get the local part of it.

    Parameters

    • path: string

    Returns string

    The local part of the path.

  • Create a new untitled file or directory in the specified directory path.

    Parameters

    Returns Promise<Contents.IModel>

    A promise which resolves with the created file content when the file is created.

  • Normalize a global path. Reduces '..' and '.' parts, and removes leading slashes from the local part of the path, while retaining the drive name if it exists.

    Parameters

    • path: string

    Returns string

    The normalized path.

  • Rename a file or directory.

    Parameters

    • path: string

      The original file path.

    • newPath: string

      The new file path.

    Returns Promise<Contents.IModel>

    A promise which resolves with the new file content model when the file is renamed.

  • Resolve a global path, starting from the root path. Behaves like posix-path.resolve, with 3 differences:

    • will never prepend cwd
    • if root has a drive name, the result is prefixed with ":"
    • before adding drive name, leading slashes are removed

    Parameters

    • root: string
    • path: string

    Returns string

    The normalized path.

  • Restore a file to a known checkpoint state.

    Parameters

    • path: string

      The path of the file.

    • checkpointID: string

      The id of the checkpoint to restore.

    Returns Promise<void>

    A promise which resolves when the checkpoint is restored.

  • Save a file.

    Parameters

    • path: string

      The desired file path.

    • Optional options: Partial<Contents.IModel>

      Optional overrides to the model.

    Returns Promise<Contents.IModel>

    A promise which resolves with the file content model when the file is saved.

Generated using TypeDoc