Class IdentificationSearch

An IdentificationSearch is a set of parameters for searching iNaturalist Identifications. Usage: myINatManager.SearchIdentifications(myIdentificationSearch)

Inheritance

Object

SearchObject

IdentificationSearch

Inherited Members

SearchObject.boolParams

SearchObject.stringParams

SearchObject.SetBooleanParameter(SearchObject.BooleanParameter, Boolean)

SearchObject.RemoveBooleanParameter(SearchObject.BooleanParameter)

SearchObject.SetStringParameter(SearchObject.StringParameter, String)

SearchObject.RemoveStringParameter(SearchObject.StringParameter)

SearchObject.ToUrlParameters()

Namespace: JoshAaronMiller.INaturalist

Assembly: cs.temp.dll.dll

Syntax

public class IdentificationSearch : SearchObject

Methods

ExcludeObservationTaxonIds(List<Int32>)

Limit the search to exclude identifications of observations with taxa IDs and their descendents.

Declaration

public void ExcludeObservationTaxonIds(List<int> ids)

Parameters

Type	Name	Description
List<Int32>	ids	Observation taxa IDs to exclude

ExcludeTaxonIds(List<Int32>)

Limit the search to exclude these taxa IDs and their descendents.

Declaration

public void ExcludeTaxonIds(List<int> ids)

Parameters

Type	Name	Description
List<Int32>	ids	Taxa IDs to exclude

IncludeCategories(List<String>)

Limit the search to identifications with these category labels.

Declaration

public void IncludeCategories(List<string> categories)

Parameters

Type	Name	Description
List<String>	categories	The identification categories to include in the search.

IncludeIconicTaxonIds(List<Int32>)

Limit the search to identifications with these iconic taxa.

Declaration

public void IncludeIconicTaxonIds(List<int> ids)

Parameters

Type	Name	Description
List<Int32>	ids	Iconic taxa IDs to include

IncludeIdentificationsByUserId(List<Int32>)

Limit the search to identifications made by users of these IDs.

Declaration

public void IncludeIdentificationsByUserId(List<int> userIds)

Parameters

Type	Name	Description
List<Int32>	userIds	The list of user IDs; limit the search to their identifications.

IncludeIdentificationsByUserLogin(List<Int32>)

Limit the search to identifications made by users with these login names.

Declaration

public void IncludeIdentificationsByUserLogin(List<int> userLogins)

Parameters

Type	Name	Description
List<Int32>	userLogins	The list of usernames; limit the search to their identifications.

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

IncludeObservationIconicTaxonIds(List<Int32>)

Limit the search to identifications of observations with these iconic taxa.

Declaration

public void IncludeObservationIconicTaxonIds(List<int> ids)

Parameters

Type	Name	Description
List<Int32>	ids	Observation iconic taxa IDs to include

IncludeObservationTaxonIds(List<Int32>)

Limit the search to observations with these taxa IDs and their descendents.

Declaration

public void IncludeObservationTaxonIds(List<int> ids)

Parameters

Type	Name	Description
List<Int32>	ids	Observation taxa IDs to include

IncludeObservationTaxonRanks(List<TaxonRank>)

Limit the search to identifications of observations that have a taxon of these ranks.

Declaration

public void IncludeObservationTaxonRanks(List<TaxonRank> ranks)

Parameters

Type	Name	Description
List<TaxonRank>	ranks	The list of observation taxon ranks to include in the search.

IncludePlaceIds(List<Int32>)

Require the observations to be within these place IDs.

Declaration

public void IncludePlaceIds(List<int> ids)

Parameters

Type	Name	Description
List<Int32>	ids	Place IDs to require

IncludeTaxonIds(List<Int32>)

Limit the search to these taxa IDs and their descendents.

Declaration

public void IncludeTaxonIds(List<int> ids)

Parameters

Type	Name	Description
List<Int32>	ids	Taxa IDs to include

IncludeTaxonRanks(List<TaxonRank>)

Limit the search to identifications of 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.

SetCreatedOnDateLimits(String, String)

Limit the search to identifications created within a timeframe. Both start and end dates are optional.

Declaration

public void SetCreatedOnDateLimits(string start = "", string end = "")

Parameters

Type	Name	Description
String	start	The start date, formatted as YYYY-MM-DD. Limit identifications created on or after this date.
String	end	The end date, formatted as YYYY-MM-DD. Limit identifications created on or before this date.

SetIdentificationnIdLimits(Int32, Int32)

Limit the search to identifications with IDs within this range. Both min and max are optional.

Declaration

public void SetIdentificationnIdLimits(int min = -1, int max = -1)

Parameters

Type	Name	Description
Int32	min	Include this ID and higher.
Int32	max	Include this ID and lower.

SetObservationCreatedOnDateLimits(String, String)

Limit the search to identifications of observations created within a timeframe. Both start and end dates are optional.

Declaration

public void SetObservationCreatedOnDateLimits(string start = "", string end = "")

Parameters

Type	Name	Description
String	start	The start date, formatted as YYYY-MM-DD. Limit identifications to observations created on or after this date.
String	end	The end date, formatted as YYYY-MM-DD. Limit identifications to observations created on or before this date.

SetObservationTaxonRankLimits(TaxonRank, TaxonRank)

Limit the search to identifications of observations with taxa between these limits.

Declaration

public void SetObservationTaxonRankLimits(TaxonRank lowest = TaxonRank.None, TaxonRank highest = TaxonRank.None)

Parameters

Type	Name	Description
TaxonRank	lowest	The lowest observation taxon rank to include in the search (include this and higher).
TaxonRank	highest	The highest observation taxon rank to include in the search (include this and lower).

SetObservedOnDateLimits(String, String)

Limit the search to observations observed within a timeframe. Both start and end dates are optional.

Declaration

public void SetObservedOnDateLimits(string start = "", string end = "")

Parameters

Type	Name	Description
String	start	The start date, formatted as YYYY-MM-DD. Limit observations to on or after this date.
String	end	The end date, formatted as YYYY-MM-DD. Limit observations to on or before this date.

SetOrder(OrderBy, SortOrder)

Set how the results are ordered. Defaults to created at date, descending.

Declaration

public void SetOrder(OrderBy orderBy, SortOrder sortOrder)

Parameters

Type	Name	Description
OrderBy	orderBy	The parameter to sort the order by.
SortOrder	sortOrder	Whether to sort ascending or descending.

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).

SetQualityGrade(QualityGrade)

Limit the search to observations of this quality grade.

Declaration

public void SetQualityGrade(QualityGrade quality)

Parameters

Type	Name	Description
QualityGrade	quality	The quality grade to search for.

SetTaxonRankLimits(TaxonRank, TaxonRank)

Limit the search to taxa between these limits.

Declaration

public void SetTaxonRankLimits(TaxonRank lowest = TaxonRank.None, TaxonRank highest = TaxonRank.None)

Parameters

Type	Name	Description
TaxonRank	lowest	The lowest taxon rank to include in the search (include this and higher).
TaxonRank	highest	The highest taxon rank to include in the search (include this and lower).