ClientIO class

Implemented types

• Client

Constructors

ClientIO({String endPoint = 'https://cloud.appwrite.io/v1', bool selfSigned = false})

Properties

config ↔ Map<String, String>

Holds configuration such as project.

getter/setter pair, override

endPoint → String

Appwrite endpoint.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addHeader(String key, String value) → ClientIO

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.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

prepareRequest(HttpMethod method, {required Uri uri, required Map<String, String> headers, required Map<String, dynamic> params}) → BaseRequest

inherited

prepareResponse(Response res, {ResponseType? responseType}) → Future<Response>

inherited

setEndpoint(String endPoint) → ClientIO

Set the Appwrite endpoint.

setForwardedUserAgent(dynamic value) → ClientIO

The user agent string of the client that made the request

setJWT(dynamic value) → ClientIO

Your secret JSON Web Token

setKey(dynamic value) → ClientIO

Your secret API key

setLocale(dynamic value) → ClientIO

Set Locale

setProject(dynamic value) → ClientIO

Your project ID

setSelfSigned({bool status = true}) → ClientIO

Set self signed to status.

setSession(dynamic value) → ClientIO

The user session to authenticate with

toResponse(StreamedResponse streamedResponse) → Future<Response>

inherited

toString() → String

A string representation of this object.

inherited

webAuth(Uri url) → Future<String?>

Handle OAuth2 session creation.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

CHUNK_SIZE → const int