Class TaxonSearch
A TaxonSearch is a set of parameters for searching iNaturalist Taxa. Usage: myINatManager.SearchTaxa(myTaxonSearch)
Inherited Members
Namespace: JoshAaronMiller.INaturalist
Assembly: cs.temp.dll.dll
Syntax
public class TaxonSearch : SearchObjectMethods
IncludeIds(List<Int32>)
Require the search to include these IDs.
Declaration
public void IncludeIds(List<int> ids)Parameters
| Type | Name | Description |
|---|---|---|
| List<Int32> | ids | IDs to include |
IncludeTaxonRanks(List<TaxonRank>)
Limit the search to taxa of these ranks.
Declaration
public void IncludeTaxonRanks(List<TaxonRank> ranks)Parameters
| Type | Name | Description |
|---|---|---|
| List<TaxonRank> | ranks | The list of taxon ranks to include in the search. |
SetLocalePreference(String)
Set the locale preference for taxon common names.
Declaration
public void SetLocalePreference(string locale)Parameters
| Type | Name | Description |
|---|---|---|
| String | locale | The locale preference. |
Remarks
I'm not really sure what a valid input looks like.
SetNameBeginsWith(String)
Limit the search to taxa that begin with this substring
Declaration
public void SetNameBeginsWith(string query)Parameters
| Type | Name | Description |
|---|---|---|
| String | query | The start of the taxa names |
SetPagination(Int32, Int32)
Set the number of search results per page and which page to receive. For example, SetPagination(50,2) would return results 51-100.
Declaration
public void SetPagination(int resultsPerPage = 30, int page = 1)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | resultsPerPage | How many results to return per page (default 30). |
| Int32 | page | Which page of results to return (default 1). |
SetParentId(Int32)
Limit the search to children of this taxon ID.
Declaration
public void SetParentId(int parentId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | parentId | The parent taxon's ID |
SetPreferredPlaceId(Int32)
Set a place preference for regional taxon common names.
Declaration
public void SetPreferredPlaceId(int placeId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | placeId | The place ID of the preference. |
Remarks
I think this means that taxon common names will be based on the place specified.
SetTaxonIdLimits(Int32, Int32)
Limit the search to taxa with IDs within this range. Both min and max are optional.
Declaration
public void SetTaxonIdLimits(int min = -1, int max = -1)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | min | Include this ID and higher. |
| Int32 | max | Include this ID and lower. |
SetTaxonRankLevel(TaxonRankLevel)
Limit the search to taxa of this rank level.
Declaration
public void SetTaxonRankLevel(TaxonRankLevel rankLevel)Parameters
| Type | Name | Description |
|---|---|---|
| TaxonRankLevel | rankLevel | The rank level to limit the search to. |