Waifuvault 1.1.6

There is a newer version of this package available.
See the version list below for details.
dotnet add package Waifuvault --version 1.1.6                
NuGet\Install-Package Waifuvault -Version 1.1.6                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Waifuvault" Version="1.1.6" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Waifuvault --version 1.1.6                
#r "nuget: Waifuvault, 1.1.6"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Waifuvault as a Cake Addin
#addin nuget:?package=Waifuvault&version=1.1.6

// Install Waifuvault as a Cake Tool
#tool nuget:?package=Waifuvault&version=1.1.6                

waifuvault-C#-api

This contains the official API bindings for uploading, deleting and obtaining files with waifuvault.moe. Contains a full up to date API for interacting with the service

Installation

dotnet add package Waifuvault

Usage

This API contains 4 interactions:

  1. Upload File
  2. Get File Info
  3. Delete File
  4. Get File

The package is namespaced to Waifuvault, so to import it, simply:

using Waifuvault;

Upload File

To Upload a file, use the uploadFile function. This function takes the following options as an object:

Option Type Description Required Extra info
filename string The path to the file to upload true if File File path
url string The URL of the file to target true if URL Filename with extension
buffer byte array Byte array containing file to upload true if buffer Needs filename set also
expires string A string containing a number and a unit (1d = 1day) false Valid units are m, h and d
hideFilename boolean If true, then the uploaded filename won't appear in the URL false Defaults to false
password string If set, then the uploaded file will be encrypted false
ct canceltoken An optional cancellation token that can be passed in false Standard cancellation token

Using a URL:

using Waifuvault;

var upload_file = new Waifuvault.FileUpload("https://waifuvault.moe/assets/custom/images/08.png");
var upload_resp = await Waifuvault.Api.uploadFile(upload_file);

Console.WriteLine(upload_resp.url);

Using a file path:

using Waifuvault;

var upload_file = new Waifuvault.FileUpload("../aCoolFile.png");
var upload_resp = await Waifuvault.Api.uploadFile(upload_file);

Console.WriteLine(upload_resp.url);

Using a buffer:

using Waifuvault;
using System.IO;

byte[] buffer = File.ReadAllBytes("./aCoolFile.png");
var upload_file = new Waifuvault.FileUpload(buffer,"aCoolFile.png");
var upload_resp = await Waifuvault.Api.uploadFile(upload_file);

Console.WriteLine(upload_resp.url);

Cancelable with a file:

using Waifuvault;

var cts = new CancellationTokenSource(2000);  // Auto cancel in 2s
var cancel_file = new Waifuvault.FileUpload("./largeFile.mkv");
try {
    var cancelled = await Waifuvault.Api.uploadFile(cancel_file,cts.Token);
} catch(OperationCanceledException) {
    Console.WriteLine("Cancelled upload");
}

Get File Info

If you have a token from your upload. Then you can get file info. This results in the following info:

  • token
  • url
  • protected
  • retentionPeriod

Use the fileInfo function. This function takes the following options as parameters:

Option Type Description Required Extra info
token string The token of the upload true
formatted boolean If you want the retentionPeriod to be human-readable or an epoch false defaults to false
ct canceltoken An optional cancellation token that can be passed in false Standard cancellation token

Epoch timestamp:

using Waifuvault;
var token_info = await Waifuvault.Api.fileInfo(upload_resp.token,false);
Console.WriteLine(token_info.url);
Console.WriteLine(token_info.retentionPeriod);

Human-readable timestamp:

using Waifuvault;
var token_info = await Waifuvault.Api.fileInfo(upload_resp.token,true);
Console.WriteLine(token_info.url);
Console.WriteLine(token_info.retentionPeriod);

Delete File

To delete a file, you must supply your token to the deletefile function.

This function takes the following options as parameters:

Option Type Description Required Extra info
token string The token of the file you wish to delete true
ct canceltoken An optional cancellation token that can be passed in false Standard cancellation token

Standard delete:

using Waifuvault;
var deleted = await Waifuvault.Api.deleteFile(token);
Console.WriteLine(deleted);

Get File

This lib also supports obtaining a file from the API as a Buffer by supplying either the token or the unique identifier of the file (epoch/filename).

Use the getFile function. This function takes the following options an object:

Option Type Description Required Extra info
token string The token of the file you want to download true only if filename is not set if filename is set, then this can not be used
url string The URL of the file true only if token is not set if token is set, then this can not be used
password string The password for the file true if file is encrypted Passed as a parameter on the function call
ct canceltoken An optional cancellation token that can be passed in false Standard cancellation token

Important! The Unique identifier filename is the epoch/filename only if the file uploaded did not have a hidden filename, if it did, then it's just the epoch. For example: 1710111505084/08.png is the Unique identifier for a standard upload of a file called 08.png, if this was uploaded with hidden filename, then it would be 1710111505084.png

Obtain an encrypted file

using Waifuvault;
var file = new FileResponse(token:your_token);
var downloaded = await Waifuvault.Api.getFile(file,"password");
Console.WriteLine(downloaded.Length);

Obtain a file from URL

using Waifuvault;
var file = new FileResponse(url:your_url);
var downloaded = await Waifuvault.Api.getFile(file);
Console.WriteLine(downloaded.Length);

Obtain file with ability to cancel:

using Waifuvault;
var cts = new CancellationTokenSource(2000);  // Auto cancel in 2s
var file = new FileResponse(token:your_token);
try {
    var cancelled = await Waifuvault.Api.getFile(file, cts.Token);
} catch(OperationCanceledException) {
    Console.WriteLine("Canceled download");
}
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net7.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.7 131 9/11/2024
1.3.6 109 8/26/2024
1.3.5 113 8/20/2024
1.3.4 104 5/17/2024
1.3.3 82 5/13/2024
1.3.2 118 4/22/2024
1.3.1 119 4/20/2024
1.3.0 118 4/3/2024
1.2.9 115 4/3/2024
1.2.8 99 4/2/2024
1.2.7 107 4/2/2024
1.2.6 112 3/27/2024
1.2.5 101 3/27/2024
1.2.4 112 3/21/2024
1.2.3 115 3/20/2024
1.2.2 101 3/20/2024
1.2.1 101 3/20/2024
1.2.0 115 3/20/2024
1.1.9 113 3/20/2024
1.1.8 117 3/18/2024
1.1.7 112 3/17/2024
1.1.6 123 3/17/2024
1.1.5 107 3/17/2024
1.1.4 124 3/17/2024
1.1.3 124 3/16/2024
1.1.2 110 3/16/2024
1.1.1 123 3/16/2024
1.1.0 136 3/15/2024
1.0.9 117 3/15/2024
1.0.8 103 3/14/2024
1.0.7 144 3/14/2024
1.0.6 132 3/12/2024
1.0.5 127 3/12/2024
1.0.4 120 3/12/2024
1.0.3 124 3/12/2024
1.0.2 138 3/12/2024
1.0.1 132 3/12/2024
1.0.0 128 3/12/2024