mirror of
https://github.com/appwrite/sdk-for-flutter.git
synced 2026-04-07 19:27:41 +00:00
root
111 lines
4.1 KiB
Dart
111 lines
4.1 KiB
Dart
import 'enums.dart';
|
|
import 'client_stub.dart'
|
|
if (dart.library.js_interop) 'client_browser.dart'
|
|
if (dart.library.io) 'client_io.dart';
|
|
import 'response.dart';
|
|
import 'upload_progress.dart';
|
|
|
|
/// [Client] that handles requests to Appwrite.
|
|
///
|
|
/// The [Client] is also responsible for managing user's sessions.
|
|
abstract class Client {
|
|
/// The size for chunked uploads in bytes.
|
|
static const int chunkSize = 5 * 1024 * 1024;
|
|
|
|
/// Holds configuration such as project.
|
|
late Map<String, String> config;
|
|
late String _endPoint;
|
|
late String? _endPointRealtime;
|
|
|
|
/// Appwrite endpoint.
|
|
String get endPoint => _endPoint;
|
|
|
|
/// Appwrite realtime endpoint.
|
|
String? get endPointRealtime => _endPointRealtime;
|
|
|
|
/// Initializes a [Client].
|
|
factory Client({
|
|
String endPoint = 'https://cloud.appwrite.io/v1',
|
|
bool selfSigned = false,
|
|
}) => createClient(endPoint: endPoint, selfSigned: selfSigned);
|
|
|
|
/// Handle OAuth2 session creation.
|
|
Future webAuth(Uri url, {String? callbackUrlScheme});
|
|
|
|
/// Upload a file in chunks.
|
|
Future<Response> chunkedUpload({
|
|
required String path,
|
|
required Map<String, dynamic> params,
|
|
required String paramName,
|
|
required String idParamName,
|
|
required Map<String, String> headers,
|
|
Function(UploadProgress)? onProgress,
|
|
});
|
|
|
|
/// Set self signed to [status].
|
|
///
|
|
/// If self signed is true, [Client] will ignore invalid certificates.
|
|
/// This is helpful in environments where your Appwrite
|
|
/// instance does not have a valid SSL certificate.
|
|
Client setSelfSigned({bool status = true});
|
|
|
|
/// Set the Appwrite endpoint.
|
|
Client setEndpoint(String endPoint);
|
|
|
|
/// Set the Appwrite realtime endpoint.
|
|
Client setEndPointRealtime(String endPoint);
|
|
|
|
/// Set Project.
|
|
///
|
|
/// Your project ID.
|
|
Client setProject(String value);
|
|
|
|
/// Set JWT.
|
|
///
|
|
/// Your secret JSON Web Token.
|
|
Client setJWT(String value);
|
|
|
|
/// Set Locale.
|
|
Client setLocale(String value);
|
|
|
|
/// Set Session.
|
|
///
|
|
/// The user session to authenticate with.
|
|
Client setSession(String value);
|
|
|
|
/// Set DevKey.
|
|
///
|
|
/// Your secret dev API key.
|
|
Client setDevKey(String value);
|
|
|
|
/// Set ImpersonateUserId.
|
|
///
|
|
/// Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data..
|
|
Client setImpersonateUserId(String value);
|
|
|
|
/// Set ImpersonateUserEmail.
|
|
///
|
|
/// Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data..
|
|
Client setImpersonateUserEmail(String value);
|
|
|
|
/// Set ImpersonateUserPhone.
|
|
///
|
|
/// Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data..
|
|
Client setImpersonateUserPhone(String value);
|
|
|
|
/// Add headers that should be sent with all API calls.
|
|
Client addHeader(String key, String value);
|
|
|
|
/// Sends a "ping" request to Appwrite to verify connectivity.
|
|
Future<String> ping();
|
|
|
|
/// Send the API request.
|
|
Future<Response> call(
|
|
HttpMethod method, {
|
|
String path = '',
|
|
Map<String, String> headers = const {},
|
|
Map<String, dynamic> params = const {},
|
|
ResponseType? responseType,
|
|
});
|
|
}
|