data class CameraOptions(val quality: Int? = null, val destinationType: Camera.DestinationType? = null, val sourceType: Camera.PictureSourceType? = null, val allowEdit: Boolean? = null, val encodingType: Camera.EncodingType? = null, val targetWidth: Int? = null, val targetHeight: Int? = null, val mediaType: Camera.MediaType? = null, val correctOrientation: Boolean? = null, val saveToPhotoAlbum: Boolean? = null, val popoverOptions: Camera.CameraPopoverOptions? = null, val cameraDirection: Camera.Direction? = null)

Camera options.

CaptureException

class CaptureException(code: MediaCapture.CaptureErrorCode)

Exception class for media capture errors.

Coordinates

external class Coordinates

Geolocation coordinates values.

CordovaEvent

enum CordovaEvent : Enum<CordovaEvent>

Cordova event types.

Device

external class Device

Device information class.

DirectoryEntry

external interface DirectoryEntry : Entry

DirectoryEntryCallback

external interface DirectoryEntryCallback

DirectoryEntrySync

external interface DirectoryEntrySync : EntrySync

DirectoryReader

external interface DirectoryReader

DirectoryReaderSync

external interface DirectoryReaderSync

EntriesCallback

external interface EntriesCallback

Entry

external interface Entry

EntryCallback

external interface EntryCallback

EntrySync

external interface EntrySync

ErrorCallback

external interface ErrorCallback

File

object File

Main object for Cordova file.

FileCallback

external interface FileCallback

FileEntry

external interface FileEntry : Entry

FileEntryCallback

external interface FileEntryCallback

FileEntrySync

external interface FileEntrySync : EntrySync

FileException

class FileException(code: Int)

Exception class for file errors.

FileSaver

external interface FileSaver

FileSystem

external interface FileSystem

FileSystemCallback

external interface FileSystemCallback

FileSystemSync

external interface FileSystemSync

FileWriter

external interface FileWriter : FileSaver

FileWriterCallback

external interface FileWriterCallback

FileWriterSync

external interface FileWriterSync

Flags

external interface Flags

Geolocation

object Geolocation

Main geolocation object based on webview api.

GeolocationException

class GeolocationException(val code: PositionError, message: String)

Exception class for geolocation errors.

InAppBrowser

object InAppBrowser

Main object for Cordova InAppBrowser api.

InAppBrowserEvent

external class InAppBrowserEvent

InAppBrowser event type.

LocalFileSystem

external object LocalFileSystem

LocalFileSystemSync

external object LocalFileSystemSync

Locationservices

object Locationservices

Main geolocation object based on Google location services api.

Media

external class Media(src: String, mediaSuccess: () -> Unit? = definedExternally, mediaError: (MediaError) -> Unit? = definedExternally, mediaStatus: (Int) -> Unit? = definedExternally)

Cordova media class.

MediaCapture

object MediaCapture

Main media capture object.

MediaError

external class MediaError

Media error class.

MediaFile

external class MediaFile

Media file information class.

MediaFileData

external class MediaFileData

Media file details class.

Metadata

external interface Metadata

MetadataCallback

external interface MetadataCallback

Network

object Network

Main object for Cordova network.

Notification

object Notification

Main object for Cordova notifications.

PendingResult

external class PendingResult

Pending result class.

Position

external class Position

Geolocation position value.

PositionError

enum PositionError : Enum<PositionError>

Geolocaton error codes.

PromptResponse

external class PromptResponse

A response object for prompt function callback.

ResumeEvent

external class ResumeEvent

Resume event class.

Screen

object Screen

Main object for Cordova screen.

Splashscreen

object Splashscreen

Main object for Cordova splashscreen.

StatusBar

object StatusBar

Main object for Cordova status bar.

SystemDirs

external class SystemDirs

System directories class.

Vibration

object Vibration

Main object for Cordova vibration.

VoidCallback

external interface VoidCallback

Properties

cordovaDevice

var cordovaDevice: Device?

Cordova device information object.

Functions

addCordovaEventListener

fun addCordovaEventListener(event: CordovaEvent, listener: (<Error class: unknown class>) -> Unit)

Add listeners for a Cordova events.

addDeviceReadyListener

fun addDeviceReadyListener(listener: (Device) -> Unit)

Add listeners for 'deviceready' Cordova event.

addPauseListener

fun addPauseListener(listener: () -> Unit)

Add listeners for 'pause' Cordova event.

addResumeListener

fun addResumeListener(listener: (ResumeEvent) -> Unit)

Add listeners for 'resume' Cordova event.

append

