169 lines
19 KiB
HTML
169 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>PermalinkService</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>matrix-sdk-android</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="matrix-sdk-android::org.matrix.android.sdk.api.session.permalinks/PermalinkService///PointingToDeclaration//468305090">
|
|
<div class="breadcrumbs"><a href="../../../index.html">matrix-sdk-android</a><span class="delimiter">/</span><a href="../index.html">org.matrix.android.sdk.api.session.permalinks</a><span class="delimiter">/</span><span class="current">PermalinkService</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Permalink</span><wbr></wbr><span><span>Service</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">PermalinkService</a></div><p class="paragraph">Useful methods to create permalink (like matrix.to links or client permalinks). See <a href="../../org.matrix.android.sdk.api/-matrix-configuration/client-permalink-base-url.html">org.matrix.android.sdk.api.MatrixConfiguration.clientPermalinkBaseUrl</a> to setup a custom permalink base url.</p></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Types</h2>
|
|
<div class="table" data-togglable="Types"><a data-name="-696867420%2FClasslikes%2F468305090" anchor-label="Companion" id="-696867420%2FClasslikes%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
|
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-696867420%2FClasslikes%2F468305090"></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=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-8524076%2FClasslikes%2F468305090" anchor-label="SpanTemplateType" id="-8524076%2FClasslikes%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
|
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-span-template-type/index.html"><span>Span</span><wbr></wbr><span>Template</span><wbr></wbr><span><span>Type</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-8524076%2FClasslikes%2F468305090"></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=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">enum </span><a href="-span-template-type/index.html">SpanTemplateType</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a><span class="token operator"><</span><span class="token keyword"></span><a href="-span-template-type/index.html">PermalinkService.SpanTemplateType</a><span class="token operator">> </span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="-1042536597%2FFunctions%2F468305090" anchor-label="createMentionSpanTemplate" id="-1042536597%2FFunctions%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
|
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="create-mention-span-template.html"><span>create</span><wbr></wbr><span>Mention</span><wbr></wbr><span>Span</span><wbr></wbr><span><span>Template</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1042536597%2FFunctions%2F468305090"></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=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-mention-span-template.html"><span class="token function">createMentionSpanTemplate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><a href="-span-template-type/index.html">PermalinkService.SpanTemplateType</a><span class="token punctuation">, </span></span><span class="parameter ">forceMatrixTo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</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">Creates a HTML or Markdown mention span template. Can be used to replace a mention with a permalink to mentioned user. Ex: "%2\$s" or "<a href="https://matrix.to/#/%1\$s">%2\$s</a>"</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-704313865%2FFunctions%2F468305090" anchor-label="createPermalink" id="-704313865%2FFunctions%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
|
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="create-permalink.html"><span>create</span><wbr></wbr><span><span>Permalink</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-704313865%2FFunctions%2F468305090"></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=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-permalink.html"><span class="token function">createPermalink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<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 ">forceMatrixTo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</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><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Creates a permalink for an id (can be a user Id, etc.). For a roomId, consider using <a href="create-room-permalink.html">createRoomPermalink</a> Ex: "https://matrix.to/#/@benoit:matrix.org"</p></div><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-permalink.html"><span class="token function">createPermalink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">event<span class="token operator">: </span><a href="../../org.matrix.android.sdk.api.session.events.model/-event/index.html">Event</a><span class="token punctuation">, </span></span><span class="parameter ">forceMatrixTo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</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><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Creates a permalink for an event. Ex: "https://matrix.to/#/!nbzmcXAqpxBXjAdgoX:matrix.org/$1531497316352799BevdV:matrix.org"</p></div><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-permalink.html"><span class="token function">createPermalink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">roomId<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 ">eventId<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 ">forceMatrixTo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</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">Creates a permalink for an event. If you have an event you can use <a href="create-permalink.html">createPermalink</a> Ex: "https://matrix.to/#/!nbzmcXAqpxBXjAdgoX:matrix.org/$1531497316352799BevdV:matrix.org?via=matrix.org"</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1922871441%2FFunctions%2F468305090" anchor-label="createRoomPermalink" id="-1922871441%2FFunctions%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
|
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="create-room-permalink.html"><span>create</span><wbr></wbr><span>Room</span><wbr></wbr><span><span>Permalink</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1922871441%2FFunctions%2F468305090"></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=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-room-permalink.html"><span class="token function">createRoomPermalink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">roomId<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 ">viaServers<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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">forceMatrixTo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</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><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Creates a permalink for a roomId, including the via parameters.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1600964911%2FFunctions%2F468305090" anchor-label="getLinkedId" id="-1600964911%2FFunctions%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
|
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="get-linked-id.html"><span>get</span><wbr></wbr><span>Linked</span><wbr></wbr><span><span>Id</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1600964911%2FFunctions%2F468305090"></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=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-linked-id.html"><span class="token function">getLinkedId</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></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><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Extract the linked id from the universal link.</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>© 2023 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>
|