Client class abstract
Client that handles requests to Appwrite.
The Client is also responsible for managing user's sessions.
- Implementers
Constructors
Properties
-
config
↔ Map<
String, String> -
Holds configuration such as project.
getter/setter pair
- endPoint → String
-
Appwrite endpoint.
no setter
- endPointRealtime → String?
-
Appwrite realtime endpoint.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addHeader(
String key, String value) → Client - Add headers that should be sent with all API calls.
-
call(
HttpMethod method, {String path = '', Map< String, String> headers = const {}, Map<String, dynamic> params = const {}, ResponseType? responseType}) → Future<Response> - Send the API request.
-
chunkedUpload(
{required String path, required Map< String, dynamic> params, required String paramName, required String idParamName, required Map<String, String> headers, dynamic onProgress(UploadProgress)?}) → Future<Response> - Upload a file in chunks.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setEndpoint(
String endPoint) → Client - Set the Appwrite endpoint.
-
setEndPointRealtime(
String endPoint) → Client - Set the Appwrite realtime endpoint.
-
setJWT(
dynamic value) → Client - Set JWT.
-
setLocale(
dynamic value) → Client - Set Locale.
-
setProject(
dynamic value) → Client - Set Project.
-
setSelfSigned(
{bool status = true}) → Client -
Set self signed to
status
. -
toString(
) → String -
A string representation of this object.
inherited
-
webAuth(
Uri url, {String? callbackUrlScheme}) → Future - Handle OAuth2 session creation.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- CHUNK_SIZE → const int
- The size for cunked uploads in bytes.