WordsEndpoint class

Retrieve definitions, examples and other information for a given dictionary word or an inflection.

The response contains information about the lemmas to which the given word/inflected form is linked.

Inheritance

Properties

deserializer → JsonDeserializer<DictionaryEntry>
Deserializes JSON to an object of type T.
no setter
domains → Iterable<String>?
A comma-separated list of domains ids to match on.
final
endpoint → OxfordDictionariesEndpoint
The OxfordDictionariesEndpoint enumeration of the OdApiEndpoint.
no setteroverride
fields → Iterable<String>?
A comma-separated list of data fields to return for the matched entries.
final
grammaticalFeatures → Iterable<String>?
A comma-separated list of grammaticalFeatures ids to match on.
final
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, String>
Returns the headers for the API endpoint request.
final
host → String
The host part of the API endpoint request.
no setterinherited
language → Language
The ISO language code for the language of a term.
final
lexicalCategory → PartOfSpeech?
A comma-separated list of lexical categories ids to match on
final
name → String
Returns the name of the endpoint
no setterinherited
path → String
The path element for the API endpoint uri.
no setter
porter2stem → String
Uses the Porter2Stemmer to return the stem of term.
no setterinherited
protocol → HttpProtocol
The protocol of the API endpoint.
no setterinherited
queryParameters → Map<String, String>
The query parameters for the endpoint.
no setter
registers → Iterable<String>?
A comma-separated list of registers ids to match on.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serializer → JsonSerializer<DictionaryEntry>
Serializes an object of type T to JSON.
no setterinherited
strictMatch → bool
Specifies whether diacritics must match exactly.
final
term → String
The term parameter requested from the endpoint.
final

Methods

get() → Future<DictionaryEntry?>
Asynchronously returns an object of type T from the API endpoint.
inherited
getJson() → Future<Map<String, dynamic>?>
Returns the JSON for the endpoint
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
post(DictionaryEntry? obj) → Future<DictionaryEntry?>
Asynchronously posts an obj of type T to the API endpoint using POST.
inherited
postJson(JSON? json) → Future<Map<String, dynamic>?>
Asynchronously posts a json document to the API endpoint using POST.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

query(String term, Map<String, String> apiKeys, {Language language = Language.en_US, bool strictMatch = false, Iterable<String>? fields, Iterable<String>? registers, Iterable<String>? grammaticalFeatures, PartOfSpeech? lexicalCategory, Iterable<String>? domains}) → Future<DictionaryEntry?>
Queries the WordsEndpoint for a DictionaryEntry for the term and optional parameters.