Class ContentsManager

constructor

• new ContentsManager(options?: ContentsManager.IOptions): ContentsManager

• Construct a new contents manager object.

  Parameters

  • options: ContentsManager.IOptions = {}

    The options used to initialize the object.

  Returns ContentsManager

ReadonlyserverSettings

defaultDrive

• get defaultDrive(): IDrive

• The default drive associated with the manager.

  Returns IDrive

fileChanged

• get fileChanged(): ISignal<this, Contents.IChangedArgs>

• A signal emitted when a file operation takes place.

  Returns ISignal<this, Contents.IChangedArgs>

isDisposed

• get isDisposed(): boolean

• Test whether the manager has been disposed.

  Returns boolean

addDrive

• addDrive(drive: IDrive): void

• Add an IDrive to the manager.

  Parameters

  • drive: IDrive

  Returns void

copy

• copy(fromFile: string, toDir: string): Promise<Contents.IModel>

• Copy a file into a given directory.

  Parameters

  • fromFile: string
  • toDir: string

    The destination directory path.

  Returns Promise<Contents.IModel>

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

  Notes

  The server will select the name of the copied file.

createCheckpoint

• createCheckpoint(path: string): Promise<ICheckpointModel>

• 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

• delete(path: string): Promise<void>

• Delete a file.

  Parameters

  • path: string

    The path to the file.

  Returns Promise<void>

  A promise which resolves when the file is deleted.

deleteCheckpoint

• deleteCheckpoint(path: string, checkpointID: string): Promise<void>

• 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

• dispose(): void

• Dispose of the resources held by the manager.

  Returns void

driveName

• driveName(path: string): string

• 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

    the path.

  Returns string

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

get

• get(path: string, options?: IFetchOptions): Promise<Contents.IModel>

• Get a file or directory.

  Parameters

  • path: string

    The path to the file.
  • Optionaloptions: IFetchOptions

    The options used to fetch the file.

  Returns Promise<Contents.IModel>

  A promise which resolves with the file content.

getDownloadUrl

• getDownloadUrl(path: string): Promise<string>

• Get an encoded download url given a file path.

  Parameters

  • path: string

    An absolute POSIX file path on the server.

    Notes

    It is expected that the path contains no relative paths.

    The returned URL may include a query parameter.

  Returns Promise<string>

getSharedModelFactory

• getSharedModelFactory(
      path: string,
      options?: IContentProvisionOptions,
  ): null | ISharedFactory

• Given a path, get a shared model factory from the relevant backend. The factory defined on content provider best matching the given path takes precedence over the factory defined on the drive as a whole. Returns null if the backend does not provide one.

  Parameters

  • path: string
  • Optionaloptions: IContentProvisionOptions

  Returns null | ISharedFactory

listCheckpoints

• listCheckpoints(path: string): Promise<ICheckpointModel[]>

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

localPath

• localPath(path: string): string

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

  Parameters

  • path: string

    the path.

  Returns string

  The local part of the path.

newUntitled

• newUntitled(options?: Contents.ICreateOptions): Promise<Contents.IModel>

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

  Parameters

  • options: Contents.ICreateOptions = {}

    The options used to create the file.

  Returns Promise<Contents.IModel>

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

normalize

• normalize(path: string): string

• 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

    the path.

  Returns string

  The normalized path.

rename

• rename(path: string, newPath: string): Promise<Contents.IModel>

• 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 contents model when the file is renamed.

resolvePath

• resolvePath(root: string, path: string): string

• 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

    the path.

  Returns string

  The normalized path.

restoreCheckpoint

• restoreCheckpoint(path: string, checkpointID: string): Promise<void>

• 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

• save(path: string, options?: Partial<Contents.IModel>): Promise<Contents.IModel>

• Save a file.

  Parameters

  • path: string

    The desired file path.
  • 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.

  Notes

  Ensure that model.content is populated for the file.