Class FilestreamAbstract

Hierarchy

  • default
    • Filestream

Implements

Properties

_nativeObject mode contentMode isReadable isWritable name path offset seekToEnd? StreamType ContentMode

Accessors

nativeObject

Methods

preConstruct readToEnd close readBlob write create createNativeObject

Constructors

constructor

Properties

Protected _nativeObject

_nativeObject: any

mode

mode: FileStreamType

Gets the mode of FileStream operation.

Android

Ios

Since

0.1

contentMode

contentMode: FileContentMode

Gets the content mode of FileStream operation.

Android

Ios

Since

0.1

isReadable

isReadable: boolean

Checks whether the stream is readable.

Android

Ios

Since

0.1

isWritable

isWritable: boolean

Checks whether the stream is writable.

Android

Ios

Since

0.1

name

name: string

Gets the name of the file it belongs to.

Android

Ios

Since

0.1

path

path: string

Gets the path of the file it belongs to.

Android

Ios

Since

0.1

offset

offset: number

iOS only property. Gets the offset of the file stream set as padding.

Ios

Optional seekToEnd

seekToEnd?: (() => void)

Type declaration

    • (): void

    • Returns void

Static StreamType

StreamType: typeof FileStreamType = FileStreamType

Static ContentMode

ContentMode: typeof FileContentMode = FileContentMode

Accessors

nativeObject

  • get nativeObject(): any

  • Returns any

  • set nativeObject(value: any): void

  • Parameters

    • value: any

    Returns void

Methods

Protected preConstruct

  • Executed before constuctor and after createNativeObject. Use this when you have default values which needs to be set before constructor.

    Parameters

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

    Returns void

Abstract readToEnd

  • Gets all characters or blob content from the file stream depending of IO.FileStream#ContentMode contentMode content mode. If FileStream not opened with IO.FileStream.StreamType#READ mode, returns null.

    Android

    Ios

    Since

    0.1

    Type Parameters

    Returns ContentType

Abstract close

  • Closes the FileStream instance. FileStream have to be closed when its job is done.

    Android

    Ios

    Since

    0.1

    Returns void

Abstract readBlob

  • Gets the Blob object from FileStream.

    Android

    Ios

    Deprecated

    since 1.1.10, you may use FileStream.readToEnd() function after you change contentMode of FileStream to FileStream.ContentMode.BINARY.

    Returns IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>

Abstract write

  • Writes all characters or blob content into the file stream depending of IO.FileStream#ContentMode contentMode content mode. If the file stream opened with IO.FileStream.StreamType#READ, returns false.

    Android

    Ios

    Since

    0.1

    Parameters

    Returns boolean

Static create

  • Parameters

    • path: any
    • streamMode: any
    • contentMode: number

    Returns undefined | Filestream

Protected createNativeObject

  • Returns void

Constructors

constructor

Settings

Member Visibility

Theme

Generated using TypeDoc