kvision-cordova/io.kvision.cordova

Package-level declarations

Kotlin bindings for core Apache Cordova API.

Types

Link copied to clipboard
object Battery

Main object for Cordova battery.

Link copied to clipboard
external class BatteryStatus

Battery status.

Link copied to clipboard
external class Browser

InAppBrowser reference object.

Link copied to clipboard
object Camera

Main object for Cordova camera.

Link copied to clipboard
class CameraException(message: String) : Exception

Exception class for camera errors.

Link copied to clipboard
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.

Link copied to clipboard
class CaptureException(code: MediaCapture.CaptureErrorCode) : Exception

Exception class for media capture errors.

Link copied to clipboard
external class Coordinates

Geolocation coordinates values.

Link copied to clipboard
enum CordovaEvent : Enum<CordovaEvent>

Cordova event types.

Link copied to clipboard
external class Device

Device information class.

Link copied to clipboard
external interface DirectoryEntry : Entry
Link copied to clipboard
external interface DirectoryEntryCallback
Link copied to clipboard
external interface DirectoryEntrySync : EntrySync
Link copied to clipboard
external interface DirectoryReader
Link copied to clipboard
external interface DirectoryReaderSync
Link copied to clipboard
external interface EntriesCallback
Link copied to clipboard
external interface Entry
Link copied to clipboard
external interface EntryCallback
Link copied to clipboard
external interface EntrySync
Link copied to clipboard
external interface ErrorCallback
Link copied to clipboard
object File

Main object for Cordova file.

Link copied to clipboard
external interface FileCallback
Link copied to clipboard
external interface FileEntry : Entry
Link copied to clipboard
external interface FileEntryCallback
Link copied to clipboard
external interface FileEntrySync : EntrySync
Link copied to clipboard
class FileException(code: Int) : Exception

Exception class for file errors.

Link copied to clipboard
external interface FileSaver : EventTarget
Link copied to clipboard
external interface FileSystem
Link copied to clipboard
external interface FileSystemCallback
Link copied to clipboard
external interface FileSystemSync
Link copied to clipboard
external interface FileWriter : FileSaver
Link copied to clipboard
external interface FileWriterCallback
Link copied to clipboard
external interface FileWriterSync
Link copied to clipboard
external interface Flags
Link copied to clipboard
object Geolocation

Main geolocation object based on webview api.

Link copied to clipboard
class GeolocationException(val code: PositionError, message: String) : Exception

Exception class for geolocation errors.

Link copied to clipboard
object InAppBrowser

Main object for Cordova InAppBrowser api.

Link copied to clipboard
external class InAppBrowserEvent

InAppBrowser event type.

Link copied to clipboard
external object LocalFileSystem
Link copied to clipboard
external object LocalFileSystemSync
Link copied to clipboard
object Locationservices

Main geolocation object based on Google location services api.

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

Cordova media class.

Link copied to clipboard
object MediaCapture

Main media capture object.

Link copied to clipboard
external class MediaError

Media error class.

Link copied to clipboard
external class MediaFile

Media file information class.

Link copied to clipboard
external class MediaFileData

Media file details class.

Link copied to clipboard
external interface Metadata
Link copied to clipboard
external interface MetadataCallback
Link copied to clipboard
object Network

Main object for Cordova network.

Link copied to clipboard
object Notification

Main object for Cordova notifications.

Link copied to clipboard
external class PendingResult

Pending result class.

Link copied to clipboard
external class Position

Geolocation position value.

Link copied to clipboard
enum PositionError : Enum<PositionError>

Geolocaton error codes.

Link copied to clipboard
external class PromptResponse

A response object for prompt function callback.

Link copied to clipboard
external class ResumeEvent

Resume event class.

Link copied to clipboard
object Screen

Main object for Cordova screen.

Link copied to clipboard
object Splashscreen

Main object for Cordova splashscreen.

Link copied to clipboard
object StatusBar

Main object for Cordova status bar.

Link copied to clipboard
external class SystemDirs

System directories class.

Link copied to clipboard
object Vibration

Main object for Cordova vibration.

Link copied to clipboard
external interface VoidCallback

Properties

Link copied to clipboard
var cordovaDevice: Device?

Cordova device information object.

Functions

