Class BioBlitzes

Index

Constructors

Methods

list getForObservation get like unlike getCategoryStatistics

Constructors

constructor

new BioBlitzes(client: ObservationClient): BioBlitzes
Internal
Parameters
- client: ObservationClient
Returns BioBlitzes
- Defined in lib/bioblitzes.ts:15

Methods

list

list(params?: BioBlitzListParams): Promise<Paginated<BioBlitz>>
Fetches a list of relevant BioBlitzes for the user.

Contains BioBlitzes the user has liked and/or contributed to. When coordinates are supplied, it also contains BioBlitzes at or close to that position. Authentication is not required, but an authenticated request personalizes the user field on each BioBlitz.
Parameters
- Optionalparams: BioBlitzListParams
  Optional parameters, e.g. coordinates ("lat,lng").
Returns Promise<Paginated<BioBlitz>>
A promise that resolves to a paginated list of BioBlitz objects.

Throws
If the request fails.
- Defined in lib/bioblitzes.ts:31

getForObservation

getForObservation(observationId: number): Promise<Paginated<BioBlitz>>
Lists the BioBlitzes an observation contributes to.
Parameters
- observationId: number
  The unique identifier for the observation.
Returns Promise<Paginated<BioBlitz>>
A promise that resolves to a paginated list of BioBlitz objects.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/bioblitzes.ts:57

get

get(id: number): Promise<BioBlitz>
Fetches the details of a single BioBlitz by its id.

Authentication is not required. If the request is unauthenticated, the user field will be null.
Parameters
- id: number
  The unique identifier for the BioBlitz.
Returns Promise<BioBlitz>
A promise that resolves to the BioBlitz object.

Throws
If the request fails.
- Defined in lib/bioblitzes.ts:75

like

like(id: number): Promise<void>
Likes a BioBlitz for the authenticated user.
Parameters
- id: number
  The unique identifier for the BioBlitz.
Returns Promise<void>
A promise that resolves once the BioBlitz is liked (HTTP 204).

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/bioblitzes.ts:91

unlike

unlike(id: number): Promise<void>
Unlikes a BioBlitz for the authenticated user.
Parameters
- id: number
  The unique identifier for the BioBlitz.
Returns Promise<void>
A promise that resolves once the BioBlitz is unliked (HTTP 204).

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/bioblitzes.ts:105

getCategoryStatistics

getCategoryStatistics(categoryId: number): Promise<BioBlitzCategoryStatistics>
Fetches summary statistics for a BioBlitz category.

Authentication is not required.
Parameters
- categoryId: number
  The unique identifier for the BioBlitz category.
Returns Promise<BioBlitzCategoryStatistics>
A promise that resolves to the category statistics.

Throws
If the request fails.
- Defined in lib/bioblitzes.ts:120