diff options
Diffstat (limited to 'ical4android/at.bitfire.ical4android.util/-android-time-utils/index.html')
| -rw-r--r-- | ical4android/at.bitfire.ical4android.util/-android-time-utils/index.html | 198 |
1 files changed, 198 insertions, 0 deletions
diff --git a/ical4android/at.bitfire.ical4android.util/-android-time-utils/index.html b/ical4android/at.bitfire.ical4android.util/-android-time-utils/index.html new file mode 100644 index 0000000..0bd23b0 --- /dev/null +++ b/ical4android/at.bitfire.ical4android.util/-android-time-utils/index.html @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html> +<head> + <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> + <title>AndroidTimeUtils</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///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><span class="current">AndroidTimeUtils</span></div> + <div class="cover "> + <h1 class="cover"><span>Android</span><wbr></wbr><span>Time</span><wbr></wbr><span><span>Utils</span></span></h1> + <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">object </span><a href="index.html">AndroidTimeUtils</a></div></div></div> + </div> + <div class="tabbedcontent"> + <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div> + <div class="tabs-section-body"> + <h2 class="">Functions</h2> + <div class="table" data-togglable="Functions"><a data-name="-679313959%2FFunctions%2F579055962" anchor-label="androidifyTimeZone" id="-679313959%2FFunctions%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="androidify-time-zone.html"><span>androidify</span><wbr></wbr><span>Time</span><wbr></wbr><span><span>Zone</span></span></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-679313959%2FFunctions%2F579055962"></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 " 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><a href="androidify-time-zone.html"><span class="token function">androidifyTimeZone</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dateList<span class="token operator">: </span><span data-unresolved-link="net.fortuna.ical4j.model.property/DateListProperty///PointingToDeclaration/">DateListProperty</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Ensures that a given <span data-unresolved-link="net.fortuna.ical4j.model.property/DateListProperty///PointingToDeclaration/">DateListProperty</span> either</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="androidify-time-zone.html"><span class="token function">androidifyTimeZone</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><span data-unresolved-link="net.fortuna.ical4j.model.property/DateProperty///PointingToDeclaration/">DateProperty</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Ensures that a given <span data-unresolved-link="net.fortuna.ical4j.model.property/DateProperty///PointingToDeclaration/">DateProperty</span> either</p></div></div></div> + </div> + </div> + </div> + </div> +<a data-name="1455861851%2FFunctions%2F579055962" anchor-label="androidStringToRecurrenceSet" id="1455861851%2FFunctions%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="android-string-to-recurrence-set.html"><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></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1455861851%2FFunctions%2F579055962"></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 " 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><div class="brief "><p class="paragraph">Takes a formatted string as provided by the Android calendar provider and returns a DateListProperty constructed from these values.</p></div></div></div> + </div> + </div> + </div> + </div> +<a data-name="1150864761%2FFunctions%2F579055962" anchor-label="parseDuration" id="1150864761%2FFunctions%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="parse-duration.html"><span>parse</span><wbr></wbr><span><span>Duration</span></span></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1150864761%2FFunctions%2F579055962"></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 " 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><a href="parse-duration.html"><span class="token function">parseDuration</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">durationStr<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/time/temporal/TemporalAmount.html">TemporalAmount</a></div><div class="brief "><p class="paragraph">Checks and fixes Event.duration values with incorrect format which can't be parsed by ical4j. Searches for values like "1H" and "3M" and groups them together in a standards-compliant way.</p></div></div></div> + </div> + </div> + </div> + </div> +<a data-name="326898706%2FFunctions%2F579055962" anchor-label="recurrenceSetsToAndroidString" id="326898706%2FFunctions%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="recurrence-sets-to-android-string.html"><span>recurrence</span><wbr></wbr><span>Sets</span><wbr></wbr><span>To</span><wbr></wbr><span>Android</span><wbr></wbr><span><span>String</span></span></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="326898706%2FFunctions%2F579055962"></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 " 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><a href="recurrence-sets-to-android-string.html"><span class="token function">recurrenceSetsToAndroidString</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dates<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><span data-unresolved-link="net.fortuna.ical4j.model.property/DateListProperty///PointingToDeclaration/">DateListProperty</span><span class="token operator">></span><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></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Concatenates, if necessary, multiple RDATE/EXDATE lists and converts them to a formatted string which Android calendar provider can process.</p></div></div></div> + </div> + </div> + </div> + </div> +<a data-name="-1473137336%2FFunctions%2F579055962" anchor-label="recurrenceSetsToOpenTasksString" id="-1473137336%2FFunctions%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="recurrence-sets-to-open-tasks-string.html"><span>recurrence</span><wbr></wbr><span>Sets</span><wbr></wbr><span>To</span><wbr></wbr><span>Open</span><wbr></wbr><span>Tasks</span><wbr></wbr><span><span>String</span></span></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1473137336%2FFunctions%2F579055962"></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 " 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><a href="recurrence-sets-to-open-tasks-string.html"><span class="token function">recurrenceSetsToOpenTasksString</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dates<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><span data-unresolved-link="net.fortuna.ical4j.model.property/DateListProperty///PointingToDeclaration/">DateListProperty</span><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">tz<span class="token operator">: </span><span data-unresolved-link="net.fortuna.ical4j.model/TimeZone///PointingToDeclaration/">TimeZone</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Concatenates, if necessary, multiple RDATE/EXDATE lists and converts them to a formatted string which OpenTasks can process. OpenTasks expect a list of RFC 5545 DATE ("yyyymmdd") or DATE-TIME ("yyyymmddZ") values, where the time zone is stored in a separate field.</p></div></div></div> + </div> + </div> + </div> + </div> +<a data-name="1981924240%2FFunctions%2F579055962" anchor-label="storageTzId" id="1981924240%2FFunctions%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="storage-tz-id.html"><span>storage</span><wbr></wbr><span>Tz</span><wbr></wbr><span><span>Id</span></span></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1981924240%2FFunctions%2F579055962"></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 " 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><a href="storage-tz-id.html"><span class="token function">storageTzId</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><span data-unresolved-link="net.fortuna.ical4j.model.property/DateProperty///PointingToDeclaration/">DateProperty</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Returns the time-zone ID for a given date or date-time that should be used to store it in the Android calendar provider.</p></div></div></div> + </div> + </div> + </div> + </div> + </div> + <h2 class="">Properties</h2> + <div class="table" data-togglable="Properties"><a data-name="-1121914783%2FProperties%2F579055962" anchor-label="RECURRENCE_RULE_SEPARATOR" id="-1121914783%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="-r-e-c-u-r-r-e-n-c-e_-r-u-l-e_-s-e-p-a-r-a-t-o-r.html"><span><span>RECURRENCE_RULE_SEPARATOR</span></span></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1121914783%2FProperties%2F579055962"></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 " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-1121914783%2FProperties%2F579055962" anchor-label="RECURRENCE_RULE_SEPARATOR" id="-1121914783%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-r-e-c-u-r-r-e-n-c-e_-r-u-l-e_-s-e-p-a-r-a-t-o-r.html">RECURRENCE_RULE_SEPARATOR</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-1121914783%2FProperties%2F579055962" anchor-label="RECURRENCE_RULE_SEPARATOR" id="-1121914783%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Used to separate multiple RRULEs/EXRULEs in the RRULE/EXRULE storage field.</p></div></div></div> + </div> + </div> + </div> + </div> +<a data-name="-1735130599%2FProperties%2F579055962" anchor-label="TZID_ALLDAY" id="-1735130599%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a> + <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="-t-z-i-d_-a-l-l-d-a-y.html"><span><span>TZID_ALLDAY</span></span></a></div> +<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1735130599%2FProperties%2F579055962"></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 " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-1735130599%2FProperties%2F579055962" anchor-label="TZID_ALLDAY" id="-1735130599%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-t-z-i-d_-a-l-l-d-a-y.html">TZID_ALLDAY</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-1735130599%2FProperties%2F579055962" anchor-label="TZID_ALLDAY" id="-1735130599%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Timezone ID to store for all-day events, according to CalendarContract.Events SDK documentation.</p></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>© 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> |