From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-entry/copy-to.html | 14 ++ .../-entry/filesystem.html | 14 ++ .../-entry/full-path.html | 14 ++ .../-entry/get-metadata.html | 14 ++ .../-entry/get-parent.html | 14 ++ api1/pl.treksoft.kvision.cordova/-entry/index.html | 185 +++++++++++++++++++++ .../-entry/is-directory.html | 14 ++ .../-entry/is-file.html | 14 ++ .../-entry/move-to.html | 14 ++ api1/pl.treksoft.kvision.cordova/-entry/name.html | 14 ++ .../pl.treksoft.kvision.cordova/-entry/remove.html | 14 ++ .../-entry/to-internal-u-r-l.html | 14 ++ .../-entry/to-u-r-l.html | 14 ++ 13 files changed, 353 insertions(+) create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/copy-to.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/filesystem.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/full-path.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/get-metadata.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/get-parent.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/index.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/is-directory.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/is-file.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/move-to.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/name.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/remove.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/to-internal-u-r-l.html create mode 100644 api1/pl.treksoft.kvision.cordova/-entry/to-u-r-l.html (limited to 'api1/pl.treksoft.kvision.cordova/-entry') diff --git a/api1/pl.treksoft.kvision.cordova/-entry/copy-to.html b/api1/pl.treksoft.kvision.cordova/-entry/copy-to.html new file mode 100644 index 00000000..b8426d93 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/copy-to.html @@ -0,0 +1,14 @@ + + + +Entry.copyTo - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / copyTo
+
+

copyTo

+ +

abstract fun copyTo(parent: DirectoryEntry, newName: String? = definedExternally, successCallback: EntryCallback? = definedExternally, errorCallback: ErrorCallback? = definedExternally): Unit

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/filesystem.html b/api1/pl.treksoft.kvision.cordova/-entry/filesystem.html new file mode 100644 index 00000000..ef1e1fdd --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/filesystem.html @@ -0,0 +1,14 @@ + + + +Entry.filesystem - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / filesystem
+
+

filesystem

+ +abstract var filesystem: FileSystem + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/full-path.html b/api1/pl.treksoft.kvision.cordova/-entry/full-path.html new file mode 100644 index 00000000..d564b2c8 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/full-path.html @@ -0,0 +1,14 @@ + + + +Entry.fullPath - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / fullPath
+
+

fullPath

+ +abstract var fullPath: String + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/get-metadata.html b/api1/pl.treksoft.kvision.cordova/-entry/get-metadata.html new file mode 100644 index 00000000..1f9b9226 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/get-metadata.html @@ -0,0 +1,14 @@ + + + +Entry.getMetadata - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / getMetadata
+
+

getMetadata

+ +abstract fun getMetadata(successCallback: MetadataCallback, errorCallback: ErrorCallback? = definedExternally): Unit + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/get-parent.html b/api1/pl.treksoft.kvision.cordova/-entry/get-parent.html new file mode 100644 index 00000000..d342ed3c --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/get-parent.html @@ -0,0 +1,14 @@ + + + +Entry.getParent - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / getParent
+
+

getParent

+ +

abstract fun getParent(successCallback: DirectoryEntryCallback, errorCallback: ErrorCallback? = definedExternally): Unit

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/index.html b/api1/pl.treksoft.kvision.cordova/-entry/index.html new file mode 100644 index 00000000..d30e8877 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/index.html @@ -0,0 +1,185 @@ + + + +Entry - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry
+
+

Entry

+external interface Entry +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + +

