Releases: mapbox/mapbox-search-android
Releases · mapbox/mapbox-search-android
1.0.0-beta.36
1.0.0-beta.36
Breaking changes
- [CORE]
AsyncOperationTask
,SearchCancellationException
,SearchRequestException
,RoutablePoint
have been moved tocom.mapbox.search.common
package.MainThreadWorker
, andSearchSdkMainThreadWorker
have been moved tocom.mapbox.search.common.concurrent
. - [CORE]
SearchRequestTask
has been replaced withAsyncOperationTask
- [CORE]
SearchSuggestion
is a class now. Functions signature ofSearchSuggestionsCallback
,SearchSelectionCallback
,SearchMultipleSelectionCallback
have been changed for Java users. - [CORE, UI] Offline functionality has been moved to a separate dependency which can be resolved via
com.mapbox.search:offline:$version
. Package name for offline functionality iscom.mapbox.search.offline
. At the moment Offline SDK version is the same as the main Search SDK version.OfflineSearchEngine
instance can be retrieved viaOfflineSearchEngine.create(OfflineSearchEngineSettings)
. - [UI]
SearchResultsView.SearchListener.onOfflineSearchResults()
signature has been changed toonOfflineSearchResults(List<OfflineSearchResult>m OfflineResponseInfo)
. Also, a new functionSearchResultsView.SearchListener.onOfflineSearchResult()
has been added.
New features
- [CORE]
FeedbackEvent.FeedbackReason
now has few more reasons that can be used in the feedback:INCORRECT_PHONE_NUMBER
, andINCORRECT_RESULT_RANK
. - [UI] A new function
SearchPlace.createFromOfflineSearchResult()
is available.
Bug fixes
- [UI] Now created in the
SearchPlaceBottomSheetView
FavoriteRecord
will be saved with id fromSearchPlace.id
Mapbox dependencies
- Search Native SDK
0.59.0
- Common SDK
23.0.0
- Kotlin
1.5.31
1.0.0-beta.35
1.0.0-beta.35
Breaking changes
- [UI] Now
SearchPlace
constructor requires additional propertyid
.copy()
function's signature has also been changed.
New features
- [CORE] SearchResultType provides a new value -
BLOCK
which represents the block number. Available specifically for Japan.
Mapbox dependencies
- Search Native SDK
0.58.0
- Common SDK
23.0.0-beta.1
- Kotlin
1.5.31
1.0.0-beta.34
1.0.0-beta.34
Breaking changes
- [CORE] Undocumented system property used to enable SBS API Type is deprecated. Use
MapboxSearchSdk.createSearchEngine(ApiType, SearchEngineSettings)
, andMapboxSearchSdk.createSearchEngineWithBuiltInDataProviders(ApiType, SearchEngineSettings)
instead. Note that SBS Api Type is still in beta and not available publicly. - [AUTOFILL]
AddressAutofill.suggestions(String, AddressAutofillOptions)
has been replaced withAddressAutofill.suggestions(Query, AddressAutofillOptions)
. CallQuery.create()
to create an instance ofQuery
.
New features
- [CORE]
MapboxSearchSdk.createSearchEngine(ApiType, SearchEngineSettings)
, andMapboxSearchSdk.createSearchEngineWithBuiltInDataProviders(ApiType, SearchEngineSettings)
functions are available that allow to choose API Type. Note thatApiType.GEOCODING
is the only API Type available publicly. - [UI]
SearchResultsView.Configuration
accepts a new optional argumentapiType
used for theSearchEngine
initialization.
Mapbox dependencies
- Search Native SDK
0.57.0
- Common SDK
22.1.0-beta.1
- Kotlin
1.5.31
1.0.0-beta.33.1
1.0.0-beta.33.1
New features
- [CORE] Now
RequestOptions
provides new fieldsendpoint
andsessionID
.
Bug fixes
- [CORE] Now
SearchAddress.formattedAddress(FormatStyle.Medium)
for address with countryUnited States
includes region.
Mapbox dependencies
- Search Native SDK
0.57.0
- Common SDK
22.1.0-beta.1
- Kotlin
1.5.31
1.0.0-beta.33
1.0.0-beta.33
Breaking changes
- [CORE]
ServiceProvider.analyticsService()
function has been removed. NowAnalyticsService
instance is associated withSearchEngine
, andOfflineSearchEngine
.AnalyticsService
can be retrieved fromSearchEngine.analyticsService
, andOfflineSearchEngine.analyticsService
. - [CORE]
ServiceProvider.locationEngine()
function has been removed. NowLocationEngine
instance can be retrieved from settings used for search engines instantiation. - [CORE]
SearchSdkSettings
class has been removed. Now default max number of history records is always 100. - [CORE] Now
SearchEngineSettings
andOfflineSearchEngineSettings
accept new constructor parameters.OfflineSearchEngineSettings.copy()
function's signature andOfflineSearchEngineSettings.Builder
have also been changed.SearchEngineSettings
providesSearchEngineSettings.Builder
type and newcopy()
andtoBuilder()
functions. - [CORE]
MapboxSearchSdk.initialize()
function has been removed. Now it's not needed to initialize Search SDK explicitly. - [CORE]
MapboxSearchSdk.setAccessToken()
function has been removed. Now in case of changed token a new instance ofSearchEngine
orOfflineSearchEngine
should be created. - [CORE]
MapboxSearchSdk.getSearchEngine()
function has been removed, callMapboxSearchSdk.createSearchEngine()
function instead. - [CORE]
MapboxSearchSdk.createSearchEngine()
function without parameters has been removed. NowSearchEngineSettings
should always be provided as an argument. - [CORE]
MapboxSearchSdk.getOfflineSearchEngine()
function has been removed, callMapboxSearchSdk.createOfflineSearchEngine()
function instead. - [CORE]
OfflineSearchEngine.tileStore
property has been removed, callOfflineSearchEngine.settings.tileStore
instead. - [CORE] Now
ApiType
has a newAUTOFILL
constant. - [UI]
SearchResultsView.initialize()
now acceptsSearchResultsView.Configuration
object. - [UI]
SearchBottomSheetView
,SearchCategoriesBottomSheetView
,SearchFeedbackBottomSheetView
views are not supported anymore. These views and their nested types have been removed from the Search SDK. Also, unused types such asIncorrectSearchPlaceFeedback
,FavoriteTemplate
,Category
are not available either. - [UI]
IncorrectSearchPlaceFeedback
has been moved tocom.mapbox.search.ui.view.place
package. - [AUTOFILL]
AddressAutofill.create(searchEngine: SearchEngine)
has been replaced withAddressAutofill.create(context: Context, accessToken: String)
. - [AUTOFILL]
AddressAutofillOptions.countries
now is a list ofAddressAutofillOptions.Country
values andAddressAutofillOptions.language
isAddressAutofillOptions.Language
value. - [AUTOFILL]
AddressAutofillResult.address
now is an instance ofAddressAutofillResult.Address
type.
New features
- [CORE]
SearchEngine
andOfflineSearchEngine
providesettings
property that return settings object used for engine initialization. - [UI] Now clicked by a user in
SearchResultsView
search results will be automatically added to the search history. - [AUTOFILL] Now autofill works on top of the special-purpose version of the Geocoding V5 API.
Mapbox dependencies
- Search Native SDK
0.57.0
- Common SDK
22.1.0-beta.1
- Kotlin
1.5.31
1.0.0-beta.32
1.0.0-beta.32
Same release as 1.0.0-beta.31
but with Common SDK 22.0.0
.
Mapbox dependencies
- Search Native SDK
0.56.0
- Common SDK
22.0.0
- Kotlin
1.5.31
1.0.0-beta.31
1.0.0-beta.31
Breaking changes
- [CORE]
OfflineSearchEngine
is a 1-step search now, which means thatSearchResult
's returned in the first step withoutSearchSuggestion
selection.OfflineSearchEngine.select()
function has been removed.OfflineSearchEngine.search()
acceptsSearchCallback
callback type. - [CORE] Now automatically cancelled by the Search SDK search requests made to the
SearchEngine
andOfflineSearchEngine
will be passingSearchCancellationException
to the corresponding callbacks ofSearchCallback
,SearchSuggestionsCallback
, andSearchSelectionCallback
. - [UI] Now
SearchResultsView.SearchListener
has a new functiononOfflineSearchResults()
.
New features
- [CORE] Autofill SDK prototype is available now.
- [CORE] Now
SearchResult
provides a newaccuracy
field which is a point accuracy metric for the returned address.
Bug fixes
- [CORE] Fixed a bug in the previous version of the Search SDK which didn't include http service implementation by default.
Mapbox dependencies
- Search Native SDK
0.55.0
- Common SDK
21.3.0
- Kotlin
1.5.31
1.0.0-beta.30
1.0.0-beta.30
Breaking changes
- [CORE]
IndexableDataProvider.add()
, andIndexableDataProvider.update()
have been replaced with a new functionIndexableDataProvider.upsert()
. - [CORE]
IndexableDataProvider.addAll()
has been renamed toIndexableDataProvider.upsertAll()
. - [CORE]
IndexableDataProviderEngine.add()
, andIndexableDataProviderEngine.update()
have been replaced with a new functionIndexableDataProviderEngine.upsert()
. - [CORE]
IndexableDataProviderEngine.addAll()
has been renamed toIndexableDataProviderEngine.upsertAll()
. - [CORE]
IndexableDataProviderEngine.executeBatchUpdate()
has been removed along withIndexableDataProviderEngine.BatchUpdateOperation
. NowIndexableDataProviderEngine
is a thread-safe entity. If you need multiple operations to be executed one after another, call them in a needed order on the same thread. - [CORE]
AnalyticsService.sendRawFeedbackEvent()
has been removed. Events should be sent immediately. - [CORE]
AnalyticsService.createRawFeedbackEvent()
functions have been made asynchronous and marked as deprecated. These functions return raw events in a very specific format and should not be used.
Mapbox dependencies
- Search Native SDK
0.54.1
- Common SDK
21.3.0
- Kotlin
1.5.31
1.0.0-beta.29.1
1.0.0-beta.29.1
New features
- [CORE]
SearchResult
andSearchSuggestion
now provideexternalIDs
property.
Mapbox dependencies
- Search Native SDK
0.52.0
- Common SDK
21.3.0-rc.2
- Telemetry SDK
8.1.1
- Kotlin
1.5.31
1.0.0-beta.29
1.0.0-beta.29
Breaking changes
- [CORE]
ServiceProvider.globalDataProvidersRegistry()
has been removed. Now customers should useSearchEngine.registerDataProvider()
for the data providers registration. InterfaceIndexableDataProvidersRegistry
and its internal classes are not available anymore either. - [CORE] Now
IndexableDataProvider
s should providepriority
field which affectsIndexableRecord
's ranking in case of multiple data providers added to a search engine. - [CORE]
IndexableDataProviderEngineLayer
has been renamed toIndexableDataProviderEngine
. Also, functionsregisterIndexableDataProviderEngineLayer()
andunregisterIndexableDataProviderEngineLayer()
ofIndexableDataProvider
have been renamed toregisterIndexableDataProviderEngine()
andunregisterIndexableDataProviderEngine()
. - [CORE] Functionality of
CategorySearchEngine
, andReverseGeocodingSearchEngine
have been merged intoSearchEngine
. Also, functionsMapboxSearchSdk.getCategorySearchEngine()
,MapboxSearchSdk.getReverseGeocodingSearchEngine()
have been removed, callMapboxSearchSdk.getSearchEngine()
orMapboxSearchSdk.createSearchEngine()
instead. - [CORE] Constants
MapboxSearchSdk.LAYER_PRIORITY_HISTORY
,MapboxSearchSdk.LAYER_PRIORITY_FAVORITES
have been movedHistoryDataProvider.PROVIDER_PRIORITY
, andFavoritesDataProvider.PROVIDER_PRIORITY
. - [CORE]
MapboxSearchSdk.addDataProviderInitializationCallback()
andMapboxSearchSdk.removeDataProviderInitializationCallback()
have been removed along withDataProviderInitializationCallback
interface. UseHistoryDataProvider.OnDataProviderEngineRegisterListener()
, andFavoritesDataProvider.OnDataProviderEngineRegisterListener()
instead. - [CORE] Fields
SearchSdkSettings.geocodingEndpointBaseUrl
, andSearchSdkSettings.singleBoxSearchBaseUrl
have been removed. Now you can configure search engine endpoints withSearchEngineSettings
.SearchSdkSettings.Builder
and corresponding functions have also been removed.MapboxSearchSdk.initialize()
now can acceptSearchEngineSettings
. - [CORE] Class
OfflineSearchSettings
has been renamed toOfflineSearchEngineSettings
.MapboxSearchSdk.initialize()
argumentofflineSearchSettings
has also been renamed toofflineSearchEngineSettings
.
New features
- [CORE] Now customers can create several independent from each other
SearchEngine
s. SeeMapboxSearchSdk.createSearchEngine()
. - [CORE] Now
SearchRequestTask
providesisDone
, andisCancelled
properties.
Mapbox dependencies
- Search Native SDK
0.52.0
- Common SDK
21.3.0-rc.2
- Telemetry SDK
8.1.1
- Kotlin
1.5.31