Pesquisa universal

O Android 8.0 adiciona mais recursos de pesquisa ao menu Configurações. Este document descreve como adicionar uma configuração e garantir que ela seja devidamente indexada na pesquisa de configurações.

Criar configurações indexáveis

Cada fragmento de configurações que precisa ser indexado implementa a interface Indexable E requer o campo estático: 

public static final SearchIndexProvider SEARCH_INDEX_DATA_PROVIDER

Depois de configurar o fragmento para indexação, adicione-o a SearchIndexableResources, encontrado em:
packages/apps/Settings/src/com/android/settings/search/SearchIndexableResources.java

Métodos opcionais

Essa interface SearchIndexProvider tem quatro métodos opcionais.

getXmlResourcesToIndex

  • Substitua esse valor se o conteúdo do fragmento for de: preference xml
  • Retorna uma preferência XML como uma lista a ser indexada.

Exemplo de recursos XML:

public List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled) {
    ArrayList<SearchIndexableResource> result =  new ArrayList<SearchIndexableResource>();
SearchIndexableResource sir = new SearchIndexableResource(context);
	sir.xmlResId = R.xml.display_settings;
	result.add(sir);

    return result;
}

getRawDataToIndex

  • Substitua este valor se o conteúdo do fragmento NÃO for de: preference xml
  • Retorna uma lista de dados brutos (SearchIndexableRaw) a serem indexados.

Exemplo de dados brutos:

public List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled) {
              final List<SearchIndexableRaw> result = new ArrayList<>();
              final Resources res = context.getResources();

              // Add fragment title
       SearchIndexableRaw data = new SearchIndexableRaw(context);
       data.title = res.getString(R.string.wifi_settings);
       data.screenTitle = res.getString(R.string.wifi_settings);
       data.keywords = res.getString(R.string.keywords_wifi);
       data.key = DATA_KEY_REFERENCE;
       result.add(data);

       return result;
}

getNonIndexableKeys

  • Se o fragmento for um DashboardFragment, raramente será necessário substituí-lo.
  • Retorna uma lista de chaves que correspondem a resultados que não devem aparecer para o usuário, dispositivo, configuração etc.As chaves fornecidas aqui precisam corresponder ao campo KEY em SearchIndexableResource e SearchIndexableRaw.
  • Por exemplo: o uso de dados não aparece para usuários que nunca tiveram um cartão SIM no dispositivo.

Exemplo de chaves não indexáveis:

public List<String> getNonIndexableKeys(Context context) {
      final List<String> keys = super.getNonIndexableKeys(context);
              if (!checkIntentAction(context, "android.settings.TERMS")) {
                  keys.add(KEY_TERMS);
              }
              if (!checkIntentAction(context, "android.settings.LICENSE")) {
                  keys.add(KEY_LICENSE);
              }
              if (!checkIntentAction(context, "android.settings.COPYRIGHT")) {
                  keys.add(KEY_COPYRIGHT);
              }
              if (!checkIntentAction(context, "android.settings.WEBVIEW_LICENSE")) {
                  keys.add(KEY_WEBVIEW_LICENSE);
              }
              return keys;
}

getPreferenceControllers

Retorna uma lista de controladores de preferências associados a esse fragmento. Essa lista é usada para formar resultados inline, atualizar elementos não indexáveis etc.

Portanto, tudo o que você quer que apareça na pesquisa precisa ser incluído em getXmlResourcesToIndex ou getRawDataToIndex.

Adicionar palavras-chave para suas configurações

Para garantir que uma configuração seja facilmente pesquisável, adicione palavras-chave relevantes que um usuário possa usar para pesquisar.

O que considerar ao adicionar palavras-chave:

  • As palavras-chave são uma lista de termos que o usuário não necessariamente vê, mas que podem fazer parte do modelo mental dele sobre como a configuração funciona.
  • São palavras que o usuário pode digitar para acessar a configuração.
  • Eles podem ser sinônimos ou qualquer palavra associada à configuração.
  • Por exemplo, "desativar som" pode ser usado para encontrar a configuração de volume.

Evite a duplicação

Se você estiver excluindo incondicionalmente uma página de configurações, remova a indexação da página original para evitar a duplicação de resultados.

  1. Encontre o PreferenceFragment da página que você está suprimindo.
  2. Remova o SearchIndexProvider.

Validação

Para testar a capacidade de pesquisa de uma nova configuração:

  1. Instale uma versão recente do O no dispositivo.
  2. Reindexe o banco de dados selecionando:
    3. Configurações > Apps e notificações > Informações do app > Configurações > Armazenamento > Limpar dados
  3. Verifique se as configurações de destino aparecem na pesquisa.
    A pesquisa de um prefixo do título de uma configuração vai corresponder a ela.

Estes testes roboelétricos podem ser executados para validar a implementação deste recurso:
packages/apps/Settings/tests/robotests/src/com/android/settings/search

O destino de build é: RunSettingsRoboTests