Skip to main content

SSHFile

Dados de um ficheiro via SSH.


getName


getName() : string

Description

Returns the file name.

Return

( string )

The file name.


getParent


getParent() : string

Description

Returns parent name of the file.

Return

( string )

The parent name of the file.


getPath


getPath() : string

Description

Returns path of the file.

Return

( string )

Path of the file.


isDirectory


isDirectory() : boolean

Description

Returns whether it is a directory.

Return

( boolean )

Whether it is a directory or not.


isRegularFile


isRegularFile() : boolean

Description

Returns whether it is a regular file, that is, it is not a directory, symbolic link or any other type of special file.

Return

( boolean )

Whether it is a regular file or not.


setDirectory


setDirectory(directory: boolean) : void

Description

Defines whether it is a directory.

Attributes
NAMETYPEDESCRIPTION
directorybooleanWhether or not it is a directory.
Return

( void )


setName


setName(name: string) : void

Description

Defines the file name.

Attributes
NAMETYPEDESCRIPTION
namestringName to be defined.
Return

( void )


setParent


setParent(parentName: string) : void

Description

Defines the parent name of the file.

Attributes
NAMETYPEDESCRIPTION
parentNamestringParent name to be defined.
Return

( void )


setPath


setPath(path: string) : void

Description

Defines the path of the file.

Attributes
NAMETYPEDESCRIPTION
pathstringPath to be defined.
Return

( void )


setRegularFile


setRegularFile(directory: boolean) : void

Description

Defines whether it is a regular file, that is, it is not a directory, symbolic link or any other type of special file.

Attributes
NAMETYPEDESCRIPTION
directorybooleanWhether or not it is a regular file.
Return

( void )