shaple library

Classes

AdminUserAttributes
AMREntry
An authentication method reference (AMR) entry.
ApiVersions
AuthClientOptions
AuthMFAAdminDeleteFactorResponse
AuthMFAAdminListFactorsResponse
AuthMFAChallengeResponse
AuthMFAEnrollResponse
AuthMFAGetAuthenticatorAssuranceLevelResponse
AuthMFAListFactorsResponse
AuthMFAUnenrollResponse
AuthMFAVerifyResponse
AuthResponse
Response which might or might not contain session and/or user
AuthSessionUrlResponse
AuthState
Bucket
BucketOptions
public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private.
CreateOAuthClientParams
Parameters for creating a new OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
DecodedJwt
Decoded JWT structure
Factor
FileObject
FileObjectV2
FileOptions
GenerateLinkProperties
GenerateLinkResponse
GetClaimsOptions
Options for getClaims method
GetClaimsResponse
Response from getClaims method
GoTrueAdminApi
GotrueAsyncStorage
Interface to provide async storage to store pkce tokens.
GoTrueClient
API client to interact with gotrue server.
GoTrueMFAApi
JWK
JSON Web Key (JWK) representation.
JWKSet
JwtHeader
JWT Header structure
JwtPayload
JWT Payload structure with standard claims
JwtRawParts
Raw encoded parts of a JWT
OAuthClient
OAuth client object returned from the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthResponse
Response of OAuth signin
PhoneEnrollment
PostgrestBuilder<T, S, R>
The base builder class.
PostgrestClient
A PostgREST api client written in Dartlang. The goal of this library is to make an "ORM-like" restful interface.
PostgrestClientOptions
PostgrestFilterBuilder<T>
PostgrestQueryBuilder<T>
The query builder class provides a convenient interface to creating request queries.
PostgrestResponse<T>
A Postgrest response
PostgrestRpcBuilder
PostgrestTransformBuilder<T>
RawPostgrestBuilder<T, S, R>
Needed as a wrapper around PostgrestBuilder to allow for the different return type of withConverter than in ResponsePostgrestBuilder.withConverter.
ResendResponse
ResponsePostgrestBuilder<T, S, R>
Needed as a wrapper around PostgrestBuilder to allow for the different return type of withConverter than in RawPostgrestBuilder.withConverter.
SearchOptions
Session
ShapleClient
SignedUploadURLResponse
SignedUrl
SortBy
StorageClientOptions
StorageFileApi
StorageRetryController
SupabaseStorageClient
TOTPEnrollment
TransformOptions
Specifies the dimensions and the resize mode of the requesting image.
UpdateOAuthClientParams
Parameters for updating an existing OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
User
UserAttributes
UserIdentity
UserResponse
Response that contains a user

Enums

AMRMethod
AuthChangeEvent
AuthenticatorAssuranceLevels
AuthFlowType
CountOption
Returns count as part of the response when specified.
FactorStatus
FactorType
GenerateLinkType
OAuthClientGrantType
OAuth client grant types supported by the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthClientRegistrationType
OAuth client registration type. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthClientResponseType
OAuth client response types supported by the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthClientType
OAuth client type indicating whether the client can keep credentials confidential. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthProvider
OtpChannel
Messaging channel to use (e.g. whatsapp or sms)
OtpType
RequestImageFormat
ResizeMode
Specifies how image cropping should be handled when performing image transformations.
ReturningOption
Returns count as part of the response when specified.
SignOutScope
Determines which sessions should be logged out.
TextSearchType
The type of tsquery conversion to use on query.

Constants

METHOD_DELETE → const String
METHOD_GET → const String
METHOD_HEAD → const String
METHOD_PATCH → const String
METHOD_POST → const String
METHOD_PUT → const String
version → const String

Functions

decodeJwt(String token) → DecodedJwt
Decodes a JWT token without performing validation
validateExp(int? exp) → void
Validates the expiration time of a JWT

Typedefs

BroadcastChannel = ({void Function() close, Stream<Map<String, dynamic>> onMessage, void Function(Map) postMessage})
Headers = Map<String, String>
PostgrestConverter<S, T> = S Function(T data)
PostgrestList = List<PostgrestMap>
PostgrestListResponse = PostgrestResponse<PostgrestList>
PostgrestMap = Map<String, dynamic>
PostgrestMapResponse = PostgrestResponse<PostgrestMap>