diff options
Diffstat (limited to 'ical4android/at.bitfire.ical4android.util/-android-time-utils/android-string-to-recurrence-set.html')
| -rw-r--r-- | ical4android/at.bitfire.ical4android.util/-android-time-utils/android-string-to-recurrence-set.html | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/ical4android/at.bitfire.ical4android.util/-android-time-utils/android-string-to-recurrence-set.html b/ical4android/at.bitfire.ical4android.util/-android-time-utils/android-string-to-recurrence-set.html new file mode 100644 index 0000000..bd9a10a --- /dev/null +++ b/ical4android/at.bitfire.ical4android.util/-android-time-utils/android-string-to-recurrence-set.html @@ -0,0 +1,69 @@ +<!DOCTYPE html> +<html> +<head> + <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> + <title>androidStringToRecurrenceSet</title> + <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"> + <script>var pathToRoot = "../../../";</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="../../../scripts/sourceset_dependencies.js" async="async"></script> +<link href="../../../styles/style.css" rel="Stylesheet"> +<link href="../../../styles/jetbrains-mono.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"> +<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="navigation-wrapper" id="navigation-wrapper"> + <div id="leftToggler"><span class="icon-toggler"></span></div> + <div class="library-name"> + <a href="../../../index.html"> + <span>ical4android</span> + </a> + </div> + <div> + </div> + <div class="pull-right d-flex"> + <button id="theme-toggle-button"><span id="theme-toggle"></span></button> + <div id="searchBar"></div> + </div> +</div> +<div id="container"> + <div id="leftColumn"> + <div id="sideMenu"></div> + </div> + <div id="main"> +<div class="main-content" id="content" pageIds="ical4android::at.bitfire.ical4android.util/AndroidTimeUtils/androidStringToRecurrenceSet/#kotlin.String#kotlin.Boolean#kotlin.Long?#kotlin.Function1[net.fortuna.ical4j.model.DateList,TypeParam(bounds=[net.fortuna.ical4j.model.property.DateListProperty])]/PointingToDeclaration//579055962"> + <div class="breadcrumbs"><a href="../../../index.html">ical4android</a><span class="delimiter">/</span><a href="../index.html">at.bitfire.ical4android.util</a><span class="delimiter">/</span><a href="index.html">AndroidTimeUtils</a><span class="delimiter">/</span><span class="current">androidStringToRecurrenceSet</span></div> + <div class="cover "> + <h1 class="cover"><span>android</span><wbr></wbr><span>String</span><wbr></wbr><span>To</span><wbr></wbr><span>Recurrence</span><wbr></wbr><span><span>Set</span></span></h1> + </div> + <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="android-string-to-recurrence-set.html">T</a><span class="token operator"> : </span><span data-unresolved-link="net.fortuna.ical4j.model.property/DateListProperty///PointingToDeclaration/">DateListProperty</span><span class="token operator">> </span><a href="android-string-to-recurrence-set.html"><span class="token function">androidStringToRecurrenceSet</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dbStr<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 ">allDay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span></span><span class="parameter ">exclude<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">generator<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><span data-unresolved-link="net.fortuna.ical4j.model/DateList///PointingToDeclaration/">DateList</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="android-string-to-recurrence-set.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="android-string-to-recurrence-set.html">T</a></div><p class="paragraph">Takes a formatted string as provided by the Android calendar provider and returns a DateListProperty constructed from these values.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">instance of "type" containing the parsed dates/times from the string</p></span><h4 class="">Parameters</h4><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>db</span><wbr></wbr><span><span>Str</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">formatted string from Android calendar provider (RDATE/EXDATE field) expected format: "TZID;date1,date2,date3" where date is "yyyymmddThhmmssZ"</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>all</span><wbr></wbr><span><span>Day</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">true: list will contain DATE values; false: list will contain DATE_TIME values</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span><span>exclude</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">this time stamp won't be added to the <span data-unresolved-link="net.fortuna.ical4j.model.property/DateListProperty///PointingToDeclaration/">DateListProperty</span></p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span><span>generator</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">generates the <span data-unresolved-link="net.fortuna.ical4j.model.property/DateListProperty///PointingToDeclaration/">DateListProperty</span>; must call the constructor with the one argument of type <span data-unresolved-link="net.fortuna.ical4j.model/DateList///PointingToDeclaration/">DateList</span></p></div></div></div></div></div></div></div><h4 class="">Throws</h4><div class="table" data-togglable="Throws"><div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/java/text/ParseException.html"><span>Parse</span><wbr></wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">when the string cannot be parsed</p></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>© 2022 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> +</body> +</html> |