Hierarchy

  • NativeMobileComponent<any, IFile>
    • File

Implements

Properties

_nativeObject: any

Accessors

  • get nativeObject(): any
  • Returns any

  • set nativeObject(value: any): void
  • Parameters

    • value: any

    Returns void

  • get ios(): TProps["ios"]
  • Returns TProps["ios"]

  • get android(): TProps["android"]
  • Returns TProps["android"]

  • get name(): string
  • Gets the name of the file or directory.

    Android

    Ios

    Since

    0.1

    Returns string

  • set name(value: string): void
  • Gets the name of the file or directory.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: string

    Returns void

  • get fullPath(): string
  • Returns string

  • set fullPath(value: string): void
  • Parameters

    • value: string

    Returns void

  • get creationDate(): number
  • Gets creation date of the File instance. If the file doesn't exist returns -1.

    Android

    Ios

    Since

    0.1

    Returns number

  • set creationDate(value: number): void
  • Gets creation date of the File instance. If the file doesn't exist returns -1.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: number

    Returns void

  • get exists(): boolean
  • Check whether file or directory exists in given path.

    Android

    Ios

    Since

    0.1

    Returns boolean

  • set exists(value: boolean): void
  • Check whether file or directory exists in given path.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: boolean

    Returns void

  • get extension(): string
  • Gets the extension of the file.

    Android

    Ios

    Since

    0.1

    Returns string

  • set extension(value: string): void
  • Gets the extension of the file.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: string

    Returns void

  • get isDirectory(): boolean
  • Check whether the File instance is a directory.

    Android

    Ios

    Since

    0.1

    Returns boolean

  • set isDirectory(value: boolean): void
  • Check whether the File instance is a directory.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: boolean

    Returns void

  • get isFile(): boolean
  • Check whether the File instance is a file.

    Android

    Ios

    Since

    0.1

    Returns boolean

  • set isFile(value: boolean): void
  • Check whether the File instance is a file.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: boolean

    Returns void

  • get modifiedDate(): number
  • Gets last modified time of the File. It measured in milliseconds. If file doesn't exists returns -1.

    Android

    Ios

    Since

    0.1

    Returns number

  • set modifiedDate(value: number): void
  • Gets last modified time of the File. It measured in milliseconds. If file doesn't exists returns -1.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: number

    Returns void

  • get parent(): null | IFile
  • Gets the parent directory of the file or directory. If the file or parent of the file doesn't exist returns null.

    Android

    Ios

    Since

    0.1

    Returns null | IFile

  • set parent(value: null | IFile): void
  • Gets the parent directory of the file or directory. If the file or parent of the file doesn't exist returns null.

    Android

    Ios

    Since

    0.1

    Parameters

    Returns void

  • get path(): string
  • Gets the path given on constructor. This property required for creating the File instance.

    Android

    Ios

    Since

    0.1

    Returns string

  • set path(value: string): void
  • Gets the path given on constructor. This property required for creating the File instance.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: string

    Returns void

  • get size(): number
  • Gets the size of the file or directory. If file or directory doesn't exists returns -1.

    Android

    Ios

    Since

    0.1

    Returns number

  • set size(value: number): void
  • Gets the size of the file or directory. If file or directory doesn't exists returns -1.

    Android

    Ios

    Since

    0.1

    Parameters

    • value: number

    Returns void

  • get writable(): boolean
  • Rename the current file or directory to given name.

    Param

    Returns

    Method

    rename

    Android

    Ios

    Since

    0.1

    Returns boolean

Methods

  • Parameters

    • Optional params: Partial<Record<string, any>>

    Returns void

  • Parameters

    • props: Partial<{}>

    Returns void

  • Parameters

    Returns void

  • Ios

    Android

    Returns string

  • Copy file or directory to given path.

    Android

    Ios

    Since

    0.1

    Parameters

    • destination: string

    Returns boolean

  • Creates the file named by this pathname.

    Returns

    Method

    createFile

    Android

    Ios

    Since

    0.1

    Parameters

    • createParents: boolean

    Returns boolean

  • Creates the directory named by this pathname.

    Returns

    Method

    createDirectory

    Android

    Ios

    Since

    0.1

    Parameters

    • createParents: any

    Returns boolean

  • Deletes the file or directory.

    Returns

    Method

    remove

    Android

    Ios

    Since

    0.1

    Parameters

    • withChilds: boolean

    Returns boolean

  • Returns the list of file and directories that exist in this director. If directory not exists or path is not refer a directory returns null.

    Returns

    Method

    getFiles

    Android

    Ios

    Since

    0.1

    Returns null | IFile[]

  • Move the current file or directory to destination path.

    Returns

    Method

    move

    Android

    Ios

    Since

    0.1

    Parameters

    • destination: string

    Returns boolean

  • Open a IO.FileStream object from this object. If path is refer a directory returns null.

    Returns

    Method

    openStream

    Android

    Ios

    Since

    0.1

    Parameters

    Returns undefined | FileStreamImpl

  • Parameters

    • newName: string

    Returns boolean

  • Returns any

  • Returns any

  • Returns any

Constructors

  • Parameters

    Returns File

Generated using TypeDoc