mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2024-07-01 05:47:34 +00:00
81 lines
21 KiB
HTML
81 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>uniUpload</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
|
<script>var pathToRoot = "../../";</script>
|
|
<script>document.documentElement.classList.replace("no-js","js");</script>
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if(savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</script>
|
|
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
|
<link href="../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../styles/logo-styles.css" rel="Stylesheet">
|
|
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
|
|
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
|
</head>
|
|
<body>
|
|
<div class="root">
|
|
<nav class="navigation" id="navigation-wrapper">
|
|
<div class="navigation--inner">
|
|
<div class="navigation-title">
|
|
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
|
<div class="library-name">
|
|
<a class="library-name--link" href="../../index.html">
|
|
micro_utils.dokka
|
|
</a>
|
|
</div>
|
|
<div class="library-version">
|
|
0.20.40 </div>
|
|
</div>
|
|
<div class="filter-section" id="filter-section">
|
|
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button>
|
|
</div>
|
|
</div>
|
|
<div class="navigation-controls">
|
|
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
|
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
|
</div>
|
|
</nav>
|
|
<div id="container">
|
|
<div class="sidebar" id="leftColumn">
|
|
<div class="sidebar--inner" id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div class="main-content" data-page-type="member" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.ktor.client//uniUpload/[Error type: Unresolved type for HttpClient]#kotlin.String#dev.inmo.micro_utils.common.MPPFile#kotlinx.serialization.DeserializationStrategy[TypeParam(bounds=[kotlin.Any?])]#kotlin.collections.Map[kotlin.String,kotlin.Any]#[Error type: Unresolved type for Headers]#kotlinx.serialization.StringFormat#kotlin.coroutines.SuspendFunction2[kotlin.Long,kotlin.Long,kotlin.Unit]/PointingToDeclaration//-1478683138">
|
|
<div class="breadcrumbs"><a href="../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="index.html">dev.inmo.micro_utils.ktor.client</a><span class="delimiter">/</span><span class="current">uniUpload</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>uni</span><wbr></wbr><span><span>Upload</span></span></h1>
|
|
</div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">> </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="uni-upload.html"><span class="token function">uniUpload</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">url<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">file<span class="token operator">: </span><a href="../dev.inmo.micro_utils.common/-m-p-p-file/index.html">MPPFile</a><span class="token punctuation">, </span></span><span class="parameter ">resultDeserializer<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/DeserializationStrategy///PointingToDeclaration/">DeserializationStrategy</span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">additionalData<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token operator"> = </span>emptyMap()<span class="token punctuation">, </span></span><span class="parameter ">headers<span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token operator"> = </span>Headers.Empty<span class="token punctuation">, </span></span><span class="parameter ">stringFormat<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/StringFormat///PointingToDeclaration/">StringFormat</span><span class="token operator"> = </span>Json<span class="token punctuation">, </span></span><span class="parameter ">onUpload<span class="token operator">: </span><a href="-on-upload-callback/index.html">OnUploadCallback</a><span class="token operator"> = </span>{ _, _ -> }</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="uni-upload.html">T</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//ktor/client/src/commonMain/kotlin/dev/inmo/micro_utils/ktor/client/UniUpload.kt#L42">source</a>)</span></span></div><p class="paragraph">Additional variant of <a href="uni-upload.html">uniUpload</a> which will unify sending of some <a href="../dev.inmo.micro_utils.common/-m-p-p-file/index.html">MPPFile</a> with the server</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>micro_utils.</span><wbr></wbr><span>ktor.</span><wbr></wbr><span>server.</span><wbr></wbr><span>uniload</span><wbr></wbr><span>Multipart</span><wbr></wbr><span><span>File</span></span></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">> </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="uni-upload.html"><span class="token function">uniUpload</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">url<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">info<span class="token operator">: </span><a href="-uni-upload-file-info/index.html">UniUploadFileInfo</a><span class="token punctuation">, </span></span><span class="parameter ">resultDeserializer<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/DeserializationStrategy///PointingToDeclaration/">DeserializationStrategy</span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">additionalData<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token operator"> = </span>emptyMap()<span class="token punctuation">, </span></span><span class="parameter ">headers<span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token operator"> = </span>Headers.Empty<span class="token punctuation">, </span></span><span class="parameter ">stringFormat<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/StringFormat///PointingToDeclaration/">StringFormat</span><span class="token operator"> = </span>Json<span class="token punctuation">, </span></span><span class="parameter ">onUpload<span class="token operator">: </span><a href="-on-upload-callback/index.html">OnUploadCallback</a><span class="token operator"> = </span>{ _, _ -> }</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="uni-upload.html">T</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//ktor/client/src/commonMain/kotlin/dev/inmo/micro_utils/ktor/client/UniUpload.kt#L64">source</a>)</span></span></div><p class="paragraph">Additional variant of <a href="uni-upload.html">uniUpload</a> which will unify sending of some <a href="-uni-upload-file-info/index.html">UniUploadFileInfo</a> with the server</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>micro_utils.</span><wbr></wbr><span>ktor.</span><wbr></wbr><span>server.</span><wbr></wbr><span>uniload</span><wbr></wbr><span>Multipart</span><wbr></wbr><span><span>File</span></span></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">> </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="uni-upload.html"><span class="token function">uniUpload</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">url<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">fileName<span class="token operator">: </span><a href="../dev.inmo.micro_utils.common/-file-name/index.html">FileName</a><span class="token punctuation">, </span></span><span class="parameter ">mimeType<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">inputAllocator<span class="token operator">: </span><a href="../dev.inmo.micro_utils.ktor.common/-lambda-input-provider/index.html">LambdaInputProvider</a><span class="token punctuation">, </span></span><span class="parameter ">resultDeserializer<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/DeserializationStrategy///PointingToDeclaration/">DeserializationStrategy</span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">additionalData<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token operator"> = </span>emptyMap()<span class="token punctuation">, </span></span><span class="parameter ">headers<span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token operator"> = </span>Headers.Empty<span class="token punctuation">, </span></span><span class="parameter ">stringFormat<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/StringFormat///PointingToDeclaration/">StringFormat</span><span class="token operator"> = </span>Json<span class="token punctuation">, </span></span><span class="parameter ">onUpload<span class="token operator">: </span><a href="-on-upload-callback/index.html">OnUploadCallback</a><span class="token operator"> = </span>{ _, _ -> }</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="uni-upload.html">T</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//ktor/client/src/commonMain/kotlin/dev/inmo/micro_utils/ktor/client/UniUpload.kt#L87">source</a>)</span></span></div><p class="paragraph">Additional variant of <a href="uni-upload.html">uniUpload</a> which will unify sending of some <a href="-uni-upload-file-info/index.html">UniUploadFileInfo</a> (built from <a href="uni-upload.html">fileName</a>, <a href="uni-upload.html">mimeType</a> and <a href="uni-upload.html">inputAllocator</a>) with the server</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>micro_utils.</span><wbr></wbr><span>ktor.</span><wbr></wbr><span>server.</span><wbr></wbr><span>uniload</span><wbr></wbr><span>Multipart</span><wbr></wbr><span><span>File</span></span></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">> </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="uni-upload.html"><span class="token function">uniUpload</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">url<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">data<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">resultDeserializer<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/DeserializationStrategy///PointingToDeclaration/">DeserializationStrategy</span><span class="token operator"><</span><a href="uni-upload.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">headers<span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token operator"> = </span>Headers.Empty<span class="token punctuation">, </span></span><span class="parameter ">stringFormat<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/StringFormat///PointingToDeclaration/">StringFormat</span><span class="token operator"> = </span>Json<span class="token punctuation">, </span></span><span class="parameter ">onUpload<span class="token operator">: </span><a href="-on-upload-callback/index.html">OnUploadCallback</a><span class="token operator"> = </span>{ _, _ -> }</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="uni-upload.html">T</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//ktor/client/src/commonMain/kotlin/dev/inmo/micro_utils/ktor/client/UniUpload.kt#L28">source</a>)</span></span></div><p class="paragraph">Will execute submitting of multipart data request</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>data</span></span></u></div></span></div><div><div class="title"><p class="paragraph"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a> where keys will be used as names for multipart parts and values as values. If you will pass <a href="../dev.inmo.micro_utils.common/-m-p-p-file/index.html">dev.inmo.micro_utils.common.MPPFile</a> (File from JS or JVM platform). Also you may pass <a href="-uni-upload-file-info/index.html">UniUploadFileInfo</a> as value in case you wish to pass other source of multipart binary data than regular file</p></div></div></div></div></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>micro_utils.</span><wbr></wbr><span>ktor.</span><wbr></wbr><span>server.</span><wbr></wbr><span>handle</span><wbr></wbr><span>Uni</span><wbr></wbr><span><span>Upload</span></span></div></span></div><div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="footer">
|
|
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
|
class="pull-right"><span>Generated by </span><a
|
|
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|