forked from LBRYCommunity/lbry-sdk
docs
This commit is contained in:
parent
b75c8d96ce
commit
528f168dc1
3 changed files with 82 additions and 21 deletions
|
@ -307,6 +307,13 @@
|
||||||
blob_list
|
blob_list
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#blob_reflect" title="blob_reflect" class="md-nav__link">
|
||||||
|
blob_reflect
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
@ -709,6 +716,13 @@
|
||||||
blob_list
|
blob_list
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#blob_reflect" title="blob_reflect" class="md-nav__link">
|
||||||
|
blob_reflect
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
@ -1071,18 +1085,18 @@
|
||||||
<pre><code class="text">Announce blobs to the DHT
|
<pre><code class="text">Announce blobs to the DHT
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
blob_announce [--announce_all] [<blob_hash> | --blob_hash=<blob_hash>]
|
blob_announce [<blob_hash> | --blob_hash=<blob_hash>]
|
||||||
[<stream_hash> | --stream_hash=<stream_hash>]
|
[<stream_hash> | --stream_hash=<stream_hash>] | [<sd_hash> | --sd_hash=<sd_hash>]
|
||||||
[<sd_hash> | --sd_hash=<sd_hash>]
|
[--announce_all]
|
||||||
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--announce_all=<announce_all> : (bool) announce all the blobs possessed by user
|
--announce_all : (bool) announce all the blobs possessed by user
|
||||||
--blob_hash=<blob_hash> : (str) announce a blob, specified by blob_hash
|
--blob_hash=<blob_hash> : (str) announce a blob, specified by blob_hash
|
||||||
--stream_hash=<stream_hash> : (str) announce all blobs associated with
|
--stream_hash=<stream_hash> : (str) announce all blobs associated with
|
||||||
stream_hash
|
stream_hash
|
||||||
--sd_hash=<sd_hash> : (str) announce all blobs associated with
|
--sd_hash=<sd_hash> : (str) announce all blobs associated with
|
||||||
sd_hash and the sd_hash itself
|
sd_hash and the sd_hash itself
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(bool) true if successful
|
(bool) true if successful
|
||||||
|
@ -1172,6 +1186,20 @@ Returns:
|
||||||
(list) List of blob hashes
|
(list) List of blob hashes
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
|
<h2 id="blob_reflect">blob_reflect</h2>
|
||||||
|
<pre><code class="text">Reflects specified blobs
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
blob_reflect (<blob_hashes>...) [--reflector_server=<reflector_server>]
|
||||||
|
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--reflector_server=<reflector_server> (str) : reflector address
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
(list) reflected blob hashes
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
<h2 id="blob_reflect_all">blob_reflect_all</h2>
|
<h2 id="blob_reflect_all">blob_reflect_all</h2>
|
||||||
<pre><code class="text">Reflects all saved blobs
|
<pre><code class="text">Reflects all saved blobs
|
||||||
|
|
||||||
|
@ -1219,8 +1247,7 @@ Returns:
|
||||||
<pre><code class="text">Import serialized channel signing information (to allow signing new claims to the channel)
|
<pre><code class="text">Import serialized channel signing information (to allow signing new claims to the channel)
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
channel_import (<serialized_certificate_info> |
|
channel_import (<serialized_certificate_info> | --serialized_certificate_info=<serialized_certificate_info>)
|
||||||
--serialized_certificate_info=<serialized_certificate_info>)
|
|
||||||
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
@ -2089,7 +2116,7 @@ Options:
|
||||||
--uri=<uri> : (str) check availability for this uri
|
--uri=<uri> : (str) check availability for this uri
|
||||||
--search_timeout=<search_timeout> : (int) how long to search for peers for the blob
|
--search_timeout=<search_timeout> : (int) how long to search for peers for the blob
|
||||||
in the dht
|
in the dht
|
||||||
--search_timeout=<blob_timeout> : (int) how long to try downloading from a peer
|
--blob_timeout=<blob_timeout> : (int) how long to try downloading from a peer
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(dict) {
|
(dict) {
|
||||||
|
|
|
@ -295,6 +295,13 @@
|
||||||
blob_list
|
blob_list
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#blob_reflect" title="blob_reflect" class="md-nav__link">
|
||||||
|
blob_reflect
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
@ -709,6 +716,13 @@
|
||||||
blob_list
|
blob_list
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#blob_reflect" title="blob_reflect" class="md-nav__link">
|
||||||
|
blob_reflect
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
@ -1144,6 +1158,16 @@ Returns:
|
||||||
(list) List of blob hashes
|
(list) List of blob hashes
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
|
<h2 id="blob_reflect">blob_reflect</h2>
|
||||||
|
<pre><code class="text">Reflects specified blobs
|
||||||
|
|
||||||
|
Args:
|
||||||
|
'reflector_server' : reflector address
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
(list) reflected blob hashes
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
<h2 id="blob_reflect_all">blob_reflect_all</h2>
|
<h2 id="blob_reflect_all">blob_reflect_all</h2>
|
||||||
<pre><code class="text">Reflects all saved blobs
|
<pre><code class="text">Reflects all saved blobs
|
||||||
|
|
||||||
|
@ -1179,7 +1203,7 @@ Returns:
|
||||||
<pre><code class="text">Import serialized channel signing information (to allow signing new claims to the channel)
|
<pre><code class="text">Import serialized channel signing information (to allow signing new claims to the channel)
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
'serialized_certificate_info' : (str) certificate info
|
'serialized_certificate_info' (required) : (str) certificate info
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(dict) Result dictionary
|
(dict) Result dictionary
|
||||||
|
@ -1892,7 +1916,7 @@ Args:
|
||||||
'uri' (required) : (str) check availability for this uri
|
'uri' (required) : (str) check availability for this uri
|
||||||
'search_timeout' : (int) how long to search for peers for the blob
|
'search_timeout' : (int) how long to search for peers for the blob
|
||||||
in the dht
|
in the dht
|
||||||
'search_timeout' : (int) how long to try downloading from a peer
|
'blob_timeout' : (int) how long to try downloading from a peer
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(dict) {
|
(dict) {
|
||||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue