Interface IStorageFileApi<TFileObject>

Namespace

Supabase.Storage.Interfaces

Assembly

Supabase.Storage.dll

public interface IStorageFileApi<TFileObject> where TFileObject : FileObject

Type Parameters

TFileObject

Properties

Options

ClientOptions Options { get; }

Property Value

ClientOptions

Methods

Copy(string, string, DestinationOptions?)

Task<bool> Copy(string fromPath, string toPath, DestinationOptions? options = null)

Parameters

fromPath string

toPath string

options DestinationOptions

Returns

Task<bool>

CreateSignedUrl(string, int, TransformOptions?, DownloadOptions?)

Task<string> CreateSignedUrl(string path, int expiresIn, TransformOptions? transformOptions = null, DownloadOptions? options = null)

Parameters

path string

expiresIn int

transformOptions TransformOptions

options DownloadOptions

Returns

Task<string>

CreateSignedUrls(List<string>, int, DownloadOptions?)

Task<List<CreateSignedUrlsResponse>?> CreateSignedUrls(List<string> paths, int expiresIn, DownloadOptions? options = null)

Parameters

paths List<string>

expiresIn int

options DownloadOptions

Returns

Task<List<CreateSignedUrlsResponse>>

CreateUploadSignedUrl(string)

Task<UploadSignedUrl> CreateUploadSignedUrl(string supabasePath)

Parameters

supabasePath string

Returns

Task<UploadSignedUrl>

Download(string, TransformOptions?, EventHandler<float>?, CancellationToken, string?)

Task<byte[]> Download(string supabasePath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default, string? cacheNonce = null)

Parameters

supabasePath string

transformOptions TransformOptions

onProgress EventHandler<float>

cancellationToken CancellationToken

cacheNonce string

Returns

Task<byte[]>

Download(string, EventHandler<float>?, CancellationToken, string?)

Task<byte[]> Download(string supabasePath, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default, string? cacheNonce = null)

Parameters

supabasePath string

onProgress EventHandler<float>

cancellationToken CancellationToken

cacheNonce string

Returns

Task<byte[]>

Download(string, string, TransformOptions?, EventHandler<float>?, CancellationToken, string?)

Task<string> Download(string supabasePath, string localPath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default, string? cacheNonce = null)

Parameters

supabasePath string

localPath string

transformOptions TransformOptions

onProgress EventHandler<float>

cancellationToken CancellationToken

cacheNonce string

Returns

Task<string>

Download(string, string, EventHandler<float>?, CancellationToken, string?)

Task<string> Download(string supabasePath, string localPath, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default, string? cacheNonce = null)

Parameters

supabasePath string

localPath string

onProgress EventHandler<float>

cancellationToken CancellationToken

cacheNonce string

Returns

Task<string>

DownloadPublicFile(string, TransformOptions?, EventHandler<float>?, CancellationToken, string?)

Task<byte[]> DownloadPublicFile(string supabasePath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default, string? cacheNonce = null)

Parameters

supabasePath string

transformOptions TransformOptions

onProgress EventHandler<float>

cancellationToken CancellationToken

cacheNonce string

Returns

Task<byte[]>

DownloadPublicFile(string, string, TransformOptions?, EventHandler<float>?, CancellationToken, string?)

Task<string> DownloadPublicFile(string supabasePath, string localPath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default, string? cacheNonce = null)

Parameters

supabasePath string

localPath string

transformOptions TransformOptions

onProgress EventHandler<float>

cancellationToken CancellationToken

cacheNonce string

Returns

Task<string>

GetPublicUrl(string, TransformOptions?, DownloadOptions?)

string GetPublicUrl(string path, TransformOptions? transformOptions = null, DownloadOptions? options = null)

Parameters

path string

transformOptions TransformOptions

options DownloadOptions

Returns

string

Info(string)

Task<FileObjectV2?> Info(string path)

Parameters

path string

Returns

Task<FileObjectV2>

List(string, SearchOptions?)

Task<List<TFileObject>?> List(string path = "", SearchOptions? options = null)

Parameters

path string

options SearchOptions

Returns

Task<List<TFileObject>>

Move(string, string, DestinationOptions?)

