Interface IDrive

The interface for a network drive that can be mounted in the contents manager.

interface IDrive {
    fileChanged: ISignal<IDrive, Contents.IChangedArgs>;
    isDisposed: boolean;
    name: string;
    serverSettings: ServerConnection.ISettings;
    sharedModelFactory?: ISharedFactory;
    copy(localPath, toLocalDir): Promise<Contents.IModel>;
    createCheckpoint(localPath): Promise<ICheckpointModel>;
    delete(localPath): Promise<void>;
    deleteCheckpoint(localPath, checkpointID): Promise<void>;
    dispose(): void;
    get(localPath, options?): Promise<Contents.IModel>;
    getDownloadUrl(localPath): Promise<string>;
    listCheckpoints(localPath): Promise<ICheckpointModel[]>;
    newUntitled(options?): Promise<Contents.IModel>;
    rename(oldLocalPath, newLocalPath): Promise<Contents.IModel>;
    restoreCheckpoint(localPath, checkpointID): Promise<void>;
    save(localPath, options?): Promise<Contents.IModel>;
}

Hierarchy

IDisposable
- IDrive

Implemented by

Drive

Index

Properties

fileChanged isDisposed name serverSettings sharedModelFactory?

Methods

copy createCheckpoint delete deleteCheckpoint dispose get getDownloadUrl listCheckpoints newUntitled rename restoreCheckpoint save

Properties

fileChanged

fileChanged: ISignal<IDrive, 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` name

name: string

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

`Readonly` serverSettings

serverSettings: ServerConnection.ISettings

The server settings of the manager.

`Optional` `Readonly` sharedModelFactory

sharedModelFactory?: ISharedFactory

An optional shared model factory instance for the drive.

Methods

copy

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

createCheckpoint

createCheckpoint(localPath): Promise<ICheckpointModel>
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.
- Defined in packages/services/src/contents/index.ts:587

delete

delete(localPath): Promise<void>
Delete a file.
Parameters
- localPath: 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:541

deleteCheckpoint

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

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

get

get(localPath, options?): Promise<Contents.IModel>
Get a file or directory.
Parameters
- localPath: 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:511

getDownloadUrl

getDownloadUrl(localPath): Promise<string>
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.
- Defined in packages/services/src/contents/index.ts:522

listCheckpoints

listCheckpoints(localPath): Promise<ICheckpointModel[]>
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.
- Defined in packages/services/src/contents/index.ts:597

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:532

rename

rename(oldLocalPath, newLocalPath): Promise<Contents.IModel>
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.
- Defined in packages/services/src/contents/index.ts:553

restoreCheckpoint

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

save

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

Interface IDrive

Hierarchy

Implemented by

Index

Properties

Methods

Properties

fileChanged

Readonly isDisposed

Notes

Readonly name

Readonly serverSettings

Optional Readonly sharedModelFactory

Methods

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

get

Parameters

Returns Promise<Contents.IModel>

getDownloadUrl

Parameters

Returns Promise<string>

Notes

listCheckpoints

Parameters

Returns Promise<ICheckpointModel[]>

newUntitled

Parameters

Returns Promise<Contents.IModel>

rename

Parameters

Returns Promise<Contents.IModel>

restoreCheckpoint

Parameters

Returns Promise<void>

save

Parameters

Returns Promise<Contents.IModel>

Settings

Member Visibility

Theme

On This Page

`Readonly` isDisposed

`Readonly` name

`Readonly` serverSettings

`Optional` `Readonly` sharedModelFactory