A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://richardschneider.github.io/net-ipfs-http-client/api/Ipfs.Http.IpfsClient.html below:

Class IpfsClient

A client that allows access to the InterPlanetary File System (IPFS).

Namespace: Ipfs.Http Assembly: Ipfs.Http.Client.dll Syntax
public class IpfsClient : IGenericApi, ICoreApi
Constructors | Improve this Doc View Source IpfsClient()

Creates a new instance of the IpfsClient class and sets the default values.

Declaration | Improve this Doc View Source IpfsClient(String)

Creates a new instance of the IpfsClient class and specifies the ApiUri. default values

Declaration
public IpfsClient(string host)
Parameters Type Name Description String host

The URL of the API host. For example "http://localhost:5001" or "http://ipv4.fiddler:5001".

Fields | Improve this Doc View Source DefaultApiUri

The default URL to the IPFS HTTP API server.

Declaration
public static Uri DefaultApiUri
Field Value Type Description Uri

The default is "http://localhost:5001".

Properties | Improve this Doc View Source ApiUri

The URL to the IPFS API server. The default is "http://localhost:5001".

Declaration
public Uri ApiUri { get; set; }
Property Value | Improve this Doc View Source Bitswap Declaration
public IBitswapApi Bitswap { get; }
Property Value | Improve this Doc View Source Block Declaration
public IBlockApi Block { get; }
Property Value | Improve this Doc View Source BlockRepository Declaration
public IBlockRepositoryApi BlockRepository { get; }
Property Value | Improve this Doc View Source Bootstrap Declaration
public IBootstrapApi Bootstrap { get; }
Property Value | Improve this Doc View Source Config Declaration
public IConfigApi Config { get; }
Property Value | Improve this Doc View Source Dag Declaration
public IDagApi Dag { get; }
Property Value | Improve this Doc View Source Dht Declaration
public IDhtApi Dht { get; }
Property Value | Improve this Doc View Source Dns Declaration
public IDnsApi Dns { get; }
Property Value | Improve this Doc View Source FileSystem Declaration
public IFileSystemApi FileSystem { get; }
Property Value | Improve this Doc View Source Generic Declaration
public IGenericApi Generic { get; }
Property Value | Improve this Doc View Source Key Declaration
public IKeyApi Key { get; }
Property Value | Improve this Doc View Source Name Declaration
public INameApi Name { get; }
Property Value | Improve this Doc View Source Object Declaration
public IObjectApi Object { get; }
Property Value | Improve this Doc View Source Pin Declaration
public IPinApi Pin { get; }
Property Value | Improve this Doc View Source PubSub Declaration
public IPubSubApi PubSub { get; }
Property Value | Improve this Doc View Source Stats Declaration
public IStatsApi Stats { get; }
Property Value | Improve this Doc View Source Swarm Declaration
public ISwarmApi Swarm { get; }
Property Value | Improve this Doc View Source TrustedPeers

The list of peers that are initially trusted by IPFS.

Declaration
public TrustedPeerCollection TrustedPeers { get; }
Property Value | Improve this Doc View Source UserAgent

The value of HTTP User-Agent header sent to the API server.

Declaration
public string UserAgent { get; set; }
Property Value Type Description String

The default value is "net-ipfs/M.N", where M is the major and N is minor version numbers of the assembly.

Methods | Improve this Doc View Source DoCommandAsync(String, CancellationToken, String, String[])

Perform an IPFS API command returning a string.

Declaration
public Task<string> DoCommandAsync(string command, CancellationToken cancel, string arg = null, params string[] options)
Parameters Returns Type Description Task<String>

A string representation of the command's result.

Exceptions | Improve this Doc View Source DoCommandAsync<T>(String, CancellationToken, String, String[])

Perform an IPFS API command returning a specific Type.

Declaration
public Task<T> DoCommandAsync<T>(string command, CancellationToken cancel, string arg = null, params string[] options)
Parameters Returns Type Description Task<T>

A T.

Type Parameters Name Description T

The Type of object to return.

Remarks Exceptions | Improve this Doc View Source DownloadAsync(String, CancellationToken, String, String[])

Perform an IPFS API command returning a Stream.

Declaration
public Task<Stream> DownloadAsync(string command, CancellationToken cancel, string arg = null, params string[] options)
Parameters Returns Exceptions | Improve this Doc View Source DownloadBytesAsync(String, CancellationToken, String, String[])

Perform an IPFS API command returning a a byte array.

Declaration
public Task<byte[]> DownloadBytesAsync(string command, CancellationToken cancel, string arg = null, params string[] options)
Parameters Returns Type Description Task<Byte[]>

A byte array containing the command's result.

Exceptions | Improve this Doc View Source IdAsync(MultiHash, CancellationToken) Declaration
public Task<Peer> IdAsync(MultiHash peer = null, CancellationToken cancel = default(CancellationToken))
Parameters Returns | Improve this Doc View Source PingAsync(MultiAddress, Int32, CancellationToken) Declaration
public Task<IEnumerable<PingResult>> PingAsync(MultiAddress address, int count = 10, CancellationToken cancel = default(CancellationToken))
Parameters Returns | Improve this Doc View Source PingAsync(MultiHash, Int32, CancellationToken) Declaration
public Task<IEnumerable<PingResult>> PingAsync(MultiHash peer, int count = 10, CancellationToken cancel = default(CancellationToken))
Parameters Returns | Improve this Doc View Source PostDownloadAsync(String, CancellationToken, String, String[])

Post an IPFS API command returning a stream.

Declaration
public Task<Stream> PostDownloadAsync(string command, CancellationToken cancel, string arg = null, params string[] options)
Parameters Returns Exceptions | Improve this Doc View Source ResolveAsync(String, Boolean, CancellationToken) Declaration
public Task<string> ResolveAsync(string name, bool recursive = true, CancellationToken cancel = default(CancellationToken))
Parameters Returns | Improve this Doc View Source ShutdownAsync() Declaration
public Task ShutdownAsync()
Returns | Improve this Doc View Source Upload2Async(String, CancellationToken, Stream, String, String[])

Perform an IPFS API command that requires uploading of a "file".

Declaration
public Task<Stream> Upload2Async(string command, CancellationToken cancel, Stream data, string name, params string[] options)
Parameters Returns Type Description Task<Stream>

A task that represents the asynchronous operation. The task's value is the HTTP response as a Stream.

Exceptions | Improve this Doc View Source UploadAsync(String, CancellationToken, Byte[], String[])

TODO

Declaration
public Task<string> UploadAsync(string command, CancellationToken cancel, byte[] data, params string[] options)
Parameters Returns | Improve this Doc View Source UploadAsync(String, CancellationToken, Stream, String, String[])

Perform an IPFS API command that requires uploading of a "file".

Declaration
public Task<string> UploadAsync(string command, CancellationToken cancel, Stream data, string name, params string[] options)
Parameters Returns Type Description Task<String>

A task that represents the asynchronous operation. The task's value is the HTTP response as a string.

Exceptions | Improve this Doc View Source VersionAsync(CancellationToken) Declaration
public Task<Dictionary<string, string>> VersionAsync(CancellationToken cancel = default(CancellationToken))
Parameters Returns Implements See Also

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4