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

Rename actions in README

Browse Source
This commit is contained in:
David Bailey 2017-08-18 20:57:19 +01:00
parent e2c9eaaa3b
commit f980758207
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -209,14 +209,14 @@ Below is a list of currently supported actions. Requests with invalid actions or
] ]
``` ```
* **confForDeck** * **getDeckConfig**
Gets the config group object for the given deck. Gets the config group object for the given deck.
*Sample request*: *Sample request*:
``` ```
{ {
"action": "confForDeck", "action": "getDeckConfig",
"params": { "params": {
"deck": "Default" "deck": "Default"
} }
@ -263,7 +263,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
} }
``` ```
* **saveConf** * **saveDeckConfig**
Saves the given config group, returning `true` on success or `false` if the ID of the config group is invalid (i.e. Saves the given config group, returning `true` on success or `false` if the ID of the config group is invalid (i.e.
it does not exist). it does not exist).
@ -271,7 +271,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
*Sample request*: *Sample request*:
``` ```
{ {
"action": "saveConf", "action": "saveDeckConfig",
"params": { "params": {
"conf": (config group object) "conf": (config group object)
} }
@ -283,7 +283,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
true true
``` ```
* **changeConf** * **setDeckConfigId**
Changes the configuration group for the given decks to the one with the given ID. Returns `true` on success or Changes the configuration group for the given decks to the one with the given ID. Returns `true` on success or
`false` if the given configuration group or any of the given decks do not exist. `false` if the given configuration group or any of the given decks do not exist.
@ -291,7 +291,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
*Sample request*: *Sample request*:
``` ```
{ {
"action": "changeConf", "action": "setDeckConfigId",
"params": { "params": {
"decks": ["Default"], "decks": ["Default"],
"confId": 1 "confId": 1
@ -304,7 +304,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
true true
``` ```
* **addConf** * **cloneDeckConfigId**
Creates a new config group with the given name, cloning from the group with the given ID, or from the default group Creates a new config group with the given name, cloning from the group with the given ID, or from the default group
if this is unspecified. Returns the ID of the new config group, or `false` if the specified group to clone from does if this is unspecified. Returns the ID of the new config group, or `false` if the specified group to clone from does
@ -313,7 +313,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
*Sample request*: *Sample request*:
``` ```
{ {
"action": "addConf", "action": "cloneDeckConfigId",
"params": { "params": {
"name": "Copy of Default", "name": "Copy of Default",
"cloneFrom": 1 "cloneFrom": 1
@ -326,7 +326,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
1502972374573 1502972374573
``` ```
* **remConf** * **removeDeckConfigId**
Removes the config group with the given ID, returning `true` if successful, or `false` if attempting to remove Removes the config group with the given ID, returning `true` if successful, or `false` if attempting to remove
either the default config group (ID = 1) or a config group that does not exist. either the default config group (ID = 1) or a config group that does not exist.
@ -334,7 +334,7 @@ Below is a list of currently supported actions. Requests with invalid actions or
*Sample request*: *Sample request*:
``` ```
{ {
"action": "remConf", "action": "removeDeckConfigId",
"params": { "params": {
"id": 1502972374573 "id": 1502972374573
} }