suspend fun FileEntry.append(data: <Error class: unknown class>): <Error class: unknown class><FileEntry>

Append file content from a Blob.

suspend fun FileEntry.append(data: String): <Error class: unknown class><FileEntry>

Append file content from a plain string.

copyTo

suspend fun Entry.copyTo(parent: DirectoryEntry, newName: String? = null): <Error class: unknown class><Entry>

Copy given file or directory to a new location.

createWriter

suspend fun FileEntry.createWriter(): <Error class: unknown class><FileWriter>

Create a FileWriter object for a given file entry.

file

suspend fun FileEntry.file(): <Error class: unknown class><<Error class: unknown class>>

Get a File object for a given file entry.

getCurrentAmplitude

suspend fun Media.getCurrentAmplitude(): Number

Returns the current amplitude within an audio file.

getCurrentPosition

suspend fun Media.getCurrentPosition(): Number

Returns the current position within an audio file.

getDevice

suspend fun getDevice(): Device

Suspending function to return device information object.

getDirectory

suspend fun DirectoryEntry.getDirectory(path: String, create: Boolean = true, exclusive: Boolean = false): <Error class: unknown class><DirectoryEntry>

Get or create a directory in a given parent directory.

getFile

suspend fun DirectoryEntry.getFile(path: String, create: Boolean = true, exclusive: Boolean = false): <Error class: unknown class><FileEntry>

Get or create a file in a given parent directory.

getFormatData

suspend fun MediaFile.getFormatData(): MediaFileData?

Get details for the given file.

getMetadata

suspend fun Entry.getMetadata(): <Error class: unknown class><Metadata>

Get file or directory metadata.

getParent

suspend fun Entry.getParent(): <Error class: unknown class><DirectoryEntry>

Get file or directory parent directory entry.

invoke

inline operator fun VoidCallback.invoke()

inline operator fun DirectoryEntryCallback.invoke(entry: DirectoryEntry)

inline operator fun EntriesCallback.invoke(entries: Array<Entry>)

inline operator fun EntryCallback.invoke(entry: Entry)

inline operator fun ErrorCallback.invoke(err: <Error class: unknown class>)

inline operator fun FileCallback.invoke(file: File)

inline operator fun FileEntryCallback.invoke(entry: FileEntry)

inline operator fun FileSystemCallback.invoke(filesystem: FileSystem)

inline operator fun FileWriterCallback.invoke(fileWriter: FileWriter)

inline operator fun MetadataCallback.invoke(metadata: Metadata)

moveTo

suspend fun Entry.moveTo(parent: DirectoryEntry, newName: String? = null): <Error class: unknown class><Entry>

Move given file or directory to a new location.

readAsArrayBuffer

suspend fun FileEntry.readAsArrayBuffer(): <Error class: unknown class><<Error class: unknown class>>

Read file content as an array buffer.

readAsDataURL

suspend fun FileEntry.readAsDataURL(): <Error class: unknown class><String>

Read file content as a data url.

readAsText

suspend fun FileEntry.readAsText(): <Error class: unknown class><String>

Read file content as a plain string.

readEntries

suspend fun DirectoryEntry.readEntries(): <Error class: unknown class><List<Entry>>

List directory entries for a given parent directory entry.

suspend fun DirectoryReader.readEntries(): <Error class: unknown class><List<Entry>>

List directory entries for a given DirectoryReader.

remove

suspend fun Entry.remove(): <Error class: unknown class><Entry>

Remove given file or directory.

removeRecursively

suspend fun DirectoryEntry.removeRecursively(): <Error class: unknown class><DirectoryEntry>

Remove given directory recursively.

toBlob

fun <Error class: unknown class>.toBlob(): <Error class: unknown class>

Convert array buffer to a blob.

toDirectoryEntry

suspend fun String.toDirectoryEntry(): <Error class: unknown class><DirectoryEntry>

Extension function to convert String to a directory entry.

toFileEntry

suspend fun String.toFileEntry(): <Error class: unknown class><FileEntry>

Extension function to convert String to a file entry.

write

suspend fun FileEntry.write(data: <Error class: unknown class>): <Error class: unknown class><FileEntry>

Write file content from an array buffer.

suspend fun FileEntry.write(data: <Error class: unknown class>): <Error class: unknown class><FileEntry>

Write file content from a Blob.

suspend fun FileEntry.write(data: String): <Error class: unknown class><FileEntry>

Write file content from a plain string.

writeDataUrL

suspend fun FileEntry.writeDataUrL(dataUrl: String): <Error class: unknown class><FileEntry>

Write file content from a data url.