Skip to content

Classes and APIs List

Nicolò Santilio edited this page Jan 10, 2021 · 7 revisions

Here you can find the complete list of APIs currenlty implemented with GDScript

Table of contents
Classes SupabaseAuthError
SupabaseDatabaseError
SupabaseUser
SupabaseQuery
APIs SupabaseAuthentication
SupabaseDatabase

Classes

SupabaseError (SupabaseAuthError)

Property Type Description
type String The type of the error, can be a code or the error's name.
description String The description or the message of the error.

Some examples on how to use SupabaseAuthError here.


SupabaseError (SupabaseDatabaseError)

Property Type Description
code String The type of the error, can be a code or the error's name.
message String The description or the message of the error.
hint String The description or the message of the error.
details String The description or the message of the error.

Some examples on how to use SupabaseDatabaseError here.


SupabaseUser (SupabaseUser)

Property Type Description
email String Logged user's email.
access_token String Logged user's access token.
token_type String Logged user's token type.
refresh_token String Logged user's refresh token
expires_in float Logged user's token expiration time.
created_at String Logged user's creation date.
updated_at String The description or the message of the error.
last_sign_in_at String The description or the message of the error.
user Dictionary The description or the message of the error.
user_metadata Dictionary The description or the message of the error.
role String The description or the message of the error.

Some examples on how to use SupabaseUser here.


SupabaseQuery (SupabaseQuery)

Method Description
new() Create a SupabaseQuery instance.
from(table_name : String)
select(columns : PoolStringArray)
insert(fields : Array, upsert : bool = false)
update(feilds : Dictionary)
delete()
range(from : int, to : int)
eq(column : String, value : String)
gt(column : String, value : String)
lt(column : String, value : String)
gte(column : String, value : String)
lte(column : String, value : String)
like(column : String, value : String)
ilike(column : String, value : String)
is_(column : String, value : String)
neq(column : String, value : String)

Some examples on how to use SupabaseQuery methods here.



APIs

SupabaseAuthentication (Supabase.auth)

Method Description
sign_in(email : String, password : String) Allow a user to sign up and create a new account.
sign_in(email : String, password : String) Allow a user to sign in with email/password combination.
user(user_access_token : String) Retrieve user's information.

Some examples on how to use Authentication methods here.


Signal Description
signed_up(user : SupabaseUser) Emitted when a user has correctly signed up. Returns user's information.
signed_in(user : SupabaseUser) Emitted when a user has correctly signed in. Returns user's information.
got_user(user : SupabaseUser) Emitted when a user has been correctly retrieved. Returns user's information.
error(error: SupabaseError) Emitted when a request was not processed correctly. Returns the error with details.

Some examples on how to use Authentication signals here.


SupabaseDatabase (Supabase.database)

Method Description
query(supabase_query : SupabaseQuery) Issue a query on Supabase Database.

Some examples on how to use Database methods here.


Signal Description
selected(result : Array) Emitted when a query has been correctly issued. Returns query's result.
inserted() Emitted when an INSERT query has been correctly issued.
updated() Emitted when an UPDATE query has been correctly issued.
deketed() Emitted when a DELETE query has been correctly issued.
error(error: SupabaseError) Emitted when a query has not been processed correctly. Returns the error with details.

Some examples on how to use Database signals here.


Clone this wiki locally