Skip to content
This repository was archived by the owner on Jan 31, 2022. It is now read-only.

Commit fb4d042

Browse files
algoliareadmebotalgoliareadmebot
committed
docs(README): automatic update
 Update README Android [ci skip]
1 parent 425482e commit fb4d042

File tree

1 file changed

+121
-121
lines changed

1 file changed

+121
-121
lines changed

‎README.md‎

Lines changed: 121 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -280,58 +280,58 @@ Here is the list of parameters you can use with the search method (`search` [sco
280280
Parameters that can also be used in a setSettings also have the `indexing` [scope](#scope)
281281

282282
**Search**
283-
[query](#query) `search`
283+
- [query](#query) `search`
284284

285285
**Attributes**
286-
[attributesToRetrieve](#attributestoretrieve) `settings`, `search`
286+
- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
287287

288288
**Filtering / Faceting**
289-
[filters](#filters) `search`
290-
[facets](#facets) `search`
291-
[maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
289+
- [filters](#filters) `search`
290+
- [facets](#facets) `search`
291+
- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
292292

293293
**Highlighting / Snippeting**
294-
[attributesToHighlight](#attributestohighlight) `settings`, `search`
295-
[attributesToSnippet](#attributestosnippet) `settings`, `search`
296-
[highlightPreTag](#highlightpretag) `settings`, `search`
297-
[highlightPostTag](#highlightposttag) `settings`, `search`
298-
[snippetEllipsisText](#snippetellipsistext) `settings`, `search`
294+
- [attributesToHighlight](#attributestohighlight) `settings`, `search`
295+
- [attributesToSnippet](#attributestosnippet) `settings`, `search`
296+
- [highlightPreTag](#highlightpretag) `settings`, `search`
297+
- [highlightPostTag](#highlightposttag) `settings`, `search`
298+
- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
299299

300300
**Pagination**
301-
[page](#page) `search`
302-
[hitsPerPage](#hitsperpage) `settings`, `search`
301+
- [page](#page) `search`
302+
- [hitsPerPage](#hitsperpage) `settings`, `search`
303303

304304
**Typos**
305-
[minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
306-
[minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
307-
[typoTolerance](#typotolerance) `settings`, `search`
308-
[allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
309-
[ignorePlurals](#ignoreplurals) `settings`, `search`
310-
[disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
305+
- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
306+
- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
307+
- [typoTolerance](#typotolerance) `settings`, `search`
308+
- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
309+
- [ignorePlurals](#ignoreplurals) `settings`, `search`
310+
- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
311311

312312
**Geo-Search**
313-
[aroundLatLng](#aroundlatlng) `search`
314-
[aroundLatLngViaIP](#aroundlatlngviaip) `search`
315-
[insideBoundingBox](#insideboundingbox) `search`
316-
[insidePolygon](#insidepolygon) `search`
313+
- [aroundLatLng](#aroundlatlng) `search`
314+
- [aroundLatLngViaIP](#aroundlatlngviaip) `search`
315+
- [insideBoundingBox](#insideboundingbox) `search`
316+
- [insidePolygon](#insidepolygon) `search`
317317

318318

319319
**Query Strategy**
320-
[queryType](#querytype) `settings`, `search`
321-
[removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
322-
[advancedSyntax](#advancedsyntax) `settings`, `search`
323-
[optionalWords](#optionalwords) `settings`, `search`
324-
[removeStopWords](#removestopwords) `settings`, `search`
325-
[exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
326-
[alternativesAsExact](#alternativesasexact) `settings`, `search`
320+
- [queryType](#querytype) `settings`, `search`
321+
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
322+
- [advancedSyntax](#advancedsyntax) `settings`, `search`
323+
- [optionalWords](#optionalwords) `settings`, `search`
324+
- [removeStopWords](#removestopwords) `settings`, `search`
325+
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
326+
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
327327

328328
**Advanced**
329-
[distinct](#distinct) `settings`, `search`
330-
[rankingInfo](#rankinginfo) `search`
331-
[numericFilters (deprecated)](#numericfilters-deprecated) `search`
332-
[tagFilters (deprecated)](#tagfilters-deprecated) `search`
333-
[facetFilters (deprecated)](#facetfilters-deprecated) `search`
334-
[analytics](#analytics) `search`
329+
- [distinct](#distinct) `settings`, `search`
330+
- [rankingInfo](#rankinginfo) `search`
331+
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
332+
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
333+
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
334+
- [analytics](#analytics) `search`
335335

336336
<!--/PARAMETERS_LINK-->
337337

@@ -614,56 +614,56 @@ Here is the list of parameters you can use with the set settings method (`indexi
614614
Parameters that can be override at search time also have the `indexing` [scope](#scope)
615615
616616
**Attributes**
617-
[attributesToIndex](#attributestoindex) `settings`
618-
[attributesForFaceting](#attributesforfaceting) `settings`
619-
[attributesToRetrieve](#attributestoretrieve) `settings`, `search`
620-
[unretrievableAttributes](#unretrievableattributes) `settings`
617+
- [attributesToIndex](#attributestoindex) `settings`
618+
- [attributesForFaceting](#attributesforfaceting) `settings`
619+
- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
620+
- [unretrievableAttributes](#unretrievableattributes) `settings`
621621
622622
**Ranking**
623-
[ranking](#ranking) `settings`
624-
[customRanking](#customranking) `settings`
625-
[slaves](#slaves) `settings`
623+
- [ranking](#ranking) `settings`
624+
- [customRanking](#customranking) `settings`
625+
- [slaves](#slaves) `settings`
626626
627627
**Filtering / Faceting**
628-
[maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
628+
- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
629629
630630
**Highlighting / Snippeting**
631-
[attributesToHighlight](#attributestohighlight) `settings`, `search`
632-
[attributesToSnippet](#attributestosnippet) `settings`, `search`
633-
[highlightPreTag](#highlightpretag) `settings`, `search`
634-
[highlightPostTag](#highlightposttag) `settings`, `search`
635-
[snippetEllipsisText](#snippetellipsistext) `settings`, `search`
631+
- [attributesToHighlight](#attributestohighlight) `settings`, `search`
632+
- [attributesToSnippet](#attributestosnippet) `settings`, `search`
633+
- [highlightPreTag](#highlightpretag) `settings`, `search`
634+
- [highlightPostTag](#highlightposttag) `settings`, `search`
635+
- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
636636
637637
**Pagination**
638-
[hitsPerPage](#hitsperpage) `settings`, `search`
638+
- [hitsPerPage](#hitsperpage) `settings`, `search`
639639
640640
**Typos**
641-
[minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
642-
[minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
643-
[typoTolerance](#typotolerance) `settings`, `search`
644-
[allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
645-
[ignorePlurals](#ignoreplurals) `settings`, `search`
646-
[disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
647-
[separatorsToIndex](#separatorstoindex) `settings`
641+
- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
642+
- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
643+
- [typoTolerance](#typotolerance) `settings`, `search`
644+
- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
645+
- [ignorePlurals](#ignoreplurals) `settings`, `search`
646+
- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
647+
- [separatorsToIndex](#separatorstoindex) `settings`
648648
649649
**Query Strategy**
650-
[queryType](#querytype) `settings`, `search`
651-
[removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
652-
[advancedSyntax](#advancedsyntax) `settings`, `search`
653-
[optionalWords](#optionalwords) `settings`, `search`
654-
[removeStopWords](#removestopwords) `settings`, `search`
655-
[disablePrefixOnAttributes](#disableprefixonattributes) `settings`
656-
[disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
657-
[exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
658-
[alternativesAsExact](#alternativesasexact) `settings`, `search`
650+
- [queryType](#querytype) `settings`, `search`
651+
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
652+
- [advancedSyntax](#advancedsyntax) `settings`, `search`
653+
- [optionalWords](#optionalwords) `settings`, `search`
654+
- [removeStopWords](#removestopwords) `settings`, `search`
655+
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
656+
- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
657+
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
658+
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
659659
660660
**Advanced**
661-
[attributeForDistinct](#attributefordistinct) `settings`
662-
[distinct](#distinct) `settings`, `search`
663-
[numericAttributesToIndex](#numericattributestoindex) `settings`
664-
[allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
665-
[altCorrections](#altcorrections) `settings`
666-
[placeholders](#placeholders) `settings`
661+
- [attributeForDistinct](#attributefordistinct) `settings`
662+
- [distinct](#distinct) `settings`, `search`
663+
- [numericAttributesToIndex](#numericattributestoindex) `settings`
664+
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
665+
- [altCorrections](#altcorrections) `settings`
666+
- [placeholders](#placeholders) `settings`
667667
668668
<!--/PARAMETERS_LINK-->
669669
@@ -686,77 +686,77 @@ They are three scopes:
686686
#### Parameters List
687687
688688
**Search**
689-
[query](#query) `search`
689+
- [query](#query) `search`
690690
691691
**Attributes**
692-
[attributesForFaceting](#attributesforfaceting) `settings`
693-
[attributesToIndex](#attributestoindex) `settings`
694-
[attributesToRetrieve](#attributestoretrieve) `settings`, `search`
695-
[unretrievableAttributes](#unretrievableattributes) `settings`
692+
- [attributesForFaceting](#attributesforfaceting) `settings`
693+
- [attributesToIndex](#attributestoindex) `settings`
694+
- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
695+
- [unretrievableAttributes](#unretrievableattributes) `settings`
696696
697697
698698
**Ranking**
699-
[ranking](#ranking) `settings`
700-
[customRanking](#customranking) `settings`
701-
[slaves](#slaves) `settings`
699+
- [ranking](#ranking) `settings`
700+
- [customRanking](#customranking) `settings`
701+
- [slaves](#slaves) `settings`
702702
703703
**Filtering / Faceting**
704-
[filters](#filters) `search`
705-
[facets](#facets) `search`
706-
[maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
704+
- [filters](#filters) `search`
705+
- [facets](#facets) `search`
706+
- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
707707
708708
**Highlighting / Snippeting**
709-
[attributesToHighlight](#attributestohighlight) `settings`, `search`
710-
[attributesToSnippet](#attributestosnippet) `settings`, `search`
711-
[highlightPreTag](#highlightpretag) `settings`, `search`
712-
[highlightPostTag](#highlightposttag) `settings`, `search`
713-
[snippetEllipsisText](#snippetellipsistext) `settings`, `search`
714-
[restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
709+
- [attributesToHighlight](#attributestohighlight) `settings`, `search`
710+
- [attributesToSnippet](#attributestosnippet) `settings`, `search`
711+
- [highlightPreTag](#highlightpretag) `settings`, `search`
712+
- [highlightPostTag](#highlightposttag) `settings`, `search`
713+
- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
714+
- [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
715715
716716
**Pagination**
717-
[page](#page) `search`
718-
[hitsPerPage](#hitsperpage) `settings`, `search`
717+
- [page](#page) `search`
718+
- [hitsPerPage](#hitsperpage) `settings`, `search`
719719
720720
**Typos**
721-
[minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
722-
[minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
723-
[typoTolerance](#typotolerance) `settings`, `search`
724-
[allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
725-
[ignorePlurals](#ignoreplurals) `settings`, `search`
726-
[disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
727-
[separatorsToIndex](#separatorstoindex) `settings`
721+
- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
722+
- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
723+
- [typoTolerance](#typotolerance) `settings`, `search`
724+
- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
725+
- [ignorePlurals](#ignoreplurals) `settings`, `search`
726+
- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
727+
- [separatorsToIndex](#separatorstoindex) `settings`
728728
729729
**Geo-Search**
730730
731-
[aroundLatLng](#aroundlatlng) `search`
732-
[aroundLatLngViaIP](#aroundlatlngviaip) `search`
733-
[insideBoundingBox](#insideboundingbox) `search`
734-
[insidePolygon](#insidepolygon) `search`
731+
- [aroundLatLng](#aroundlatlng) `search`
732+
- [aroundLatLngViaIP](#aroundlatlngviaip) `search`
733+
- [insideBoundingBox](#insideboundingbox) `search`
734+
- [insidePolygon](#insidepolygon) `search`
735735
736736
737737
**Query Strategy**
738-
[queryType](#querytype) `settings`, `search`
739-
[removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
740-
[advancedSyntax](#advancedsyntax) `settings`, `search`
741-
[optionalWords](#optionalwords) `settings`, `search`
742-
[removeStopWords](#removestopwords) `settings`, `search`
743-
[disablePrefixOnAttributes](#disableprefixonattributes) `settings`
744-
[disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
745-
[exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
746-
[alternativesAsExact](#alternativesasexact) `settings`, `search`
738+
- [queryType](#querytype) `settings`, `search`
739+
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
740+
- [advancedSyntax](#advancedsyntax) `settings`, `search`
741+
- [optionalWords](#optionalwords) `settings`, `search`
742+
- [removeStopWords](#removestopwords) `settings`, `search`
743+
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
744+
- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
745+
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
746+
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
747747
748748
**Advanced**
749-
[attributeForDistinct](#attributefordistinct) `settings`
750-
[distinct](#distinct) `settings`, `search`
751-
[rankingInfo](#rankinginfo) `search`
752-
[numericAttributesToIndex](#numericattributestoindex) `settings`
753-
[allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
754-
[numericFilters (deprecated)](#numericfilters-deprecated) `search`
755-
[tagFilters (deprecated)](#tagfilters-deprecated) `search`
756-
[facetFilters (deprecated)](#facetfilters-deprecated) `search`
757-
[analytics](#analytics) `search`
758-
[altCorrections](#altcorrections) `settings`
759-
[placeholders](#placeholders) `settings`
749+
- [attributeForDistinct](#attributefordistinct) `settings`
750+
- [distinct](#distinct) `settings`, `search`
751+
- [rankingInfo](#rankinginfo) `search`
752+
- [numericAttributesToIndex](#numericattributestoindex) `settings`
753+
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
754+
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
755+
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
756+
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
757+
- [analytics](#analytics) `search`
758+
- [altCorrections](#altcorrections) `settings`
759+
- [placeholders](#placeholders) `settings`
760760
761761
### Search
762762

0 commit comments

Comments
 (0)