Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FolderJob

Hierarchy

  • Job
    • FolderJob

Index

Constructors

constructor

Properties

Protected basename

basename: string

Protected dirname

dirname: string

Protected e

Protected files

files: File[]

Protected id

id: string

Protected lifeCycle

lifeCycle: LifeEvent[]

Protected locallyAvailable

locallyAvailable: boolean

Protected name

name: string

Protected nest

nest: Nest

Protected path

path: string

Protected tunnel

tunnel: Tunnel

Methods

addFile

  • addFile(file: File): void

count

  • count(): number

createFiles

  • createFiles(callback: any): void
  • Creates file objects for folder contents. Async operation returns a callback on completion.

    Parameters

    • callback: any

    Returns void

Protected createLifeEvent

  • createLifeEvent(verb: string, start: string, finish: string): void

email

fail

  • fail(reason: string): void
  • Function to call to fail a job while in a tunnel.

    Parameters

    • reason: string

    Returns void

getBasename

  • getBasename(): string

getDirname

  • getDirname(): string

getExtension

  • getExtension(): any

getFile

  • getFile(index: number): File

getFiles

  • getFiles(): Array<File>

getId

  • getId(): string

getLifeCycle

getName

  • getName(): string

getNameProper

  • getNameProper(): string

getNest

getPath

  • getPath(): string

Protected getStatistics

  • getStatistics(): void

getTunnel

isFile

  • isFile(): boolean

isFolder

  • isFolder(): boolean

isLocallyAvailable

  • isLocallyAvailable(): boolean

move

  • move(destinationNest: any, callback: any): void
  • Moves a folder to a nest. This is an asynchronous method which provides a callback on completion.

    Parameters

    • destinationNest: any
    • callback: any

    Returns void

rename

  • rename(newName: string): void
  • Renames the job folder, leaving its content's names alone.

    Parameters

    • newName: string

    Returns void

setLocallyAvailable

  • setLocallyAvailable(available: boolean): void

setName

  • setName(name: string): void

setNest

  • setNest(nest: Nest): void

setPath

  • setPath(path: string): void

setTunnel

  • setTunnel(tunnel: Tunnel): void

toString

  • toString(): string

transfer

  • transfer(tunnel: Tunnel): void

Generated using TypeDoc