Interface RemoteFile

The file type used to denote files (or folders) on a portal.

Hierarchy

Properties

duration? filePath fileSize? isDirectory?

Properties

Optional duration

duration?: number

If it is a video file indicates the duration of the video. If present

filePath

filePath: string

The path to the file relative to the root of the portal we are downloading from where path separators are always unix style ('/').

Example

If the absolute path of the file is /path/to/portal/path/to/file.txt and the path to the portal root
on disk is /path/to/portal than the relativeFilePath === /path/to/file.txt

Optional fileSize

fileSize?: number

The size of the file in bytes.

Optional isDirectory

isDirectory?: boolean

Whether this file is a folder type, defaults to false.

Settings

Theme

Generated using TypeDoc