Waifuvault 1.3.1
See the version list below for details.
dotnet add package Waifuvault --version 1.3.1
NuGet\Install-Package Waifuvault -Version 1.3.1
<PackageReference Include="Waifuvault" Version="1.3.1" />
paket add Waifuvault --version 1.3.1
#r "nuget: Waifuvault, 1.3.1"
// Install Waifuvault as a Cake Addin #addin nuget:?package=Waifuvault&version=1.3.1 // Install Waifuvault as a Cake Tool #tool nuget:?package=Waifuvault&version=1.3.1
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 5 interactions:
- Upload File
- Get File Info
- Update File Info
- Delete File
- 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 |
oneTimeDownload |
boolean |
if supplied, the file will be deleted as soon as it is accessed | false |
Using a URL:
using Waifuvault;
var uploadFile = new Waifuvault.FileUpload("https://waifuvault.moe/assets/custom/images/08.png");
var uploadResp = await Waifuvault.Api.uploadFile(uploadFile);
Console.WriteLine(uploadResp.url);
Using a file path:
using Waifuvault;
var uploadFile = new Waifuvault.FileUpload("../aCoolFile.png");
var uploadResp = await Waifuvault.Api.uploadFile(uploadFile);
Console.WriteLine(uploadResp.url);
Using a buffer:
using Waifuvault;
using System.IO;
byte[] buffer = File.ReadAllBytes("./aCoolFile.png");
var uploadFile = new Waifuvault.FileUpload(buffer,"aCoolFile.png");
var uploadResp = await Waifuvault.Api.uploadFile(uploadFile);
Console.WriteLine(uploadResp.url);
Cancelable with a file:
using Waifuvault;
var cts = new CancellationTokenSource(2000); // Auto cancel in 2s
var cancelFile = new Waifuvault.FileUpload("./largeFile.mkv");
try {
var cancelled = await Waifuvault.Api.uploadFile(cancelFile,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 tokenInfo = await Waifuvault.Api.fileInfo(uploadResp.token,false);
Console.WriteLine(tokenInfo.url);
Console.WriteLine(tokenInfo.retentionPeriod);
Human-readable timestamp:
using Waifuvault;
var tokenInfo = await Waifuvault.Api.fileInfo(uploadResp.token,true);
Console.WriteLine(tokenInfo.url);
Console.WriteLine(tokenInfo.retentionPeriod);
Update File Info
If you have a token from your upload, then you can update the information for the file. You can change the password or remove it, you can set custom expiry time or remove it, and finally you can choose whether the filename is hidden.
Use the fileUpdate
function. This function takes the following options as parameters:
Option | Type | Description | Required | Extra info |
---|---|---|---|---|
token |
string |
The token of the upload | true | |
password |
string |
The current password of the file | false | Set to empty string to remove password |
previousPassword |
string |
The previous password of the file, if changing password | false | |
customExpiry |
string |
Custom expiry in the same form as upload command | false | Set to empty string to remove custom expiry |
hideFilename |
bool |
Sets whether the filename is visible in the URL or not | false |
using Waifuvault;
var updateInfo = await Waifuvault.Api.fileUpdate(uploadResp.token, customExpiry:"2d");
Console.WriteLine(updateInfo.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 called08.png
, if this was uploaded with hidden filename, then it would be1710111505084.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 | Versions 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. |
-
net7.0
- moq (>= 4.20.70)
- Xunit (>= 2.7.0)
- xunit.abstractions (>= 2.0.3)
- xunit.runner.visualstudio (>= 2.5.7)
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 | 125 | 9/11/2024 |
1.3.6 | 102 | 8/26/2024 |
1.3.5 | 112 | 8/20/2024 |
1.3.4 | 103 | 5/17/2024 |
1.3.3 | 81 | 5/13/2024 |
1.3.2 | 115 | 4/22/2024 |
1.3.1 | 118 | 4/20/2024 |
1.3.0 | 115 | 4/3/2024 |
1.2.9 | 114 | 4/3/2024 |
1.2.8 | 98 | 4/2/2024 |
1.2.7 | 104 | 4/2/2024 |
1.2.6 | 111 | 3/27/2024 |
1.2.5 | 100 | 3/27/2024 |
1.2.4 | 111 | 3/21/2024 |
1.2.3 | 114 | 3/20/2024 |
1.2.2 | 100 | 3/20/2024 |
1.2.1 | 100 | 3/20/2024 |
1.2.0 | 114 | 3/20/2024 |
1.1.9 | 112 | 3/20/2024 |
1.1.8 | 116 | 3/18/2024 |
1.1.7 | 111 | 3/17/2024 |
1.1.6 | 122 | 3/17/2024 |
1.1.5 | 106 | 3/17/2024 |
1.1.4 | 123 | 3/17/2024 |
1.1.3 | 123 | 3/16/2024 |
1.1.2 | 109 | 3/16/2024 |
1.1.1 | 122 | 3/16/2024 |
1.1.0 | 135 | 3/15/2024 |
1.0.9 | 116 | 3/15/2024 |
1.0.8 | 102 | 3/14/2024 |
1.0.7 | 141 | 3/14/2024 |
1.0.6 | 131 | 3/12/2024 |
1.0.5 | 126 | 3/12/2024 |
1.0.4 | 119 | 3/12/2024 |
1.0.3 | 123 | 3/12/2024 |
1.0.2 | 137 | 3/12/2024 |
1.0.1 | 131 | 3/12/2024 |
1.0.0 | 127 | 3/12/2024 |