Hierarchy

  • INativeMobileComponent<any, MobileOSProps<FileiOSProps, {}>>
    • IFile

Implemented by

Properties

nativeObject: any
ios: Partial<FileiOSProps>
android: Partial<{}>
creationDate: number

Gets creation date of the File instance. If the file doesn't exist returns -1.

Android

Ios

Since

0.1

exists: boolean

Check whether file or directory exists in given path.

Android

Ios

Since

0.1

extension: string

Gets the extension of the file.

Android

Ios

Since

0.1

isDirectory: boolean

Check whether the File instance is a directory.

Android

Ios

Since

0.1

isFile: boolean

Check whether the File instance is a file.

Android

Ios

Since

0.1

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

name: string

Gets the name of the file or directory.

Android

Ios

Since

0.1

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

path: string

Gets the path given on constructor. This property required for creating the File instance.

Android

Ios

Since

0.1

size: number

Gets the size of the file or directory. If file or directory doesn't exists returns -1.

Android

Ios

Since

0.1

writable: boolean

Rename the current file or directory to given name.

Param

Returns

Method

rename

Android

Ios

Since

0.1

fullPath: string

Methods

  • 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

    • Optional 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

    • Optional 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

Generated using TypeDoc