Interface IStorageBucketApi<TBucket>

Namespace

Supabase.Storage.Interfaces

Assembly

Supabase.Storage.dll

public interface IStorageBucketApi<TBucket> : IGettableHeaders where TBucket : Bucket

Type Parameters

TBucket

Inherited Members

IGettableHeaders.GetHeaders

Properties

Headers

Dictionary<string, string> Headers { get; set; }

Property Value

Dictionary<string, string>

Options

ClientOptions Options { get; }

Property Value

ClientOptions

Methods

CreateBucket(string, BucketUpsertOptions?)

Task<string> CreateBucket(string id, BucketUpsertOptions? options = null)

Parameters

id string

options BucketUpsertOptions

Returns

Task<string>

DeleteBucket(string)

Task<GenericResponse?> DeleteBucket(string id)

Parameters

id string

Returns

Task<GenericResponse>

EmptyBucket(string)

Task<GenericResponse?> EmptyBucket(string id)

Parameters

id string

Returns

Task<GenericResponse>

GetBucket(string)

Task<TBucket?> GetBucket(string id)

Parameters

id string

Returns

Task<TBucket>

ListBuckets()

Task<List<TBucket>?> ListBuckets()

Returns

Task<List<TBucket>>

PurgeBucketCache(string, PurgeCacheOptions?, CancellationToken)

Purges the CDN cache for every object in a bucket. Requires a service-role key.

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

Parameters

id string

The bucket whose cached objects should be purged.

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.PurgeBucketCache("avatars", new PurgeCacheOptions { Transformations = true });

UpdateBucket(string, BucketUpsertOptions?)

Task<TBucket?> UpdateBucket(string id, BucketUpsertOptions? options = null)

Parameters

id string

options BucketUpsertOptions

Returns

Task<TBucket>