Task<bool> Move(string fromPath, string toPath, DestinationOptions? options = null)

Parameters

fromPath string

toPath string

options DestinationOptions

Returns

Task<bool>

PurgeCache(string, PurgeCacheOptions?, CancellationToken)

Purges the CDN cache for a single object. Requires a service-role key.

Task<GenericResponse?> PurgeCache(string path, PurgeCacheOptions? options = null, CancellationToken cancellationToken = default)

Parameters

path string

The object path within the bucket to purge.

options PurgeCacheOptions

When Transformations is true, only the transformed variants are purged; otherwise every cached version is purged.

cancellationToken CancellationToken

Token used to cancel the request.

Returns

Task<GenericResponse>

The service acknowledgement of the purge.

Examples

await storage.From("avatars").PurgeCache("folder/avatar.png");

Remove(List<string>)

Task<List<TFileObject>?> Remove(List<string> paths)

Parameters

paths List<string>

Returns

Task<List<TFileObject>>

Remove(string)

Task<TFileObject?> Remove(string path)

Parameters

path string

Returns

Task<TFileObject>

Update(byte[], string, FileOptions?, EventHandler<float>?)

Task<string> Update(byte[] data, string supabasePath, FileOptions? options = null, EventHandler<float>? onProgress = null)

Parameters

data byte[]

supabasePath string

options FileOptions

onProgress EventHandler<float>

Returns

Task<string>

Update(string, string, FileOptions?, EventHandler<float>?)

Task<string> Update(string localFilePath, string supabasePath, FileOptions? options = null, EventHandler<float>? onProgress = null)

Parameters

localFilePath string

supabasePath string

options FileOptions

onProgress EventHandler<float>

Returns

Task<string>

Upload(byte[], string, FileOptions?, EventHandler<float>?, bool, CancellationToken)

Task<string> Upload(byte[] data, string supabasePath, FileOptions? options = null, EventHandler<float>? onProgress = null, bool inferContentType = true, CancellationToken cancellationToken = default)

Parameters

data byte[]

supabasePath string

options FileOptions

onProgress EventHandler<float>

inferContentType bool

cancellationToken CancellationToken

Returns

Task<string>

Upload(string, string, FileOptions?, EventHandler<float>?, bool, CancellationToken)

Task<string> Upload(string localFilePath, string supabasePath, FileOptions? options = null, EventHandler<float>? onProgress = null, bool inferContentType = true, CancellationToken cancellationToken = default)

Parameters

localFilePath string

supabasePath string

options FileOptions

onProgress EventHandler<float>

inferContentType bool

cancellationToken CancellationToken

Returns

Task<string>

UploadOrResume(byte[], string, FileOptions, EventHandler<float>?, CancellationToken)

Task UploadOrResume(byte[] data, string fileName, FileOptions options, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default)

Parameters

data byte[]

fileName string

options FileOptions

onProgress EventHandler<float>

cancellationToken CancellationToken

Returns

Task

UploadOrResume(string, string, FileOptions, EventHandler<float>?, CancellationToken)

Task UploadOrResume(string localPath, string fileName, FileOptions options, EventHandler<float>? onProgress = null, CancellationToken cancellationToken = default)

Parameters

localPath string

fileName string

options FileOptions

onProgress EventHandler<float>

cancellationToken CancellationToken

Returns

Task

UploadToSignedUrl(byte[], UploadSignedUrl, FileOptions?, EventHandler<float>?, bool)

Task<string> UploadToSignedUrl(byte[] data, UploadSignedUrl url, FileOptions? options = null, EventHandler<float>? onProgress = null, bool inferContentType = true)

Parameters

data byte[]

url UploadSignedUrl

options FileOptions

onProgress EventHandler<float>

inferContentType bool

Returns

Task<string>

UploadToSignedUrl(string, UploadSignedUrl, FileOptions?, EventHandler<float>?, bool)

Task<string> UploadToSignedUrl(string localFilePath, UploadSignedUrl url, FileOptions? options = null, EventHandler<float>? onProgress = null, bool inferContentType = true)

Parameters

localFilePath string

url UploadSignedUrl

options FileOptions

onProgress EventHandler<float>

inferContentType bool

Returns

Task<string>