Skip to content

Commit

Permalink
Update docs to reflect new changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@isaackogan
isaackogan committed Sep 19, 2024
1 parent adb5ba9 commit b3164bf
Show file tree
Hide file tree
Showing 12 changed files with 28 additions and 6 deletions.
8 changes: 8 additions & 0 deletions docs/TikTokLive.client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<p>Thrown when the requested streamer to watch is offline</p>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="TikTokLive.client.errors.WebcastBlocked200Error">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.errors.</span></span><span class="sig-name descname"><span class="pre">WebcastBlocked200Error</span></span><a class="headerlink" href="#TikTokLive.client.errors.WebcastBlocked200Error" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></p>
<p>Thrown when the webcast is blocked by TikTok with a 200 status code (detected)</p>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="TikTokLive.client.errors.WebsocketURLMissingError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.errors.</span></span><span class="sig-name descname"><span class="pre">WebsocketURLMissingError</span></span><a class="headerlink" href="#TikTokLive.client.errors.WebsocketURLMissingError" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -863,6 +870,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<li><a class="reference internal" href="#TikTokLive.client.errors.InitialCursorMissingError"><code class="docutils literal notranslate"><span class="pre">InitialCursorMissingError</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.UserNotFoundError"><code class="docutils literal notranslate"><span class="pre">UserNotFoundError</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.UserOfflineError"><code class="docutils literal notranslate"><span class="pre">UserOfflineError</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.WebcastBlocked200Error"><code class="docutils literal notranslate"><span class="pre">WebcastBlocked200Error</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.WebsocketURLMissingError"><code class="docutils literal notranslate"><span class="pre">WebsocketURLMissingError</span></code></a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/TikTokLive.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.InitialCursorMissingError"><code class="docutils literal notranslate"><span class="pre">InitialCursorMissingError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.UserNotFoundError"><code class="docutils literal notranslate"><span class="pre">UserNotFoundError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.UserOfflineError"><code class="docutils literal notranslate"><span class="pre">UserOfflineError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.WebcastBlocked200Error"><code class="docutils literal notranslate"><span class="pre">WebcastBlocked200Error</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.WebsocketURLMissingError"><code class="docutils literal notranslate"><span class="pre">WebsocketURLMissingError</span></code></a></li>
</ul>
</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4820,6 +4820,8 @@ <h2>W</h2>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastBarrageMessageBarrageTypeSubscribeGiftParam">WebcastBarrageMessageBarrageTypeSubscribeGiftParam (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastBarrageMessageBarrageTypeUserGradeParam">WebcastBarrageMessageBarrageTypeUserGradeParam (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.client.html#TikTokLive.client.errors.WebcastBlocked200Error">WebcastBlocked200Error</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastCaptionMessage">WebcastCaptionMessage (class in TikTokLive.proto.tiktok_proto)</a>
</li>
Expand Down Expand Up @@ -4894,11 +4896,11 @@ <h2>W</h2>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTeamData">WebcastLinkMicBattleLinkMicBattleTeamData (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewers">WebcastLinkMicBattleLinkMicBattleTopViewers (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup">WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup (class in TikTokLive.proto.tiktok_proto)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup">WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroupTopViewer">WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroupTopViewer (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattlePunishFinish">WebcastLinkMicBattlePunishFinish (class in TikTokLive.proto.tiktok_proto)</a>
Expand Down
Binary file modified docs/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

Binary file modified scripts/docs/_build/doctrees/TikTokLive.client.doctree
View file
Binary file not shown.
Binary file modified scripts/docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
8 changes: 8 additions & 0 deletions scripts/docs/_build/html/TikTokLive.client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<p>Thrown when the requested streamer to watch is offline</p>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="TikTokLive.client.errors.WebcastBlocked200Error">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.errors.</span></span><span class="sig-name descname"><span class="pre">WebcastBlocked200Error</span></span><a class="headerlink" href="#TikTokLive.client.errors.WebcastBlocked200Error" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></p>
<p>Thrown when the webcast is blocked by TikTok with a 200 status code (detected)</p>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="TikTokLive.client.errors.WebsocketURLMissingError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.errors.</span></span><span class="sig-name descname"><span class="pre">WebsocketURLMissingError</span></span><a class="headerlink" href="#TikTokLive.client.errors.WebsocketURLMissingError" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -863,6 +870,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<li><a class="reference internal" href="#TikTokLive.client.errors.InitialCursorMissingError"><code class="docutils literal notranslate"><span class="pre">InitialCursorMissingError</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.UserNotFoundError"><code class="docutils literal notranslate"><span class="pre">UserNotFoundError</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.UserOfflineError"><code class="docutils literal notranslate"><span class="pre">UserOfflineError</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.WebcastBlocked200Error"><code class="docutils literal notranslate"><span class="pre">WebcastBlocked200Error</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.errors.WebsocketURLMissingError"><code class="docutils literal notranslate"><span class="pre">WebsocketURLMissingError</span></code></a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions scripts/docs/_build/html/TikTokLive.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.InitialCursorMissingError"><code class="docutils literal notranslate"><span class="pre">InitialCursorMissingError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.UserNotFoundError"><code class="docutils literal notranslate"><span class="pre">UserNotFoundError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.UserOfflineError"><code class="docutils literal notranslate"><span class="pre">UserOfflineError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.WebcastBlocked200Error"><code class="docutils literal notranslate"><span class="pre">WebcastBlocked200Error</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.errors.WebsocketURLMissingError"><code class="docutils literal notranslate"><span class="pre">WebsocketURLMissingError</span></code></a></li>
</ul>
</li>
Expand Down
6 changes: 4 additions & 2 deletions scripts/docs/_build/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4820,6 +4820,8 @@ <h2>W</h2>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastBarrageMessageBarrageTypeSubscribeGiftParam">WebcastBarrageMessageBarrageTypeSubscribeGiftParam (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastBarrageMessageBarrageTypeUserGradeParam">WebcastBarrageMessageBarrageTypeUserGradeParam (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.client.html#TikTokLive.client.errors.WebcastBlocked200Error">WebcastBlocked200Error</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastCaptionMessage">WebcastCaptionMessage (class in TikTokLive.proto.tiktok_proto)</a>
</li>
Expand Down Expand Up @@ -4894,11 +4896,11 @@ <h2>W</h2>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTeamData">WebcastLinkMicBattleLinkMicBattleTeamData (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewers">WebcastLinkMicBattleLinkMicBattleTopViewers (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup">WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup (class in TikTokLive.proto.tiktok_proto)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup">WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroup (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroupTopViewer">WebcastLinkMicBattleLinkMicBattleTopViewersTopViewerGroupTopViewer (class in TikTokLive.proto.tiktok_proto)</a>
</li>
<li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMicBattlePunishFinish">WebcastLinkMicBattlePunishFinish (class in TikTokLive.proto.tiktok_proto)</a>
Expand Down
Binary file modified scripts/docs/_build/html/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion scripts/docs/_build/html/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit b3164bf

Please sign in to comment.