SERP provider API changes

This document contains changes to the SERP provider API done in versions of Gugal.

Changes in 0.9

Preview 1

  • SERP providers can now request extra credentials.
    • This can be done with the requestCredentials function in ConfigComposable, and should be used if a SERP provider needs more credentials to search than what was initially requested (e.g. an instance of a self-hosted search engine requires a username and password).
  • A new class, BuildInfo, was added, as a way to access information about the current version of Gugal. (https://gitlab.com/narektor/gugal/-/commit/b7b4048d7892fe4a22137853763826b7858d57fd)
    • This API is technically not a part of the SERP provider API, but it's allowed to use it in SERP providers, and it will be kept stable like the SERP provider API is.
  • Gugal now uses the M3X library for extra UI components.
    • Because of this, the com.porg.m3 package is deprecated, and will be removed in a future Gugal version (though not 0.9 or any minor update to it).
      • Most of the deprecated functions can be replaced with the new versions automatically - see Android Studio's tooltip when you hover over the function for details about migration.
  • A new request type, CustomHeaderJsonRequest, has been added for cases when it's necessary to add headers to requests. (https://gitlab.com/narektor/gugal/-/commit/573453644ec0e353c59551f6e8f648ac0ab0e268)

Changes in 0.8.x

0.8.4

  • A special error response, RateLimitedResponse, has been added for cases when a SERP provider is being rate limited.

    0.8.2

  • The com.porg.gugal.Material3* classes have been removed. Please use the alternatives in the com.porg.m3 package. (https://gitlab.com/narektor/gugal/-/commit/642eb7d7ed8df8ee5561004fc369b1f8deab090a)
    • As this change is unexpected, please upgrade the Gugal source code to 0.8.1, migrate your config composables to com.porg.m3, then upgrade to 0.8.2.

      Preview 2

  • The functions in the com.porg.gugal.Material3* classes have been moved to the com.porg.m3 package, and now use a more Compose-style syntax. The Material3* variants are now deprecated and will be removed in 0.9. (https://gitlab.com/narektor/gugal/-/commit/e302e3c313665f1fce0bae8e4fbc4b2b5eae0558)
    • Most of the deprecated functions can be replaced with the new versions automatically - see Android Studio's tooltip when you hover over the function for details about migration.

Preview 1

Changes in 0.7

Preview 2

Preview 1

Changes in 0.6

Preview 1

  • Added support for search errors in async methods (like Volley's result handler). To make this possible an ErrorResponse class and some overrides for it were added, as well as a new isError argument for search().

Changes in 0.5

Final release

Preview 2

results matching ""

    No results matching ""