Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Here is a list of all possible parameters and values that can be used with the user_dictionary command.

#ParameterPossible ValuesDefault valueDescription
1format
  • json
  • xml
jsonThe response format for output data.
2callback
  • callback function name

A callback function name that will be used to manipulate
with
the JSON data received from the server.
 Such
Such an approach enables sharing of data bypassing same-origin policy. It can be used only along with “format=json”.
3action
  • create – Create a new user dictionary.
  • rename – Rename an existing user dictionary.
  • delete – Delete an existing user dictionary.
addword
  • addwords – Add
a
  • new
word
  • words to a specified user dictionary.
deleteword
  • deletewords – Remove
a word
  • words from a specified user dictionary.
  • editword – Edit a word in a specified user dictionary.
  • check – Check if a specified user
ductionary
  • dictionary exists on the server.
  • getdict – Get content
of
  • from a specified user dictionary (for JSON only).

An action that can be used to manipulate a user dictionary.

Here is a list of all possible parameters and values that can be used with the user_dictionary action parameter.

#Action parameterParametersPossible valuesDescription
1createname
  • name of a new user dictionary
Create a new user dictionary.
wordlist
  • comma-separated words which will be added to a new dictionary
2deletename
  • name of a selected user dictionary
Delete a selected user dictionary.
3renamename
  • name of a selected user dictionary
Rename a specified dictionary and sets a new name.
new_name
  • a new name for a chosen user dictionary
4checkname
  • name of a chosen user dictionary
Check if a specified user dictionary exists on the server.
5getdictname
  • name of a required user dictionary
Request content of a specified user dictionary. The getdict action is available only for the JSON format.
6
addword
addwordsname
  • name of a chosen user dictionary
Add new
word(s)
words to a specified user dictionary.
If you are adding more than one word at a time, all new words must be separated with commas accordingly.
word
  • a new word which will be added to a specified user dictionary

wordlist
  • a list of coma-separated words (also possible to add just one word)

Status
colourGreen
titlev5.28.0

7
deleteword
deletewordsname
  • name of a chosen user dictionary
Remove
a word
words from a specified user dictionary.
word
  • word which will be removed from a specified user dictionary

wordlist
  • a list of coma-separated words (also possible to remove just one word)

Status
colourGreen
titlev5.28.0

8editwordname
  • name of a chosen user dictionary
Replace a word in a specified user dictionary with a new one.
word
  • word which will be edited
new_word
  • a new word which replaces a word picked for editing

Example 1 [GET]: Create user dictionary (Output in XML)

...