Class DownloadFolderCommand

Command to download the contents of a folder from nextcloud to local file system recursively

Hierarchy

Command
- DownloadFolderCommand

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DownloadFolderCommand(client: Client, options: DownloadFolderCommandOptions): DownloadFolderCommand

Overrides Command.constructor
- Defined in src/command/downloadFolderCommand.ts:42
Parameters
- client: Client
  
  the client
- options: DownloadFolderCommandOptions
  
  constructor options
Returns DownloadFolderCommand

Properties

Protected client

client: Client

Protected percentCompleted

percentCompleted: number

Protected resultMetaData

resultMetaData: CommandResultMetaData

Protected status

status: CommandStatus

Methods

execute

execute(): Promise<void>

Inherited from Command.execute
- Defined in src/command/command.ts:67
final execute the command

async

final

Returns Promise<void>

getBytesDownloaded

getBytesDownloaded(): number

- Defined in src/command/downloadFolderCommand.ts:112
Returns number

getPercentCompleted

getPercentCompleted(): number

Inherited from Command.getPercentCompleted
- Defined in src/command/command.ts:110
returns the completion percentage of the command

Returns number

percentage of completion

getResultMetaData

getResultMetaData(): CommandResultMetaData

Inherited from Command.getResultMetaData
- Defined in src/command/command.ts:118
returns the result meta data of the command

Returns CommandResultMetaData

the result of the command

getStatus

getStatus(): CommandStatus

Inherited from Command.getStatus
- Defined in src/command/command.ts:102
returns the status of the command

Returns CommandStatus

isFinished

isFinished(): boolean

Inherited from Command.isFinished
- Defined in src/command/command.ts:91
returns true, if the command has been finished

Returns boolean

Protected onExecute

onExecute(): Promise<void>

Overrides Command.onExecute
- Defined in src/command/downloadFolderCommand.ts:61
execute the command

async

Returns Promise<void>

Generated using TypeDoc