Add following dependency to application's build.gradle file.
compile ('com.yahoo.search:yhssdk:0.4.3')
0.4.3 is the latest stable version.
//Set Search settings.
// This initialization can be done in UI thread or background thread. It is meant for global settings and ideally doing it in Application class is a good practice.
SearchSDKSettings.Builder builder = new SearchSDKSettings.Builder(STRING_HSPART, STRING_HSIMP);
builder.setAppId(STRING_APP_ID); // Optional setting to enable Trending Now (search buzz) in Search Assist tray.
static final int REQUEST_CODE_SEARCH = 1001;
static final int LOCAL_HISTORY_NUM = 11;
//Setup SearchActivity Builder.
SearchActivity.IntentBuilder builder = new SearchActivity.IntentBuilder();
//builder.setQueryString("flower"); //Optional pre-query.
builder.setNumberOfHistoryItems(LOCAL_HISTORY_NUM);
builder.showAppSuggestions(true);
builder.showContactSuggestions(true);
//builder.setSearchResultClickListener(this);//If developers want to handle search result click.
//builder.enableWebPreview(false); // disable preview activity when search results are clicked.
//mBuilder.launchWithSuggestions(true);//If SA should be shown when the search Activity is launched.
/**
* To disable image/video verticals. Web is mandatory for now.
*/
//builder.enableImageSearch(false);
//builder.enableVideoSearch(false);
//builder.enableLocalSearch(false);
Intent i = builder.buildIntent(this);
startActivityForResult(i, REQUEST_CODE_SEARCH);
Create a custom view class that implements ISearchViewHolder. Refer CustomSearchBar.java for sample implementation in the demo app. Add this custom view to xml layout resource in your app. Pass this layout to sdk using the SearchActivity.IntentBuilder as below.
SearchActivity.IntentBuilder builder = new SearchActivity.IntentBuilder();
builder.setCustomSearchBar(R.layout.custom_search_bar);
The TabLayout for verticals can be customized by overriding the style - Yhssdk_TabLayout. Refer styles.xml in the demo app. All the xml attributes of TabLayout are supported.
<style name="Yhssdk_TabLayout" parent="Base.Widget.Design.TabLayout">
<item name="tabIndicatorColor">@color/button_material_light</item>
</style>
Refer custom_search_assist_item.xml. Create a Data binding layout file and pass this layout to sdk using the SearchActivity.IntentBuilder as below. The data binding variables used in the layout file are described below.
SearchActivity.IntentBuilder builder = new SearchActivity.IntentBuilder();
builder.setCustomSearchAssist(R.layout.custom_search_assist_item);
The search assist data object. Below are the list of fields that can be used in layout file.
- type - Integer constant that specifies the suggestion type. Below are the different types of suggestions.
SEARCH_HISTORY - The suggestion is a history item from the user previous query searches.
SEARCH_APPS - App suggestion from the phone that matches the user query.
SEARCH_CONTACTS - Contact suggestion from the phone that matches the user query.
SEARCH_SUGGEST - Typical query suggestion
LOCAL_WEB - similar to SEARCH_HISTORY.
SEARCH_TRENDING - Trending suggestion.
SHOW_ALL_HISTORY - Show all history.
CLEAR_HISTORY - Clear all history.
SECTION_DIVIDER - The section divider between different types of suggestions like Apps,Contacts,history etc.
- label - The actual search suggestion text.
- icon - The icon to be used for SEARCH_APPS and SEARCH_CONTACTS suggestion.
Below are the two click handlers that needs to be registered in layout.
onAppendSuggestionItem - callback for the query builder click event. SDK uses this callback to build the query. onClickAssistItem - callback for the click of search assist item.
SDK picks up the locale from the System Language Settings but it can be overridden as below. The fallback locale is en_US if the override locale (or System locale) is not supported by SDK. Please note that override feature is available only on API 17 and above.
SearchSDKSettings.Builder builder = new SearchSDKSettings.Builder(STRING_HSPART, STRING_HSIMP);
builder.setLocale(new Locale("de", "DE"));;
Below are the list of locales supported by SDK.
| Countries | Countries |
|---|---|
| Argentina (Spanish) | New Zealand (English) |
| Australia (English) | Norway (Norwegian) |
| Austria (German) | Peru (Spanish) |
| Brazil (Portuguese) | Poland (Polish) |
| Canada (English) | Philippines (English) |
| Canada (French) | Romania (Romanian) |
| Denmark (Danish) | Russia (Russian) |
| Colombia (Spanish) | Singapore (English) |
| Finland (Finnish) | Spain (Spanish) |
| Chile (Spanish) | Sweden (Swedish) |
| France (French) | Switzerland (French) |
| Germany (German) | Switzerland (German) |
| Greece (Greek) | Switzerland (Italian) |
| Hong Kong (Simplified Chinese) | Taiwan (Traditional Chinese) |
| India (English) | Turkey (Turkish) |
| Indonesia (English) | Thailand (Thai) |
| Italy (Italian) | Venezuela (Spanish) |
| Maktoob (English) | Vietnam (Vietnamese) |
| Malaysia (English) | United Kingdom & Ireland (English) |
| Mexico (Spanish) | United States (English) |
| Netherlands (Dutch) | United States (Spanish) - Espanol (E1) |