aboutsummaryrefslogtreecommitdiff
path: root/api1/pl.treksoft.kvision.cordova/get-directory.html
diff options
context:
space:
mode:
authorRobert Jaros <rjaros@finn.pl>2019-10-26 00:17:24 +0200
committerRobert Jaros <rjaros@finn.pl>2019-10-26 00:17:24 +0200
commitfb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch)
tree911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.cordova/get-directory.html
parent4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff)
downloadkvision-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/get-directory.html')
-rw-r--r--api1/pl.treksoft.kvision.cordova/get-directory.html22
1 files changed, 22 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.cordova/get-directory.html b/api1/pl.treksoft.kvision.cordova/get-directory.html
new file mode 100644
index 00000000..2ef39f37
--- /dev/null
+++ b/api1/pl.treksoft.kvision.cordova/get-directory.html
@@ -0,0 +1,22 @@
+<HTML>
+<HEAD>
+<meta charset="UTF-8">
+<title>getDirectory - kvision</title>
+<link rel="stylesheet" href="../../style.css">
+</HEAD>
+<BODY>
+<a href="../index.html">kvision</a>&nbsp;/&nbsp;<a href="index.html">pl.treksoft.kvision.cordova</a>&nbsp;/&nbsp;<a href="./get-directory.html">getDirectory</a><br/>
+<br/>
+<h1>getDirectory</h1>
+<a name="pl.treksoft.kvision.cordova$getDirectory(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)"></a>
+<code><span class="keyword">suspend</span> <span class="keyword">fun </span><a href="-directory-entry/index.html"><span class="identifier">DirectoryEntry</span></a><span class="symbol">.</span><span class="identifier">getDirectory</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova$getDirectory(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)/path">path</span><span class="symbol">:</span>&nbsp;<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="identifier" id="pl.treksoft.kvision.cordova$getDirectory(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)/create">create</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova$getDirectory(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)/exclusive">exclusive</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;false<span class="symbol">)</span><span class="symbol">: </span><a href="-result/index.html"><span class="identifier">Result</span></a><span class="symbol">&lt;</span><a href="-directory-entry/index.html"><span class="identifier">DirectoryEntry</span></a><span class="symbol">,</span>&nbsp;<a href="-file-exception/index.html"><span class="identifier">FileException</span></a><span class="symbol">&gt;</span></code>
+<p>Get or create a directory in a given parent directory.</p>
+<h3>Parameters</h3>
+<p><a name="path"></a>
+<code>path</code> - target directory path</p>
+<p><a name="create"></a>
+<code>create</code> - Used to indicate that the user wants to create a directory if it was not previously there.</p>
+<p><a name="exclusive"></a>
+<code>exclusive</code> - Fail if the target path directory already exists.</p>
+</BODY>
+</HTML>