+ filesystem +	+`abstract var filesystem: FileSystem`
+ fullPath +	+`abstract var fullPath: String`
+ isDirectory +	+`abstract var isDirectory: Boolean`
+ isFile +	+`abstract var isFile: Boolean`
+ name +	+`abstract var name: String`

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ copyTo +	+`abstract fun copyTo(parent: DirectoryEntry, newName: String? = definedExternally, successCallback: EntryCallback? = definedExternally, errorCallback: ErrorCallback? = definedExternally): Unit`
+ getMetadata +	+`abstract fun getMetadata(successCallback: MetadataCallback, errorCallback: ErrorCallback? = definedExternally): Unit`
+ getParent +	+`abstract fun getParent(successCallback: DirectoryEntryCallback, errorCallback: ErrorCallback? = definedExternally): Unit`
+ moveTo +	+`abstract fun moveTo(parent: DirectoryEntry, newName: String? = definedExternally, successCallback: EntryCallback? = definedExternally, errorCallback: ErrorCallback? = definedExternally): Unit`
+ remove +	+`abstract fun remove(successCallback: VoidCallback, errorCallback: ErrorCallback? = definedExternally): Unit`
+ toInternalURL +	+`abstract fun toInternalURL(): String`
+ toURL +	+`abstract fun toURL(): String`

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ copyTo +	+`suspend fun Entry.copyTo(parent: DirectoryEntry, newName: String? = null): Result<Entry, FileException>` + Copy given file or directory to a new location. +
+ createInstance +	+`fun <T> Any?.createInstance(vararg args: dynamic): T` + Helper function for creating JavaScript objects from dynamic constructors. +
+ getMetadata +	+`suspend fun Entry.getMetadata(): Result<Metadata, FileException>` + Get file or directory metadata. +
+ getParent +	+`suspend fun Entry.getParent(): Result<DirectoryEntry, FileException>` + Get file or directory parent directory entry. +
+ moveTo +	+`suspend fun Entry.moveTo(parent: DirectoryEntry, newName: String? = null): Result<Entry, FileException>` + Move given file or directory to a new location. +
+ remove +	+`suspend fun Entry.remove(): Result<Entry, FileException>` + Remove given file or directory. +

Inheritors

+ + + + + + + + + + + +

+ DirectoryEntry +	+`external interface DirectoryEntry : Entry`
+ FileEntry +	+`external interface FileEntry : Entry`

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/is-directory.html b/api1/pl.treksoft.kvision.cordova/-entry/is-directory.html new file mode 100644 index 00000000..bdf68692 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/is-directory.html @@ -0,0 +1,14 @@ + + + +Entry.isDirectory - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / isDirectory
+
+

isDirectory

+ +abstract var isDirectory: Boolean + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/is-file.html b/api1/pl.treksoft.kvision.cordova/-entry/is-file.html new file mode 100644 index 00000000..e8d6e938 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/is-file.html @@ -0,0 +1,14 @@ + + + +Entry.isFile - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / isFile
+
+

isFile

+ +abstract var isFile: Boolean + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/move-to.html b/api1/pl.treksoft.kvision.cordova/-entry/move-to.html new file mode 100644 index 00000000..ec1a97cc --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/move-to.html @@ -0,0 +1,14 @@ + + + +Entry.moveTo - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / moveTo
+
+

moveTo

+ +

abstract fun moveTo(parent: DirectoryEntry, newName: String? = definedExternally, successCallback: EntryCallback? = definedExternally, errorCallback: ErrorCallback? = definedExternally): Unit

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/name.html b/api1/pl.treksoft.kvision.cordova/-entry/name.html new file mode 100644 index 00000000..a2fe0cd7 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/name.html @@ -0,0 +1,14 @@ + + + +Entry.name - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / name
+
+

name

+ +abstract var name: String + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/remove.html b/api1/pl.treksoft.kvision.cordova/-entry/remove.html new file mode 100644 index 00000000..bcbdbcb9 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/remove.html @@ -0,0 +1,14 @@ + + + +Entry.remove - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / remove
+
+

remove

+ +abstract fun remove(successCallback: VoidCallback, errorCallback: ErrorCallback? = definedExternally): Unit + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/to-internal-u-r-l.html b/api1/pl.treksoft.kvision.cordova/-entry/to-internal-u-r-l.html new file mode 100644 index 00000000..dfd9e0d4 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/to-internal-u-r-l.html @@ -0,0 +1,14 @@ + + + +Entry.toInternalURL - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / toInternalURL
+
+

toInternalURL

+ +abstract fun toInternalURL(): String + + diff --git a/api1/pl.treksoft.kvision.cordova/-entry/to-u-r-l.html b/api1/pl.treksoft.kvision.cordova/-entry/to-u-r-l.html new file mode 100644 index 00000000..ec83ca8b --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-entry/to-u-r-l.html @@ -0,0 +1,14 @@ + + + +Entry.toURL - kvision + + + +kvision / pl.treksoft.kvision.cordova / Entry / toURL
+
+

toURL

+ +abstract fun toURL(): String + + -- cgit