TaxonomyPackagingQueryConfiguration class

Configuration for packaging API query.

Constructors

TaxonomyPackagingQueryConfiguration({required List<String> tags, List<OpenFoodFactsLanguage>? languages, OpenFoodFactsCountry? country, List<TaxonomyPackagingField> fields = const [], List<Parameter> additionalParameters = const []})

Configuration to get the packagings that match the tags.

TaxonomyPackagingQueryConfiguration.roots({List<OpenFoodFactsLanguage>? languages, OpenFoodFactsCountry? country, List<TaxonomyPackagingField> fields = const [], List<Parameter> additionalParameters = const []})

Configuration to get the root packagings.

Properties

additionalParameters → List<Parameter>

Additional parameters to add the to query.

final, inherited

country → OpenFoodFactsCountry?

The country for this query, if any.

final, inherited

fields → List<TaxonomyPackagingField>

The desired taxonomy fields to retrieve. If empty, retrieve all fields.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

ignoredFields → Set<TaxonomyPackagingField>

Returns the set of fields to ignore if specified in the fields parameter.

no setter

includeChildren → bool

If true, include the children of the requested tag in the results.

final, inherited

languages → List<OpenFoodFactsLanguage>

The languages field should be used to set the desired taxonomy language(s) when a taxonomy is requested with fields in one or more languages. The taxonomy's text fields should be filled with the requested languages in a prioritized manner based on the order supplied.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tags → List<String>

The tags to request.

final, inherited

tagType → TagType

The type of tags that this query should request a taxonomy for.

final, inherited

Methods

convertFieldsToStrings(Iterable<TaxonomyPackagingField> fields) → Iterable<String>

Converts the given list of fields to their corresponding query string values.

convertResults(dynamic jsonData) → Map<String, TaxonomyPackaging>

Creates a map of the correct taxonomy type from the raw JSON data.

getParametersMap() → Map<String, String>

Returns the corresponding API URI parameter map, including additionalParameters.

inherited

getPostUri([QueryType? queryType]) → Uri

inherited

getUri([QueryType? queryType]) → Uri

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited