Class CordovaFileEntryApi

Represents a single file entry from the cordova file plugin system.

Hierarchy

CordovaFileEntryApi

Implements

FileEntryLike

Index

Constructors

constructor

Properties

Accessors

baseCordovaDirectoryName

Methods

Constructors

constructor

new CordovaFileEntryApi(cordovaFile: CordovaFilePluginLike, baseCordovaDirectoryNameDelegate: () => string, directoryName: string, fileName: string): CordovaFileEntryApi

- Defined in cordova/cordova-file-entry-api.ts:20
Parameters
- cordovaFile: CordovaFilePluginLike
- baseCordovaDirectoryNameDelegate: () => string
  - - (): string
    - Returns string
- directoryName: string
- fileName: string
Returns CordovaFileEntryApi

Properties

Protected Readonly baseCordovaDirectoryNameDelegate

baseCordovaDirectoryNameDelegate: () => string

Type declaration

- (): string
- Returns string

Protected Readonly cordovaFile

cordovaFile: CordovaFilePluginLike

Protected Readonly directoryName

directoryName: string

Protected Readonly fileName

fileName: string

Protected targetBaseDirectory

targetBaseDirectory: null | RFSCordovaDirectoryEntryLike = null

Protected targetDirectory

targetDirectory: null | RFSCordovaDirectoryEntryLike = null

Protected targetFile

targetFile: null | RFSCordovaFileEntryLike = null

Protected targetFileMetadata

targetFileMetadata: null | RFSCordovaFileEntryMetadataLike = null

Accessors

baseCordovaDirectoryName

get baseCordovaDirectoryName(): string

- Defined in cordova/cordova-file-entry-api.ts:55
Returns string

Methods

getDirectoryName

getDirectoryName(): string

Implementation of FileEntryLike.getDirectoryName
- Defined in cordova/cordova-file-entry-api.ts:63
Get the directory name for this entry

Returns string

getFileName

getFileName(): string

Implementation of FileEntryLike.getFileName
- Defined in cordova/cordova-file-entry-api.ts:59
Get the file name for this entry

Returns string

getLastModificationTime

getLastModificationTime(): number

Implementation of FileEntryLike.getLastModificationTime
- Defined in cordova/cordova-file-entry-api.ts:75
The last time this entry was edited. This is used to determine which files are the oldest when a rotation happens and all files are full.

Returns number

getSize

getSize(): number

Implementation of FileEntryLike.getSize
- Defined in cordova/cordova-file-entry-api.ts:71
The current size in bytes of this entry. Used to determine if the stream needs to rotate to a new entry.

Returns number

read

read(): Promise<ArrayBuffer>

Implementation of FileEntryLike.read
- Defined in cordova/cordova-file-entry-api.ts:84
Option to read the entire entry contents from disk. Not actively used in the process, but a nice-to-have when interfacing with entries.

Returns Promise<ArrayBuffer>

refresh

refresh(): Promise<void>

Implementation of FileEntryLike.refresh
- Defined in cordova/cordova-file-entry-api.ts:89
Called when the entry should refresh its metadata, including size and last modification time.

Returns Promise<void>

toURL

toURL(): string

Implementation of FileEntryLike.toURL
- Defined in cordova/cordova-file-entry-api.ts:67
Absolute path to the entry, typically a native file system URI.

Returns string

write

write(data: ArrayBuffer, overwrite: boolean): Promise<void>

Implementation of FileEntryLike.write
- Defined in cordova/cordova-file-entry-api.ts:79
Called when the entry is being overwritten or appened to.

Parameters
- data: ArrayBuffer
- overwrite: boolean
Returns Promise<void>

Static createCacheRotationFiles

createCacheRotationFiles(cordovaFile: CordovaFilePluginLike, directory: string, filenames: string[]): CordovaFileEntryApi[]

- Defined in cordova/cordova-file-entry-api.ts:28
Parameters
- cordovaFile: CordovaFilePluginLike
- directory: string
- filenames: string[]
Returns CordovaFileEntryApi[]

Static createRotationFiles

createRotationFiles(cordovaFile: CordovaFilePluginLike, baseDirectoryDelegate: () => string, directory: string, filenames: string[]): CordovaFileEntryApi[]

- Defined in cordova/cordova-file-entry-api.ts:41
Parameters
- cordovaFile: CordovaFilePluginLike
- baseDirectoryDelegate: () => string
  - - (): string
    - Returns string
- directory: string
- filenames: string[]
Returns CordovaFileEntryApi[]

Generated using TypeDoc