This commit is contained in:
Jack Robison 2017-11-28 13:12:57 -05:00
parent e3e8dea405
commit 986fcd1660
No known key found for this signature in database
GPG key ID: 284699E7404E3CFF

View file

@ -109,16 +109,42 @@ Returns:
(dict) Requested block (dict) Requested block
``` ```
## channel_list_mine ## channel_export
```text ```text
Get my channels Export serialized channel signing information for a given certificate claim id
Usage: Usage:
channel_list_mine channel_export (<claim_id> | --claim_id=<claim_id>)
Returns: Returns:
(list) ClaimDict (str) Serialized certificate information
```
## channel_import
```text
Import serialized channel signing information (to allow signing new claims to the channel)
Usage:
channel_import (<serialized_certificate_info> |
--serialized_certificate_info=<serialized_certificate_info>)
Returns:
(dict) Result dictionary
```
## channel_list
```text
Get certificate claim infos for channels that can be published to
Usage:
channel_list
Returns:
(list) ClaimDict, includes 'is_mine' field to indicate if the certificate claim
is in the wallet.
``` ```
## channel_new ## channel_new
@ -388,9 +414,7 @@ Delete a LBRY file
Usage: Usage:
file_delete [-f] [--delete_all] [--sd_hash=<sd_hash>] [--file_name=<file_name>] file_delete [-f] [--delete_all] [--sd_hash=<sd_hash>] [--file_name=<file_name>]
[--stream_hash=<stream_hash>] [--claim_id=<claim_id>] [--stream_hash=<stream_hash>] [--rowid=<rowid>]
[--outpoint=<outpoint>] [--rowid=<rowid>]
[--name=<name>]
Options: Options:
-f, --delete_from_download_dir : delete file from download directory, -f, --delete_from_download_dir : delete file from download directory,
@ -401,10 +425,7 @@ Options:
--sd_hash=<sd_hash> : delete by file sd hash --sd_hash=<sd_hash> : delete by file sd hash
--file_name<file_name> : delete by file name in downloads folder --file_name<file_name> : delete by file name in downloads folder
--stream_hash=<stream_hash> : delete by file stream hash --stream_hash=<stream_hash> : delete by file stream hash
--claim_id=<claim_id> : delete by file claim id
--outpoint=<outpoint> : delete by file claim outpoint
--rowid=<rowid> : delete by file row id --rowid=<rowid> : delete by file row id
--name=<name> : delete by associated name claim of file
Returns: Returns:
(bool) true if deletion was successful (bool) true if deletion was successful
@ -417,8 +438,7 @@ List files limited by optional filters
Usage: Usage:
file_list [--sd_hash=<sd_hash>] [--file_name=<file_name>] [--stream_hash=<stream_hash>] file_list [--sd_hash=<sd_hash>] [--file_name=<file_name>] [--stream_hash=<stream_hash>]
[--claim_id=<claim_id>] [--outpoint=<outpoint>] [--rowid=<rowid>] [--rowid=<rowid>]
[--name=<name>]
[-f] [-f]
Options: Options:
@ -426,10 +446,7 @@ Options:
--file_name=<file_name> : get file with matching file name in the --file_name=<file_name> : get file with matching file name in the
downloads folder downloads folder
--stream_hash=<stream_hash> : get file with matching stream hash --stream_hash=<stream_hash> : get file with matching stream hash
--claim_id=<claim_id> : get file with matching claim id
--outpoint=<outpoint> : get file with matching claim outpoint
--rowid=<rowid> : get file with matching row id --rowid=<rowid> : get file with matching row id
--name=<name> : get file with matching associated name claim
-f : full status, populate the 'message' and 'size' fields -f : full status, populate the 'message' and 'size' fields
Returns: Returns:
@ -446,16 +463,12 @@ Returns:
'stream_name': (str) stream name , 'stream_name': (str) stream name ,
'suggested_file_name': (str) suggested file name, 'suggested_file_name': (str) suggested file name,
'sd_hash': (str) sd hash of file, 'sd_hash': (str) sd hash of file,
'name': (str) name claim attached to file
'outpoint': (str) claim outpoint attached to file
'claim_id': (str) claim ID attached to file,
'download_path': (str) download path of file, 'download_path': (str) download path of file,
'mime_type': (str) mime type of file, 'mime_type': (str) mime type of file,
'key': (str) key attached to file, 'key': (str) key attached to file,
'total_bytes': (int) file size in bytes, None if full_status is false 'total_bytes': (int) file size in bytes, None if full_status is false
'written_bytes': (int) written size in bytes 'written_bytes': (int) written size in bytes
'message': (str), None if full_status is false 'message': (str), None if full_status is false
'metadata': (dict) Metadata dictionary
}, },
] ]
``` ```
@ -467,8 +480,7 @@ Reflect all the blobs in a file matching the filter criteria
Usage: Usage:
file_reflect [--sd_hash=<sd_hash>] [--file_name=<file_name>] file_reflect [--sd_hash=<sd_hash>] [--file_name=<file_name>]
[--stream_hash=<stream_hash>] [--claim_id=<claim_id>] [--stream_hash=<stream_hash>] [--rowid=<rowid>]
[--outpoint=<outpoint>] [--rowid=<rowid>] [--name=<name>]
[--reflector=<reflector>] [--reflector=<reflector>]
Options: Options:
@ -476,10 +488,7 @@ Options:
--file_name=<file_name> : get file with matching file name in the --file_name=<file_name> : get file with matching file name in the
downloads folder downloads folder
--stream_hash=<stream_hash> : get file with matching stream hash --stream_hash=<stream_hash> : get file with matching stream hash
--claim_id=<claim_id> : get file with matching claim id
--outpoint=<outpoint> : get file with matching claim outpoint
--rowid=<rowid> : get file with matching row id --rowid=<rowid> : get file with matching row id
--name=<name> : get file with matching associated name claim
--reflector=<reflector> : reflector server, ip address or url --reflector=<reflector> : reflector server, ip address or url
by default choose a server from the config by default choose a server from the config
@ -494,19 +503,14 @@ Start or stop downloading a file
Usage: Usage:
file_set_status <status> [--sd_hash=<sd_hash>] [--file_name=<file_name>] file_set_status <status> [--sd_hash=<sd_hash>] [--file_name=<file_name>]
[--stream_hash=<stream_hash>] [--claim_id=<claim_id>] [--stream_hash=<stream_hash>] [--rowid=<rowid>]
[--outpoint=<outpoint>] [--rowid=<rowid>]
[--name=<name>]
Options: Options:
--sd_hash=<sd_hash> : set status of file with matching sd hash --sd_hash=<sd_hash> : set status of file with matching sd hash
--file_name=<file_name> : set status of file with matching file name in the --file_name=<file_name> : set status of file with matching file name in the
downloads folder downloads folder
--stream_hash=<stream_hash> : set status of file with matching stream hash --stream_hash=<stream_hash> : set status of file with matching stream hash
--claim_id=<claim_id> : set status of file with matching claim id
--outpoint=<outpoint> : set status of file with matching claim outpoint
--rowid=<rowid> : set status of file with matching row id --rowid=<rowid> : set status of file with matching row id
--name=<name> : set status of file with matching associated name claim
Returns: Returns:
(str) Confirmation message (str) Confirmation message
@ -626,8 +630,9 @@ Options:
--metadata=<metadata> : ClaimDict to associate with the claim. --metadata=<metadata> : ClaimDict to associate with the claim.
--file_path=<file_path> : path to file to be associated with name. If provided, --file_path=<file_path> : path to file to be associated with name. If provided,
a lbry stream of this file will be used in 'sources'. a lbry stream of this file will be used in 'sources'.
If no path is given but a metadata dict is provided, If no path is given but a sources dict is provided,
the source from the given metadata will be used. it will be used. If neither are provided, an
error is raised.
--fee=<fee> : Dictionary representing key fee to download content: --fee=<fee> : Dictionary representing key fee to download content:
{ {
'currency': currency_symbol, 'currency': currency_symbol,