SearchEndpoint class

Retrieve possible headword matches for a search term.

The results are calculated using headword matching, fuzzy matching, and lemmatization.

Inheritance

Properties

deserializer → JsonDeserializer<List<String>>
Deserializes JSON to an object of type T.
no setter
endpoint → OxfordDictionariesEndpoint
The OxfordDictionariesEndpoint enumeration of the OdApiEndpoint.
no setteroverride
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
limit → int?
Restricts number of returned results. Default and maximum is 5000.
final
name → String
Returns the name of the endpoint
no setterinherited
offset → int?
Pagination - results offset. The sum of offset and limit must not exceed 10000.
final
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
prefix → bool
Specifies whether to return only results that start with the term.
final
protocol → HttpProtocol
The protocol of the API endpoint.
no setterinherited
queryParameters → Map<String, String>
The query parameters for the endpoint.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serializer → JsonSerializer<List<String>>
Serializes an object of type T to JSON.
no setterinherited
term → String
The term parameter requested from the endpoint.
final

Methods

get() → Future<List<String>?>
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(List<String>? obj) → Future<List<String>?>
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 prefix = false, int? limit, int? offset, Iterable<String>? grammaticalFeatures, PartOfSpeech? lexicalCategory, Iterable<String>? domains}) → Future<List<String>>
Queries the SearchEndpoint for a List<String> for the term and optional parameters.