add method

Future<Map<String, dynamic>> add({
  1. required String path,
  2. String? service,
  3. String? name,
  4. bool? background,
})

Pin object to remote pinning service. /api/v0/pin/remote/add

Arguments:

  • path String: Path to object(s) to be pinned.

Optional arguments:

  • service String: Name of the remote pinning service to use (mandatory).
  • name String: An optional name for the pin.
  • background bool: Add to the queue on the remote service and return immediately (does not wait for pinned status). Default: false.

Response:

{
  "Cid": "<string>",
  "Name": "<string>",
  "Status": "<string>",
  "StatusCode": "<statusCode>",
  "StatusMessage": "<statusMessage>"
}

See more: https://docs.ipfs.io/reference/http/api/#api-v0-pin-remote-add

Implementation

Future<Map<String, dynamic>> add(
    {required String path,
    String? service,
    String? name,
    bool? background}) async {
  Response? res = await _post(
    Ipfs.dio,
    url: "${Ipfs.url}/pin/remote/add",
    queryParameters: {
      "arg": path,
      if (service != null) "service": service,
      if (name != null) "name": name,
      if (background != null) "background": background,
    },
  );

  return _interceptDioResponse(res, expectsResponseBody: true);
}