The interface for a network drive that can be mounted in the 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.

name: string

The name of the drive, which is used at the leading component of file paths.

serverSettings: ServerConnection.ISettings

The server settings of the manager.

sharedModelFactory?: ISharedFactory

An optional shared model factory instance for the drive.

Methods

  • Copy a file into a given directory.

    Parameters

    • localPath: string

      The original file path.

    • toLocalDir: 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

    • localPath: 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

    • localPath: 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

    • localPath: 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

  • Get an encoded download url given a file path.

    Parameters

    • localPath: string

    Returns Promise<string>

    A promise which resolves with the absolute POSIX file path on the server.

    Notes

    The returned URL may include a query parameter.

  • List available checkpoints for a file.

    Parameters

    • localPath: string

      The path of the file.

    Returns Promise<ICheckpointModel[]>

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

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

  • Rename a file or directory.

    Parameters

    • oldLocalPath: string

      The original file path.

    • newLocalPath: string

      The new file path.

    Returns Promise<Contents.IModel>

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

  • Restore a file to a known checkpoint state.

    Parameters

    • localPath: 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

    • localPath: 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