alex/anki-connect
1
Fork 0
Code Releases 5 Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2018-01-26 15:18:44 -08:00
parent de56be0ad9
commit c2f7acf928
1 changed files with 70 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
README.md
View File

@ -15,14 +15,10 @@ with the latest stable (2.0.x) and alpha (2.1.x) releases of Anki and works on L
* [Supported Actions](https://foosoft.net/projects/anki-connect/#supported-actions) * [Supported Actions](https://foosoft.net/projects/anki-connect/#supported-actions)
* [Miscellaneous](https://foosoft.net/projects/anki-connect/#miscellaneous) * [Miscellaneous](https://foosoft.net/projects/anki-connect/#miscellaneous)
* [Decks](https://foosoft.net/projects/anki-connect/#decks) * [Decks](https://foosoft.net/projects/anki-connect/#decks)
* [Deck Configurations](https://foosoft.net/projects/anki-connect/#deck-configurations)
* [Models](https://foosoft.net/projects/anki-connect/#models) * [Models](https://foosoft.net/projects/anki-connect/#models)
* [Note Creation](https://foosoft.net/projects/anki-connect/#note-creation) * [Notes](https://foosoft.net/projects/anki-connect/#notes)
* [Note Tags](https://foosoft.net/projects/anki-connect/#note-tags) * [Cards](https://foosoft.net/projects/anki-connect/#cards)
* [Card Suspension](https://foosoft.net/projects/anki-connect/#card-suspension) * [Media](https://foosoft.net/projects/anki-connect/#media)
* [Card Intervals](https://foosoft.net/projects/anki-connect/#card-intervals)
* [Finding Notes and Cards](https://foosoft.net/projects/anki-connect/#finding-notes-and-cards)
* [Media File Storage](https://foosoft.net/projects/anki-connect/#media-file-storage)
* [Graphical](https://foosoft.net/projects/anki-connect/#graphical) * [Graphical](https://foosoft.net/projects/anki-connect/#graphical)
* [License](https://foosoft.net/projects/anki-connect/#license) * [License](https://foosoft.net/projects/anki-connect/#license)
@ -345,8 +341,6 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
#### Deck Configurations ####
* **getDeckConfig** * **getDeckConfig**
Gets the configuration group object for the given deck. Gets the configuration group object for the given deck.
@ -636,7 +630,7 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
#### Note Creation #### #### Notes ####
* **addNote** * **addNote**
@ -763,8 +757,6 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
#### Note Modification ####
* **updateNoteFields** * **updateNoteFields**
Modify the fields of an exist note. Modify the fields of an exist note.
@ -780,7 +772,7 @@ guarantee that your application continues to function properly in the future.
"fields": { "fields": {
"Front": "new front content", "Front": "new front content",
"Back": "new back content" "Back": "new back content"
}, }
} }
} }
} }
@ -794,9 +786,6 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
#### Note Tags ####
* **addTags** * **addTags**
Adds tags to notes by note ID. Adds tags to notes by note ID.
@ -865,7 +854,65 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
#### Card Suspension #### * **findNotes**
Returns an array of note IDs for a given query. Same query syntax as `guiBrowse`.
*Sample request*:
```json
{
"action": "findNotes",
"version": 5,
"params": {
"query": "deck:current"
}
}
```
*Sample result*:
```json
{
"result": [1483959289817, 1483959291695],
"error": null
}
```
* **notesInfo**
Returns a list of objects containing for each note ID the note fields, tags, note type and the cards belonging to
the note.
*Sample request*:
```json
{
"action": "notesInfo",
"version": 5,
"params": {
"notes": [1502298033753]
}
}
```
*Sample result*:
```json
{
"result": [
{
"noteId":1502298033753,
"modelName": "Basic",
"tags":["tag","another_tag"],
"fields": {
"Front": {"value": "front content", "order": 0},
"Back": {"value": "back content", "order": 1}
}
}
],
"error": null
}
```
#### Cards ####
* **suspend** * **suspend**
@ -938,8 +985,6 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
#### Card Intervals ####
* **areDue** * **areDue**
Returns an array indicating whether each of the given cards is due (in the same order). *Note*: cards in the Returns an array indicating whether each of the given cards is due (in the same order). *Note*: cards in the
@ -1012,31 +1057,6 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
#### Finding Notes and Cards ####
* **findNotes**
Returns an array of note IDs for a given query. Same query syntax as `guiBrowse`.
*Sample request*:
```json
{
"action": "findNotes",
"version": 5,
"params": {
"query": "deck:current"
}
}
```
*Sample result*:
```json
{
"result": [1483959289817, 1483959291695],
"error": null
}
```
* **findCards** * **findCards**
Returns an array of card IDs for a given query. Functionally identical to `guiBrowse` but doesn't use the GUI for Returns an array of card IDs for a given query. Functionally identical to `guiBrowse` but doesn't use the GUI for
@ -1087,7 +1107,8 @@ guarantee that your application continues to function properly in the future.
* **cardsInfo** * **cardsInfo**
Returns a list of objects containing for each card ID the card fields, front and back sides including CSS, note type, the note that the card belongs to, and deck name, as well as ease and interval. Returns a list of objects containing for each card ID the card fields, front and back sides including CSS, note
type, the note that the card belongs to, and deck name, as well as ease and interval.
*Sample request*: *Sample request*:
```json ```json
@ -1139,47 +1160,13 @@ guarantee that your application continues to function properly in the future.
} }
``` ```
* **notesInfo** #### Media ####
Returns a list of objects containing for each note ID the note fields, tags, note type and the cards belonging to the note.
*Sample request*:
```json
{
"action": "notesInfo",
"version": 5,
"params": {
"notes": [1502298033753]
}
}
```
*Sample result*:
```json
{
"result": [
{
"noteId":1502298033753,
"modelName": "Basic",
"tags":["tag","another_tag"],
"fields": {
"Front": {"value": "front content", "order": 0},
"Back": {"value": "back content", "order": 1}
},
}
],
"error": null
}
```
#### Media File Storage ####
* **storeMediaFile** * **storeMediaFile**
Stores a file with the specified base64-encoded contents inside the media folder. Stores a file with the specified base64-encoded contents inside the media folder. To prevent Anki from removing
files not used by any cards (e.g. for configuration files), prefix the filename with an underscore. These files are
*Note*: to prevent Anki from removing files not used by any cards (e.g. for configuration files), prefix the still synchronized to AnkiWeb.
filename with an underscore. These files are still synchronized to AnkiWeb.
*Sample request*: *Sample request*:
```json ```json