Web3S_Demo > Web 3S Ipns Download File Async Task > IPNS Download File

IPNS Download File

Downloads a file from the IPFS network for the specified IPNS name.

Inputs

In
Exec

Ipfs Http Gateway
Web 3S Ipfs Http Gateway Config Structure

The gateway to send the request to.

Ipns Name
String

The IPNS name.

Write to Filepath
String

The filepath where the downloaded data is written to.

Create Path if Missing
Boolean

Creates the filepath to where the downloaded data should be written to if it is missing.

Overwrite Existing File
Boolean

If set to false and the file exists this function will abort with failure. Otherwise, an existing file will be overwritten.

Request Name
Name

Optional unique name for the HTTP Request Subsystem.

Outputs

Out
Exec

Started
Exec

Progress
Exec

Completed
Exec

Request
Web 3S Ipns Http Download Request Object Reference

Bytes Received
Integer64

Response Size
Integer64

Success
Boolean

Error Message
String

Response
Web 3S Http Response Structure (by ref)