$Client class - notes library

Constructors

$Client.new(Uri baseURL, {Map<String, String>? baseHeaders, Client? httpClient, CookieJar? cookieJar, List<DynamiteAuthentication>? authentications}): Creates a new DynamiteClient for untagged requests.
$Client.fromClient(DynamiteClient client): Creates a new $Client from another client.

Properties

authentications → List<DynamiteAuthentication>?: The available authentications for this client.
finalinherited
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
cookieJar → CookieJar?: The optional cookie jar to persist the response cookies.
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
httpClient → Client: The base http client.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

createNote({String? category, String? title, String? content, int? modified, int? favorite}) → Future<DynamiteResponse<Note, 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.
createNoteRaw({String? category, String? title, String? content, int? modified, int? favorite}) → DynamiteRawResponse<Note, void>: This method and the response it returns is experimental. The API might change without a major version bump.
deleteNote({required int id}) → Future<DynamiteResponse<String, 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.
deleteNoteRaw({required int id}) → DynamiteRawResponse<String, void>: This method and the response it returns is experimental. The API might change without a major version bump.
executeRawRequest(String method, Uri uri, {Map<String, String>? headers, Uint8List? body, Set<int>? validStatuses}) → Future<StreamedResponse>: Executes a HTTP request against give full uri.
inherited
executeRequest(String method, String path, {Map<String, String>? headers, Uint8List? body, Set<int>? validStatuses}) → Future<StreamedResponse>: Makes a request against a given path.
inherited
getNote({required int id, String? exclude, String? ifNoneMatch}) → Future<DynamiteResponse<Note, 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.
getNoteRaw({required int id, String? exclude, String? ifNoneMatch}) → DynamiteRawResponse<Note, void>: This method and the response it returns is experimental. The API might change without a major version bump.
getNotes({String? category, String? exclude, int? pruneBefore, int? chunkSize, String? chunkCursor, String? ifNoneMatch}) → Future<DynamiteResponse<BuiltList<Note>, 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.
getNotesRaw({String? category, String? exclude, int? pruneBefore, int? chunkSize, String? chunkCursor, String? ifNoneMatch}) → DynamiteRawResponse<BuiltList<Note>, void>: This method and the response it returns is experimental. The API might change without a major version bump.
getSettings() → Future<DynamiteResponse<Settings, 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.
getSettingsRaw() → DynamiteRawResponse<Settings, 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 NotesVersionCheck extension
Check if the notes app 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
updateNote({required int id, String? content, int? modified, String? title, String? category, int? favorite, String? ifMatch}) → Future<DynamiteResponse<Note, 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.
updateNoteRaw({required int id, String? content, int? modified, String? title, String? category, int? favorite, String? ifMatch}) → DynamiteRawResponse<Note, void>: This method and the response it returns is experimental. The API might change without a major version bump.
updateSettings({required Settings settings}) → Future<DynamiteResponse<Settings, 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.
updateSettingsRaw({required Settings settings}) → DynamiteRawResponse<Settings, void>: This method and the response it returns is experimental. The API might change without a major version bump.

Operators

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