MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.ktor.server/-temporal-files-routing-configurator/index.html

223 lines
21 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TemporalFilesRoutingConfigurator</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.21.1 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</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="classlike" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.ktor.server/TemporalFilesRoutingConfigurator///PointingToDeclaration//-1052446920">
<div class="breadcrumbs"><a href="../../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.micro_utils.ktor.server</a><span class="delimiter">/</span><span class="current">TemporalFilesRoutingConfigurator</span></div>
<div class="cover ">
<h1 class="cover"><span>Temporal</span><wbr></wbr><span>Files</span><wbr></wbr><span>Routing</span><wbr></wbr><span><span>Configurator</span></span></h1>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">TemporalFilesRoutingConfigurator</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">subpath<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>DefaultTemporalFilesSubPath<span class="token punctuation">, </span></span><span class="parameter ">temporalFilesUtilizer<span class="token operator">: </span><a href="-temporal-files-utilizer/index.html">TemporalFilesRoutingConfigurator.TemporalFilesUtilizer</a><span class="token operator"> = </span>TemporalFilesUtilizer</span></span><span class="token punctuation">)</span> : <a href="../../dev.inmo.micro_utils.ktor.server.configurators/-application-routing-configurator/-element/index.html">ApplicationRoutingConfigurator.Element</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//ktor/server/src/jvmMain/kotlin/dev/inmo/micro_utils/ktor/server/TemporalFilesRoutingConfigurator.kt#L27">source</a>)</span></span></div></div> </div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="-242195347%2FConstructors%2F-1052446920" anchor-label="TemporalFilesRoutingConfigurator" id="-242195347%2FConstructors%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-temporal-files-routing-configurator.html"><span>Temporal</span><wbr></wbr><span>Files</span><wbr></wbr><span>Routing</span><wbr></wbr><span><span>Configurator</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-242195347%2FConstructors%2F-1052446920"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">subpath<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>DefaultTemporalFilesSubPath<span class="token punctuation">, </span></span><span class="parameter ">temporalFilesUtilizer<span class="token operator">: </span><a href="-temporal-files-utilizer/index.html">TemporalFilesRoutingConfigurator.TemporalFilesUtilizer</a><span class="token operator"> = </span>TemporalFilesUtilizer</span></span><span class="token punctuation">)</span></div></div> </div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="1198661588%2FClasslikes%2F-1052446920" anchor-label="TemporalFilesUtilizer" id="1198661588%2FClasslikes%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-temporal-files-utilizer/index.html"><span>Temporal</span><wbr></wbr><span>Files</span><wbr></wbr><span><span>Utilizer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1198661588%2FClasslikes%2F-1052446920"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-temporal-files-utilizer/index.html">TemporalFilesUtilizer</a></div></div> </div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="105811193%2FProperties%2F-1052446920" anchor-label="utilizerJob" id="105811193%2FProperties%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="utilizer-job.html"><span>utilizer</span><wbr></wbr><span><span>Job</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="105811193%2FProperties%2F-1052446920"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="utilizer-job.html">utilizerJob</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div></div> </div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-607640351%2FFunctions%2F-1052446920" anchor-label="getAndRemoveTemporalFile" id="-607640351%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="get-and-remove-temporal-file.html"><span>get</span><wbr></wbr><span>And</span><wbr></wbr><span>Remove</span><wbr></wbr><span>Temporal</span><wbr></wbr><span><span>File</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-607640351%2FFunctions%2F-1052446920"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="get-and-remove-temporal-file.html"><span class="token function">getAndRemoveTemporalFile</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">temporalFileId<span class="token operator">: </span><a href="../../dev.inmo.micro_utils.ktor.common/-temporal-file-id/index.html">TemporalFileId</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a><span class="token operator">?</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="366615264%2FFunctions%2F-1052446920" anchor-label="getTemporalFile" id="366615264%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="get-temporal-file.html"><span>get</span><wbr></wbr><span>Temporal</span><wbr></wbr><span><span>File</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="366615264%2FFunctions%2F-1052446920"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="get-temporal-file.html"><span class="token function">getTemporalFile</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">temporalFileId<span class="token operator">: </span><a href="../../dev.inmo.micro_utils.ktor.common/-temporal-file-id/index.html">TemporalFileId</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a><span class="token operator">?</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="-1424744123%2FFunctions%2F-1052446920" anchor-label="invoke" id="-1424744123%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="invoke.html"><span><span>invoke</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1424744123%2FFunctions%2F-1052446920"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token punctuation">.</span><a href="invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="-367090656%2FFunctions%2F-1052446920" anchor-label="removeTemporalFile" id="-367090656%2FFunctions%2F-1052446920" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="remove-temporal-file.html"><span>remove</span><wbr></wbr><span>Temporal</span><wbr></wbr><span><span>File</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-367090656%2FFunctions%2F-1052446920"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="remove-temporal-file.html"><span class="token function">removeTemporalFile</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">temporalFileId<span class="token operator">: </span><a href="../../dev.inmo.micro_utils.ktor.common/-temporal-file-id/index.html">TemporalFileId</a></span></span><span class="token punctuation">)</span></div></div> </div>
</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>