C# Class Ipfs.Commands.IpfsPin

Inheritance: Ipfs.Json.IpfsCommand

Mostrar archivo Open project: TrekDev/net-ipfs-api

Public Methods

Method	Description
Add ( string ipfsPath, bool recursive = false ) : Task>	Pins objects to local storage Retrieves the object named by and stores it locally on disk.
Ls ( IpfsType type = null ) : Task	List objects pinned to local storage Returns a list of hashes of objects being pinned. Objects that are indirectly or recursively pinned are not included in the list.
Rm ( string ipfsPath, bool recursive = false ) : Task	Unpin an object from local storage Removes the pin from the given object allowing it to be garbage collected if needed.

Private Methods

Method	Description
IpfsPin ( Uri commandUri, HttpClient httpClient, IJsonSerializer jsonSerializer ) : System

Method Details

Add() public method

Pins objects to local storage Retrieves the object named by and stores it locally on disk.

public Add ( string ipfsPath, bool recursive = false ) : Task>
ipfsPath	string	Path to object(s) to be pinned
recursive	bool	Recursively pin the object linked to by the specified object(s)
return	Task>

Ls() public method

List objects pinned to local storage Returns a list of hashes of objects being pinned. Objects that are indirectly or recursively pinned are not included in the list.

public Ls ( IpfsType type = null ) : Task
type	IpfsType	The type of pinned keys to list. Can be "direct", "indirect", "recursive", or "all". Defaults to "direct"
return	Task

Rm() public method

Unpin an object from local storage Removes the pin from the given object allowing it to be garbage collected if needed.

public Rm ( string ipfsPath, bool recursive = false ) : Task
ipfsPath	string	Path to object(s) to be unpinned
recursive	bool	Recursively unpin the object linked to by the specified object(s)
return	Task