Flutter SDK — API Reference

Auth

client.auth.register(email, password, {name, customFields})  // AuthResult
client.auth.login(email, password)                           // AuthResult
client.auth.sendOtp({email, phone})                          // void
client.auth.verifyOtp({email, phone, code})                  // AuthResult
client.auth.me(accessToken)                                  // User
client.auth.logout(accessToken, {refreshToken})              // void
client.auth.requestPasswordReset(email)                      // void
client.auth.resetPassword(token, newPassword)                // void
client.auth.verifyEmail(token)                               // void
client.auth.resendVerification(email)                        // void

Realtime

RealtimeSubscription channel = client.realtime.channel(topic)
channel.on(event, callback)          // Registers callback
channel.subscribe()
channel.unsubscribe()
channel.publish(event, data)
channel.track(Map<String, dynamic>)
channel.untrack()
Future<List<HistoryMessage>> channel.getHistory({limit, before})

Storage

client.storage.upload(file, {path, contentType})  // UploadResult

Auth types

class AuthResult {
  final String? accessToken;
  final String? refreshToken;
  final int? expiresAt;
  final User? user;
  final bool requiresVerification;
}

class User {
  final String id;
  final String email;
  final String? name;
  final String? avatarUrl;
  final bool emailVerified;
  final Map<String, dynamic>? customFields;
}