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
Task<string> CreateSignedUrl(string path, int expiresIn, TransformOptions? transformOptions = null)
Parameters
path
string
expiresIn
int
transformOptions
TransformOptions
Returns
- Task<string>
CreateSignedUrls(List<string>, int)
Task<List<CreateSignedUrlsResponse>?> CreateSignedUrls(List<string> paths, int expiresIn)
Parameters
paths
List<string>
expiresIn
int
Returns
- Task<List<CreateSignedUrlsResponse>>
CreateUploadSignedUrl(string)
Task<UploadSignedUrl> CreateUploadSignedUrl(string supabasePath)
Parameters
supabasePath
string
Returns
- Task<UploadSignedUrl>
Task<byte[]> Download(string supabasePath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null)
Parameters
supabasePath
string
transformOptions
TransformOptions
onProgress
EventHandler<float>
Returns
- Task<byte[]>
Download(string, EventHandler<float>?)
Task<byte[]> Download(string supabasePath, EventHandler<float>? onProgress = null)
Parameters
supabasePath
string
onProgress
EventHandler<float>
Returns
- Task<byte[]>
Task<string> Download(string supabasePath, string localPath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null)
Parameters
supabasePath
string
localPath
string
transformOptions
TransformOptions
onProgress
EventHandler<float>
Returns
- Task<string>
Download(string, string, EventHandler<float>?)
Task<string> Download(string supabasePath, string localPath, EventHandler<float>? onProgress = null)
Parameters
supabasePath
string
localPath
string
onProgress
EventHandler<float>
Returns
- Task<string>
Task<byte[]> DownloadPublicFile(string supabasePath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null)
Parameters
supabasePath
string
transformOptions
TransformOptions
onProgress
EventHandler<float>
Returns
- Task<byte[]>
Task<string> DownloadPublicFile(string supabasePath, string localPath, TransformOptions? transformOptions = null, EventHandler<float>? onProgress = null)
Parameters
supabasePath
string
localPath
string
transformOptions
TransformOptions
onProgress
EventHandler<float>
Returns
- Task<string>
string GetPublicUrl(string path, TransformOptions? transformOptions = null)
Parameters
path
string
transformOptions
TransformOptions
Returns
- string
List(string, SearchOptions?)
Task<List<TFileObject>?> List(string path = "", SearchOptions? options = null)
Parameters
path
string
options
SearchOptions
Returns
- Task<List<TFileObject>>
Move(string, string)
Task<bool> Move(string fromPath, string toPath)
Parameters
fromPath
string
toPath
string
Returns
- Task<bool>
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)
Task<string> Upload(byte[] data, string supabasePath, FileOptions? options = null, EventHandler<float>? onProgress = null, bool inferContentType = true)
Parameters
data
byte[]
supabasePath
string
options
FileOptions
onProgress
EventHandler<float>
inferContentType
bool
Returns
- Task<string>
Upload(string, string, FileOptions?, EventHandler<float>?, bool)
Task<string> Upload(string localFilePath, string supabasePath, FileOptions? options = null, EventHandler<float>? onProgress = null, bool inferContentType = true)
Parameters
localFilePath
string
supabasePath
string
options
FileOptions
onProgress
EventHandler<float>
inferContentType
bool
Returns
- Task<string>
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>