$Client class

Available extensions

Constructors

$Client.new(Uri baseURL, {Map<String, String>? baseHeaders, String? userAgent, HttpClient? httpClient, CookieJar? cookieJar, List<DynamiteAuthentication> authentications = const []})
$Client.fromClient(DynamiteClient client)

Properties

appPassword → $AppPasswordClient
no setter
authentications → List<DynamiteAuthentication>
The available authentications for this client.
finalinherited
autoComplete → $AutoCompleteClient
no setter
avatar → $AvatarClient
no setter
baseHeaders → Map<String, String>?
The base headers added to each request.
finalinherited
baseURL → Uri
The base server url used to build the request uri.
finalinherited
clientFlowLoginV2 → $ClientFlowLoginV2Client
no setter
collaborationResources → $CollaborationResourcesClient
no setter
cookieJar → CookieJar?
The optional cookie jar to persist the response cookies.
finalinherited
guestAvatar → $GuestAvatarClient
no setter
hashCode → int
The hash code for this object.
no setterinherited
hoverCard → $HoverCardClient
no setter
httpClient → HttpClient
The base http client.
finalinherited
no setter
ocm → $OcmClient
no setter
ocs → $OcsClient
no setter
preview → $PreviewClient
no setter
profileApi → $ProfileApiClient
no setter
reference → $ReferenceClient
no setter
referenceApi → $ReferenceApiClient
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
textProcessingApi → $TextProcessingApiClient
no setter
textToImageApi → $TextToImageApiClient
no setter
translationApi → $TranslationApiClient
no setter
unifiedSearch → $UnifiedSearchClient
no setter
whatsNew → $WhatsNewClient
no setter
wipe → $WipeClient
no setter

Methods

executeRawRequest(String method, Uri uri, Map<String, String> headers, Uint8List? body, Set<int>? validStatuses) → Future<HttpClientResponse>
Executes a HTTP request against give full uri.
inherited
executeRequest(String method, String path, Map<String, String> headers, Uint8List? body, Set<int>? validStatuses) → Future<HttpClientResponse>
Makes a request against a given path.
inherited
getStatus() → Future<DynamiteResponse<Status, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
getStatusRaw() → DynamiteRawResponse<Status, void>
This method and the response it returns is experimental. The API might change without a major version bump.
getVersionCheck(OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities) → VersionCheck

Available on $Client, provided by the CoreVersionCheck extension

Check if the core/Server version is supported by this client
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited