storage-kt/io.github.jan.supabase.storage/Storage

Storage

sealed interface Storage : MainPlugin<Storage.Config> , CustomSerializationPlugin(source)

Plugin for interacting with the supabase storage api

To use it you need to install it to the SupabaseClient:

val supabase = createSupabaseClient(supabaseUrl, supabaseKey) {
   install(Storage)
}

then you have to interact with the storage api:

val bucket = supabase.storage.from("icons")
val bytes = bucket.downloadAuthenticated("icon.png")

Types

Companion

object Companion : SupabasePluginProvider<Storage.Config, Storage>

Config

data class Config(var transferTimeout: Duration = 120.seconds, resumable: Storage.Config.Resumable = Resumable(), var serializer: SupabaseSerializer? = null) : MainConfig, CustomSerializationConfig

Config for the storage plugin

Properties

apiVersion

abstract val apiVersion: Int

config

abstract val config: Storage.Config

pluginKey

abstract val pluginKey: String

serializer

abstract val serializer: SupabaseSerializer

supabaseClient

abstract val supabaseClient: SupabaseClient

Functions

open suspend fun close()

createBucket

abstract suspend fun createBucket(id: String, builder: BucketBuilder.() -> Unit = {})

Creates a new bucket in the storage

deleteBucket

abstract suspend fun deleteBucket(bucketId: String)

Deletes a bucket by its bucketId

emptyBucket

abstract suspend fun emptyBucket(bucketId: String)

Empties a bucket by its bucketId

from

open fun from(bucketId: String): BucketApi

Builder function for interacting with a bucket with the given bucketId

get

abstract operator fun get(bucketId: String): BucketApi

Builder function for interacting with a bucket with the given bucketId

init

open fun init()

parseErrorResponse

abstract suspend fun parseErrorResponse(response: HttpResponse): RestException

resolveUrl

open fun resolveUrl(path: String): String

retrieveBucketById

abstract suspend fun retrieveBucketById(bucketId: String): Bucket?

Retrieves a bucket by its bucketId

retrieveBuckets

abstract suspend fun retrieveBuckets(): List<Bucket>

Returns all buckets in the storage

updateBucket

abstract suspend fun updateBucket(id: String, builder: BucketBuilder.() -> Unit = {})

Updates a bucket in the storage