diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.cordova/-file/index.html | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.cordova/-file/index.html')
| -rw-r--r-- | api1/pl.treksoft.kvision.cordova/-file/index.html | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.cordova/-file/index.html b/api1/pl.treksoft.kvision.cordova/-file/index.html new file mode 100644 index 00000000..ee5cd384 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-file/index.html @@ -0,0 +1,181 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>File - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.cordova</a> / <a href="./index.html">File</a><br/> +<br/> +<h1>File</h1> +<code><span class="keyword">object </span><span class="identifier">File</span></code> +<p>Main object for Cordova file.</p> +<h3>Types</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-file-system-type/index.html">FileSystemType</a></p> +</td> +<td> +<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">FileSystemType</span></code> +<p>File system types.</p> +</td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-a-b-o-r-t_-e-r-r.html">ABORT_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">ABORT_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-e-n-c-o-d-i-n-g_-e-r-r.html">ENCODING_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">ENCODING_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-i-n-v-a-l-i-d_-m-o-d-i-f-i-c-a-t-i-o-n_-e-r-r.html">INVALID_MODIFICATION_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">INVALID_MODIFICATION_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-i-n-v-a-l-i-d_-s-t-a-t-e_-e-r-r.html">INVALID_STATE_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">INVALID_STATE_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-n-o_-m-o-d-i-f-i-c-a-t-i-o-n_-a-l-l-o-w-e-d_-e-r-r.html">NO_MODIFICATION_ALLOWED_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">NO_MODIFICATION_ALLOWED_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-n-o-t_-f-o-u-n-d_-e-r-r.html">NOT_FOUND_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">NOT_FOUND_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-n-o-t_-r-e-a-d-a-b-l-e_-e-r-r.html">NOT_READABLE_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">NOT_READABLE_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-p-a-t-h_-e-x-i-s-t-s_-e-r-r.html">PATH_EXISTS_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">PATH_EXISTS_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-q-u-o-t-a_-e-x-c-e-e-d-e-d_-e-r-r.html">QUOTA_EXCEEDED_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">QUOTA_EXCEEDED_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-s-e-c-u-r-i-t-y_-e-r-r.html">SECURITY_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">SECURITY_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-s-y-n-t-a-x_-e-r-r.html">SYNTAX_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">SYNTAX_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-t-y-p-e_-m-i-s-m-a-t-c-h_-e-r-r.html">TYPE_MISMATCH_ERR</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">TYPE_MISMATCH_ERR</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="get-system-directories.html">getSystemDirectories</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">getSystemDirectories</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-system-dirs/index.html"><span class="identifier">SystemDirs</span></a></code> +<p>Get system directories.</p> +</td> +</tr> +<tr> +<td> +<p><a href="request-file-system.html">requestFileSystem</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">requestFileSystem</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.File$requestFileSystem(pl.treksoft.kvision.cordova.File.FileSystemType, kotlin.Long)/fileSystemType">fileSystemType</span><span class="symbol">:</span> <a href="-file-system-type/index.html"><span class="identifier">File.FileSystemType</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.File$requestFileSystem(pl.treksoft.kvision.cordova.File.FileSystemType, kotlin.Long)/size">size</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html"><span class="identifier">Long</span></a> <span class="symbol">=</span> 0<span class="symbol">)</span><span class="symbol">: </span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-file-system/index.html"><span class="identifier">FileSystem</span></a><span class="symbol">,</span> <a href="../-file-exception/index.html"><span class="identifier">FileException</span></a><span class="symbol">></span></code> +<p>Request a file system of a given type.</p> +</td> +</tr> +<tr> +<td> +<p><a href="resolve-local-file-system-u-r-l.html">resolveLocalFileSystemURL</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">resolveLocalFileSystemURL</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.File$resolveLocalFileSystemURL(kotlin.String)/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-entry/index.html"><span class="identifier">Entry</span></a><span class="symbol">,</span> <a href="../-file-exception/index.html"><span class="identifier">FileException</span></a><span class="symbol">></span></code> +<p>Resolve given path to a file or directory entry.</p> +</td> +</tr> +<tr> +<td> +<p><a href="resolve-local-file-system-u-r-l-for-dir.html">resolveLocalFileSystemURLForDir</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">resolveLocalFileSystemURLForDir</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.File$resolveLocalFileSystemURLForDir(kotlin.String)/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-directory-entry/index.html"><span class="identifier">DirectoryEntry</span></a><span class="symbol">,</span> <a href="../-file-exception/index.html"><span class="identifier">FileException</span></a><span class="symbol">></span></code> +<p>Resolve given path to a directory entry.</p> +</td> +</tr> +<tr> +<td> +<p><a href="resolve-local-file-system-u-r-l-for-file.html">resolveLocalFileSystemURLForFile</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">resolveLocalFileSystemURLForFile</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.File$resolveLocalFileSystemURLForFile(kotlin.String)/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-file-entry/index.html"><span class="identifier">FileEntry</span></a><span class="symbol">,</span> <a href="../-file-exception/index.html"><span class="identifier">FileException</span></a><span class="symbol">></span></code> +<p>Resolve given path to a file entry.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |