Grammalecte  Check-in [049c6d098f]

Overview
Comment:[doc] Web API update
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk | doc
Files: files | file ages | folders
SHA3-256: 049c6d098f85a648b64735221b328778678b8d5a0c873579d10e142e864912a7
User & Date: olr on 2020-03-22 09:26:54
Other Links: manifest | tags
Context
2020-03-22
11:23
[fr] ajustements check-in: 95478de541 user: olr tags: trunk, fr
09:26
[doc] Web API update check-in: 049c6d098f user: olr tags: trunk, doc
09:22
[doc] Web API: event GrammalecteLoaded when the APi is ready check-in: d8b0e71ca7 user: olr tags: trunk, doc
Changes

Modified doc/API_web.md from [a962714feb] to [db743ee983].

115
116
117
118
119
120
121
122
123


124
125
126
127
128
129
130
131

132
133
134
135
136
137
138
115
116
117
118
119
120
121


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139







-
-
+
+








+







    }

For the last event, `oResult` will be `null`.


### Parse text and get errors

    oGrammalecteAPI.parseText(text, "node_id")
    oGrammalecteAPI.parseText(text, node)
    oGrammalecteAPI.parseText("your text", "node_id")
    oGrammalecteAPI.parseText("your text", node)

The node must have an identifier.
Like with `oGrammalecteAPI.parseNode()`, results (for each paragraph) will be sent in a succession of events at the node.



### Get spelling suggestions

    oGrammalecteAPI.getSpellingSuggestions(word, destination)
    oGrammalecteAPI.getSpellingSuggestions(word, destination, request_identifier)

Parameters:

- word (string)

- destination: node_id (string)