Link copied to clipboard
fun addCordovaEventListener(event: CordovaEvent, listener: (Event) -> Unit)

Add listeners for a Cordova events.

Link copied to clipboard
fun addDeviceReadyListener(listener: (Device) -> Unit)

Add listeners for 'deviceready' Cordova event.

Link copied to clipboard
fun addPauseListener(listener: () -> Unit)

Add listeners for 'pause' Cordova event.

Link copied to clipboard
fun addResumeListener(listener: (ResumeEvent) -> Unit)

Add listeners for 'resume' Cordova event.

Link copied to clipboard
suspend fun FileEntry.append(data: String): Result<FileEntry>

Append file content from a plain string.

suspend fun FileEntry.append(data: Blob): Result<FileEntry>

Append file content from a Blob.

Link copied to clipboard
suspend fun Entry.copyTo(parent: DirectoryEntry, newName: String? = null): Result<Entry>

Copy given file or directory to a new location.

Link copied to clipboard
suspend fun FileEntry.createWriter(): Result<FileWriter>

Create a FileWriter object for a given file entry.

Link copied to clipboard
suspend fun FileEntry.file(): Result<File>

Get a File object for a given file entry.

Link copied to clipboard
suspend fun Media.getCurrentAmplitude(): Number

Returns the current amplitude within an audio file.

Link copied to clipboard
suspend fun Media.getCurrentPosition(): Number

Returns the current position within an audio file.

Link copied to clipboard
suspend fun getDevice(): Device

Suspending function to return device information object.

Link copied to clipboard
suspend fun DirectoryEntry.getDirectory(path: String, create: Boolean = true, exclusive: Boolean = false): Result<DirectoryEntry>

Get or create a directory in a given parent directory.

Link copied to clipboard
suspend fun DirectoryEntry.getFile(path: String, create: Boolean = true, exclusive: Boolean = false): Result<FileEntry>

Get or create a file in a given parent directory.

Link copied to clipboard
suspend fun MediaFile.getFormatData(): MediaFileData?

Get details for the given file.

Link copied to clipboard
suspend fun Entry.getMetadata(): Result<Metadata>

Get file or directory metadata.

Link copied to clipboard
suspend fun Entry.getParent(): Result<DirectoryEntry>

Get file or directory parent directory entry.

Link copied to clipboard
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)
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)
Link copied to clipboard
suspend fun Entry.moveTo(parent: DirectoryEntry, newName: String? = null): Result<Entry>

Move given file or directory to a new location.

Link copied to clipboard
suspend fun FileEntry.readAsArrayBuffer(): Result<ArrayBuffer>

Read file content as an array buffer.

Link copied to clipboard
suspend fun FileEntry.readAsDataURL(): Result<String>

Read file content as a data url.

Link copied to clipboard
suspend fun FileEntry.readAsText(): Result<String>

Read file content as a plain string.

Link copied to clipboard
suspend fun DirectoryEntry.readEntries(): Result<List<Entry>>

List directory entries for a given parent directory entry.

suspend fun DirectoryReader.readEntries(): Result<List<Entry>>

List directory entries for a given DirectoryReader.

Link copied to clipboard
suspend fun Entry.remove(): Result<Entry>

Remove given file or directory.

Link copied to clipboard
suspend fun DirectoryEntry.removeRecursively(): Result<DirectoryEntry>

Remove given directory recursively.

Link copied to clipboard
fun ArrayBuffer.toBlob(): Blob

Convert array buffer to a blob.

Link copied to clipboard
suspend fun String.toDirectoryEntry(): Result<DirectoryEntry>

Extension function to convert String to a directory entry.

Link copied to clipboard
suspend fun String.toFileEntry(): Result<FileEntry>

Extension function to convert String to a file entry.

Link copied to clipboard
suspend fun FileEntry.write(data: String): Result<FileEntry>

Write file content from a plain string.

suspend fun FileEntry.write(data: ArrayBuffer): Result<FileEntry>

Write file content from an array buffer.

suspend fun FileEntry.write(data: Blob): Result<FileEntry>

Write file content from a Blob.

Link copied to clipboard
suspend fun FileEntry.writeDataUrL(dataUrl: String): Result<FileEntry>

Write file content from a data url.