openfoodfacts
library
Classes
AbstractQueryConfiguration
Abstract Query Configuration, that helps build API URI
Additives
Allergens
List of known allergens for a Product .
AllergensParameter
List of allergens to filter in and out.
Attribute
AttributeGroup
AvailableAttributeGroups
Referential of attribute groups, with loader.
AvailablePreferenceImportances
Referential of preference importance, with loader.
AvailableProductPreferences
Referential for product preferences: attribute groups and importance.
BadgeBase
Events API: badge.
BarcodeParameter
"Barcodes" search API parameter.
BarcodeValidator
Correction
CountryHelper
Helper class around OpenFoodFactsCountry
EcoscoreAdjustments
EcoscoreData
EventsAPIClient
Client calls of the Events API (Open Food Facts).
EventsBase
Events API: event.
FolksonomyAPIClient
Client calls of the Folksonomy API (Open Food Facts)
HttpHelper
General functions for sending http requests (post, get, multipart, ...)
ImageHelper
Helper class related to product pictures
Ingredient
IngredientsAnalysisParameter
Ingredients Analysis search API parameter.
IngredientsAnalysisTags
Insight
InsightsResult
IntakeRecommendation
InvalidBarcodes
Invalid barcode blacklist
JsonHelper
Helper class around product field conversion to/from JSON
KeyStats
Folksonomy: statistics around a tag key.
KnowledgePanel
KnowledgePanels are a standardized and generic units of information that
the client can display on the product page.
KnowledgePanelActionElement
"Contribute action" element of the Knowledge panel.
KnowledgePanelElement
KnowledgePanelElement is a single unit of KnowledgePanel that can be rendered on the client.
KnowledgePanelGeoPointer
Element representing a geo location of a map pointer.
KnowledgePanelImageElement
Image that represents the KnowledgePanel.
KnowledgePanelLatLng
Element representing a lat/long positioning of a map pointer.
KnowledgePanelPanelGroupElement
Element representing a Panel group that contains 1+ KnowledgePanels.
KnowledgePanelPanelIdElement
Element representing a Panel Id of a KnowledgePanel. This element is a
Knowledge panel itself, the KnowledgePanel can be found in the list of
Knowledge panels using the id.
KnowledgePanels
An object containing all KnowledgePanels in the form of a map.
KnowledgePanelTableCell
Provides the values for each table cell inside a KnowledgePanel table.
KnowledgePanelTableColumn
A descriptor that describes the type and label of each column.
KnowledgePanelTableElement
Element representing a tabular data for the KnowledgePanel.
KnowledgePanelTableRowElement
A table row inside Table element of KonwledgePanel
KnowledgePanelTextElement
Description element of the Knowledge panel.
KnowledgePanelWorldMapElement
Element representing a world map.
LanguageHelper
Helper class around OpenFoodFactsLanguage
LeaderboardEntry
Events API: leaderboard entry.
LocalizedTag
Tag with localizations (in English and an additional language).
LoginStatus
Status after an attempt to log in.
MatchedProduct
MatchedProductV2
Score of a product according to preferences, with a Product field.
MatchedScoreV2
Score of a product according to preferences.
NutrientLevels
Nutriments
Values in nutrients.
NutrimentsHelper
Helper class for energy computations and checks
OcrIngredientsResult
Result from OCR applied to ingredients.
OcrPackagingResult
Result from OCR applied to packaging.
OpenFoodAPIClient
Client calls of the Open Food Facts API
OpenFoodAPIConfiguration
Allows to configure the behavior of the package.
OrderedNutrient
Nutrient, as a hierarchically ordered and localized entity.
OrderedNutrients
Nutrients, as hierarchically ordered and localized entities.
OriginsOfIngredients
Packaging
PageNumber
"Page number" search API parameter
PageSize
"Page size" search API parameter
Parameter
Abstract search API parameter, to be used in the search URI
PnnsGroup2Filter
PnnsGroup2 search API parameter
PreferenceImportance
Importance level when we match products to preferences.
Will be loaded in JSON as a list of increasingly important items.
Product
This class contains most of the data about a specific product.
ProductFreshness
Freshness of a Product .
ProductHelper
Helper class around Product fields
ProductImage
The url to a specific product image.
Categorized by content type, size and language
ProductPackaging
Packaging component for a product, e.g. recyclable bottle made of glass.
ProductPreferencesManager
Manager of the product preferences: referential and app/user preferences.
ProductPreferencesSelection
Where the preferences regarding the importance of attributes are accessed
ProductQueryConfiguration
Query Configuration for single barcode
ProductQueryVersion
Api version for product queries
ProductResult
ProductResultFieldAnswer
API V3 answer for one field.
ProductResultV3
API V3 answer from a call to /api/v3/product/$barcode.
ProductSearchQueryConfiguration
Query Configuration for search parameters
ProductStats
Folksonomy: statistics about the tag keys on a product.
ProductTag
Folksonomy product tag: for this barcode, that value is set for that key.
RecommendedDailyIntake
Recommended daily intake amounts
RobotoffAPIClient
RobotoffQuestion
RobotoffQuestionResult
SearchResult
SearchTerms
Term list search API parameter
SendImage
SignUpStatus
The response from a call to the OpenFoodAPIClient.register method
The status may be:
SortBy
Sort search API parameter
SpellingCorrection
StatesTagsParameter
States Tags as completed or to-be-completed.
Status
SuggestionManager
Manager that returns the suggestions for the latest input.
TagFilter
Tag filter ("LIST contains/without ITEM") search API parameter
TagI18N
A tag with internationalisation.
TaxonomyAdditive
A JSON-serializable version of a Additive taxonomy result.
TaxonomyAdditiveQueryConfiguration
Configuration to get additives
TaxonomyAllergen
A JSON-serializable version of a Allergen taxonomy result.
TaxonomyAllergenQueryConfiguration
Configuration for allergens API query.
TaxonomyCategory
A JSON-serializable version of a category taxonomy result.
TaxonomyCategoryQueryConfiguration
TaxonomyCountry
A JSON-serializable version of a Country taxonomy result.
TaxonomyCountryQueryConfiguration
Configuration for countries API query.
TaxonomyIngredient
A JSON-serializable version of a Ingredient taxonomy result.
TaxonomyIngredientQueryConfiguration
TaxonomyLabel
A JSON-serializable version of a Label taxonomy result.
TaxonomyLabelQueryConfiguration
TaxonomyLanguage
A JSON-serializable version of a Language taxonomy result.
TaxonomyLanguageQueryConfiguration
Configuration for languages API query.
TaxonomyNova
A JSON-serializable version of a Nova taxonomy result.
TaxonomyNovaQueryConfiguration
Configuration for nova API query.
TaxonomyOrigin
A JSON-serializable version of an Origin taxonomy result.
TaxonomyOriginQueryConfiguration
Configuration for origins API query.
TaxonomyPackaging
A JSON-serializable version of a Packaging taxonomy result.
TaxonomyPackagingMaterial
A JSON-serializable version of a Packaging Material taxonomy result.
TaxonomyPackagingMaterialQueryConfiguration
Configuration for packaging materials API query.
TaxonomyPackagingQueryConfiguration
Configuration for packaging API query.
TaxonomyPackagingRecycling
A JSON-serializable version of a Packaging Recycling taxonomy result.
TaxonomyPackagingRecyclingQueryConfiguration
Configuration for packaging recycling API query.
TaxonomyPackagingShape
A JSON-serializable version of a Packaging Shape taxonomy result.
TaxonomyPackagingShapeQueryConfiguration
Configuration for packaging shapes API query.
TermCorrections
TitleElement
An element representing the title of the KnowledgePanel which could consist
of a text title, subtitle and an icon.
UnitHelper
Helper class for conversions to/from Unit
UriHelper
Helper class for constructing urls with the in the OpenFoodAPIConfiguration specified settings
UriReader
Abstract reader of URI data, declined in "not web" and "web" versions
User
UserAgent
UserProductSearchQueryConfiguration
Get products a user created, photographed,
WithoutAdditives
"Without Additives" search API parameter
