flutter_ankidroid 0.8.1

A flutter wrapper over the java AnkiDroid API.

flutter_ankidroid

This plugin is a flutter wrapper over the java AnkiDroid API.

Before Starting

1. Edit your project's android/app/build.gradle

Add repositories { maven { url "https://jitpack.io" } } to the end of the file. This is because Gradle can't find the AnkiDroid java API files. I already have written this into the plugin's code, but apps don't compile if they don't add this.

2. Edit your project's android/app/src/main/AndroidManifest.xml

In the opening <manifest...> tag: add xmlns:tools="http://schemas.android.com/tools" to the end, just after the other xmlns thingy. Then in the <Application...> tag, add tools:replace="android:label" above android:label="...". This is because the AnkiDroid java API has an AndroidManifest.xml with a set value for the label, but we want to use our own label, so we do tools:replace.

Usage

Create an Ankidroid instance with its own isolate by running this:

final anki = await Ankidroid.createAnkiIsolate();

The above line also requests permission to use AnkiDroid's database through the static askForPermission() method. Then you could do:

final decks = await anki.deckList();
if (decks.isValue) {
    print(decks.asValue!.value);
} else {
    print(decks.asError!.error);
}

Or you can go ahead and use any of the following methods.

anki.addNote(modelId, deckId, fields, tags)
anki.addNotes(modelId, deckId, fieldsList, tagsList)
anki.addMedia(bytes, preferredName, mimeType)
anki.findDuplicateNotesWithKey(mid, key)
anki.findDuplicateNotesWithKeys(mid, keys)
anki.getNoteCount(mid)
anki.updateNoteTags(noteId, tags)
anki.updateNoteFields(noteId, fields)
anki.getNote(noteId)
anki.previewNewNote(mid, flds)
anki.addNewBasicModel(name)
anki.addNewBasic2Model(name)
anki.addNewCustomModel(name, fields, cards, qfmt, afmt, css, did, sortf)
anki.currentModelId()
anki.getFieldList(modelId)
anki.modelList()
anki.getModelList(minNumFields)
anki.getModelName(mid)
anki.addNewDeck(deckName)
anki.selectedDeckName()
anki.deckList()
anki.getDeckName(did)
anki.apiHostSpecVersion()

Also, if you know you're not going to use anki anymore, then you could do

anki.killIsolate();