Skip to content

Commit 89b8865

Browse files
yukiwwwangMinTate
authored andcommitted
update call api doc
1 parent 59b0d3e commit 89b8865

File tree

45 files changed

+67
-36
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+67
-36
lines changed
0 Bytes
Binary file not shown.

docs/-atomic-x -core -a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-state/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<div class="breadcrumbs"><a href="../../../index.html">AtomicX Core API</a><span class="delimiter">/</span><a href="../index.html">io.trtc.tuikit.atomicxcore.api.barrage</a><span class="delimiter">/</span><span class="current">BarrageState</span></div>
5959
<div class="cover ">
6060
<h1 class="cover"><span>Barrage</span><wbr></wbr><span><span>State</span></span></h1>
61-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BarrageState</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>messageList<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">allowSendMessage<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Barrage state, managing the barrage data state of the current room.</p><h2 class=""> Overview</h2><p class="paragraph">Contains the barrage message list of the current room, supports real-time updates.</p><h3 class=""> State Property Overview</h3><table><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td>Property</td><td>Type</td><td>Description</td></tr><tr><td><a href="message-list.html">messageList</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">StateFlow&lt;List&lt;Barrage&gt;&gt;</code></td><td>Barrage message list of the current room</td></tr></tbody></table><blockquote class="quotation"><p class="paragraph"><strong>Tip</strong>: Subscribe to barrageState to receive real-time updates of barrage data in the room.</p></blockquote></div></div>
61+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BarrageState</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>messageList<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">allowSendMessage<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Barrage state, managing the barrage data state of the current room.</p><h2 class=""> Overview</h2><p class="paragraph">Contains the barrage message list of the current room, supports real-time updates.</p><h3 class=""> State Property Overview</h3><table><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td>Property</td><td>Type</td><td>Description</td></tr><tr><td><a href="message-list.html">messageList</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">StateFlow&lt;List&lt;Barrage&gt;&gt;</code></td><td>Barrage message list of the current room</td></tr></tbody></table><blockquote class="quotation"><p class="paragraph"><strong>Tip</strong>: Subscribe to barrageState to receive real-time updates of barrage data in the room.</p></blockquote></div></div>
6262
</div>
6363
<div class="tabbedcontent">
6464
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

docs/-atomic-x -core -a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<div class="breadcrumbs"><a href="../../../index.html">AtomicX Core API</a><span class="delimiter">/</span><a href="../index.html">io.trtc.tuikit.atomicxcore.api.barrage</a><span class="delimiter">/</span><span class="current">Barrage</span></div>
5959
<div class="cover ">
6060
<h1 class="cover"><span><span>Barrage</span></span></h1>
61-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">Barrage</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </span>liveID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>sender<span class="token operator">: </span><a href="../../io.trtc.tuikit.atomicxcore.api.live/-live-user-info/index.html">LiveUserInfo</a><span class="token operator"> = </span>LiveUserInfo()<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>sequence<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span><span class="token constant">0</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>timestampInSecond<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span><span class="token constant">0</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>messageType<span class="token operator">: </span><a href="../-barrage-type/index.html">BarrageType</a><span class="token operator"> = </span>BarrageType.TEXT<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>textContent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>extensionInfo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token operator"> = </span>emptyMap()<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>businessID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>data<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Barrage data model, containing complete attribute information of a single barrage.</p><h2 class=""> Overview</h2><p class="paragraph">Contains complete information about the barrage sender, content, type, etc.</p><h3 class=""> Property Overview</h3><table><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td>Property</td><td>Type</td><td>Description</td></tr><tr><td><a href="live-i-d.html">liveID</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">String</code></td><td>Unique identifier ID of the live room/voice chat room the barrage belongs to</td></tr><tr><td><a href="sender.html">sender</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">LiveUserInfo</code></td><td>User information of the barrage sender</td></tr><tr><td><a href="sequence.html">sequence</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">Long</code></td><td>Unique sequence ID of the barrage message</td></tr><tr><td><a href="timestamp-in-second.html">timestampInSecond</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">Long</code></td><td>Barrage sending timestamp (unit: seconds)</td></tr><tr><td><a href="message-type.html">messageType</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">BarrageType</code></td><td>Barrage message type (text or custom)</td></tr><tr><td><a href="text-content.html">textContent</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">String</code></td><td>Message content of text type barrage</td></tr><tr><td><a href="extension-info.html">extensionInfo</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">Map&lt;String, String&gt;</code></td><td>Barrage extension information</td></tr><tr><td><a href="business-i-d.html">businessID</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">String</code></td><td>Business identifier ID of custom type barrage</td></tr><tr><td><a href="data.html">data</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@2a3f362b lang-kotlin">String</code></td><td>Specific data content of custom type barrage</td></tr></tbody></table></div></div>
61+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">Barrage</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </span>liveID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>sender<span class="token operator">: </span><a href="../../io.trtc.tuikit.atomicxcore.api.live/-live-user-info/index.html">LiveUserInfo</a><span class="token operator"> = </span>LiveUserInfo()<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>sequence<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span><span class="token constant">0</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>timestampInSecond<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span><span class="token constant">0</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>messageType<span class="token operator">: </span><a href="../-barrage-type/index.html">BarrageType</a><span class="token operator"> = </span>BarrageType.TEXT<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>textContent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>extensionInfo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token operator"> = </span>emptyMap()<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>businessID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>data<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Barrage data model, containing complete attribute information of a single barrage.</p><h2 class=""> Overview</h2><p class="paragraph">Contains complete information about the barrage sender, content, type, etc.</p><h3 class=""> Property Overview</h3><table><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td>Property</td><td>Type</td><td>Description</td></tr><tr><td><a href="live-i-d.html">liveID</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">String</code></td><td>Unique identifier ID of the live room/voice chat room the barrage belongs to</td></tr><tr><td><a href="sender.html">sender</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">LiveUserInfo</code></td><td>User information of the barrage sender</td></tr><tr><td><a href="sequence.html">sequence</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">Long</code></td><td>Unique sequence ID of the barrage message</td></tr><tr><td><a href="timestamp-in-second.html">timestampInSecond</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">Long</code></td><td>Barrage sending timestamp (unit: seconds)</td></tr><tr><td><a href="message-type.html">messageType</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">BarrageType</code></td><td>Barrage message type (text or custom)</td></tr><tr><td><a href="text-content.html">textContent</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">String</code></td><td>Message content of text type barrage</td></tr><tr><td><a href="extension-info.html">extensionInfo</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">Map&lt;String, String&gt;</code></td><td>Barrage extension information</td></tr><tr><td><a href="business-i-d.html">businessID</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">String</code></td><td>Business identifier ID of custom type barrage</td></tr><tr><td><a href="data.html">data</a></td><td><code class="org.jetbrains.dokka.pages.commenttable@3a9eb074 lang-kotlin">String</code></td><td>Specific data content of custom type barrage</td></tr></tbody></table></div></div>
6262
</div>
6363
<div class="tabbedcontent">
6464
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Binary file not shown.

0 commit comments

Comments
 (0)