nhost_sdk library

Classes

ApiException: Thrown by ApiClient to indicate a failed API call.
Auth: The Nhost Auth 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.
FileNhostMetadata: Additional Nhost-specific metadata associated with a FileMetadata instance.
ImageTransformConfig: 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 login.
MultiFactorAuthResponse
NhostClient: API client for accessing Nhost's authentication and storage APIs.
Session: Represents a user-authenticated session with Nhost.
Storage: The Nhost storage service.
User: Describes an Nhost user.

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

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

AuthStateChangedCallback = void Function({required bool authenticated}): Signature for callbacks that respond to authentication changes.
TokenChangedCallback = void Function(): Signature for callbacks that respond to token changes.
UnsubscribeDelegate = void Function(): Signature for functions that remove their associated callback when called.