nhost_sdk library

Classes

AuthClient
The Nhost authentication service.
AuthResponse
Describes the client's authorization state.
AuthStore
Interface implemented by objects responsible for persisting authentication information between restarts of an app.
FileMetadata
Describes a file stored by Nhost.
FunctionsClient
Client for calling Nhost serverless functions.
ImageCornerRadius
The corner radius applied to an image.
ImageTransform
Instructs the backend on how to transform a stored image.
InMemoryAuthStore
Implements the AuthStore interface using an internal Map.
MultiFactorAuthenticationInfo
Describes information required to perform an MFA sign in.
MultiFactorAuthResponse
NhostClient
API client for accessing Nhost's authentication and storage APIs.
PresignedUrl
Session
Represents a user-authenticated session with Nhost.
StorageClient
The Nhost storage service.
User
Describes an Nhost user.

Constants

applicationOctetStreamType → const String
The default used during file upload if not provided.
refreshTokenClientStorageKey → const String
Identifies the refresh token in the AuthClient's AuthStore instance.
refreshTokenQueryParamName → const String
The query parameter name for the refresh token provided during OAuth provider-based sign-ins.

Properties

debugLogNhostErrorsToConsole bool
When true, errors will be printed to the console via Logger.root (from the logging package). When false, no logging will take place.
getter/setter pair

Typedefs

AuthStateChangedCallback = void Function(AuthenticationState authenticationState)
Signature for callbacks that respond to authentication changes.
SessionRefreshFailedCallback = void Function(Exception error, StackTrace stackTrace)
Signature for callbacks that respond to session refresh failures.
TokenChangedCallback = void Function()
Signature for callbacks that respond to token changes.
UnsubscribeDelegate = void Function()
Signature for functions that remove their associated callback when called.

Exceptions / Errors

ApiException
Thrown by ApiClient to indicate a failed API call.
AuthServiceException
NhostException
Base class for exceptions used by the Nhost packages.