Interface IManager

The interface for a contents manager.

interface IManager {
    fileChanged: ISignal<Contents.IManager, Contents.IChangedArgs>;
    isDisposed: boolean;
    serverSettings: ServerConnection.ISettings;
    addDrive(drive): void;
    copy(path, toDir): Promise<Contents.IModel>;
    createCheckpoint(path): Promise<ICheckpointModel>;
    delete(path): Promise<void>;
    deleteCheckpoint(path, checkpointID): Promise<void>;
    dispose(): void;
    driveName(path): string;
    get(path, options?): Promise<Contents.IModel>;
    getDownloadUrl(path): Promise<string>;
    getSharedModelFactory(path): null | ISharedFactory;
    listCheckpoints(path): Promise<ICheckpointModel[]>;
    localPath(path): string;
    newUntitled(options?): Promise<Contents.IModel>;
    normalize(path): string;
    rename(path, newPath): Promise<Contents.IModel>;
    resolvePath(root, path): string;
    restoreCheckpoint(path, checkpointID): Promise<void>;
    save(path, options?): Promise<Contents.IModel>;
}

Hierarchy

IDisposable
- IManager

Implemented by

ContentsManager

Properties

`Readonly` fileChanged

fileChanged: ISignal<Contents.IManager, Contents.IChangedArgs>

A signal emitted when a file operation takes place.

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly` serverSettings

serverSettings: ServerConnection.ISettings

The server settings associated with the manager.

Methods

addDrive

addDrive(drive): void
Add an IDrive to the manager.
Parameters
- drive: IDrive
Returns void
- Defined in packages/services/src/contents/index.ts:301

copy

copy(path, toDir): Promise<Contents.IModel>
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.
- Defined in packages/services/src/contents/index.ts:430

createCheckpoint

createCheckpoint(path): 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.
- Defined in packages/services/src/contents/index.ts:440

delete

delete(path): 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.
- Defined in packages/services/src/contents/index.ts:394

deleteCheckpoint

deleteCheckpoint(path, checkpointID): 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.
- Defined in packages/services/src/contents/index.ts:472

dispose

dispose(): void
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
Inherited from IDisposable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

driveName

driveName(path): 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.
- Defined in packages/services/src/contents/index.ts:346

get

get(path, options?): Promise<Contents.IModel>
Get a file or directory.
Parameters
- path: string
  The path to the file.
- Optional options: IFetchOptions
  The options used to fetch the file.
Returns Promise<Contents.IModel>
A promise which resolves with the file content.
- Defined in packages/services/src/contents/index.ts:364

getDownloadUrl

getDownloadUrl(path): Promise<string>
Get an encoded download url given a file path.
Parameters
- path: string
Returns Promise<string>
- Defined in packages/services/src/contents/index.ts:375

getSharedModelFactory

getSharedModelFactory(path): null | ISharedFactory
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 null | ISharedFactory
- Defined in packages/services/src/contents/index.ts:353

listCheckpoints

listCheckpoints(path): 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.
- Defined in packages/services/src/contents/index.ts:450

localPath

localPath(path): 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.
- Defined in packages/services/src/contents/index.ts:311

newUntitled

newUntitled(options?): Promise<Contents.IModel>
Create a new untitled file or directory in the specified directory path.
Parameters
- Optional 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.
- Defined in packages/services/src/contents/index.ts:385

normalize

normalize(path): 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.
- Defined in packages/services/src/contents/index.ts:322

rename

rename(path, newPath): 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 content model when the file is renamed.
- Defined in packages/services/src/contents/index.ts:406

resolvePath

resolvePath(root, path): 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.
- Defined in packages/services/src/contents/index.ts:335

restoreCheckpoint

restoreCheckpoint(path, checkpointID): 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.
- Defined in packages/services/src/contents/index.ts:461

save

save(path, options?): Promise<Contents.IModel>
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.
- Defined in packages/services/src/contents/index.ts:418

Interface IManager

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly fileChanged

Readonly isDisposed

Notes

Readonly serverSettings

Methods

addDrive

Parameters

Returns void

copy

Parameters

Returns Promise<Contents.IModel>

createCheckpoint

Parameters

Returns Promise<ICheckpointModel>

delete

Parameters

Returns Promise<void>

deleteCheckpoint

Parameters

Returns Promise<void>

dispose

Notes

Undefined Behavior

Returns void

driveName

Parameters

Returns string

get

Parameters

Returns Promise<Contents.IModel>

getDownloadUrl

Parameters

Returns Promise<string>

getSharedModelFactory

Parameters

Returns null | ISharedFactory

listCheckpoints

Parameters

Returns Promise<ICheckpointModel[]>

localPath

Parameters

Returns string

newUntitled

Parameters

Returns Promise<Contents.IModel>

normalize

Parameters

Returns string

rename

Parameters

Returns Promise<Contents.IModel>

resolvePath

Parameters

Returns string

restoreCheckpoint

Parameters

Returns Promise<void>

save

Parameters

Returns Promise<Contents.IModel>

Settings

Member Visibility

Theme

On This Page

`Readonly` fileChanged

`Readonly` isDisposed

`Readonly` serverSettings