Class Listings

Listing search and counts. On a portal site requests route through the portal; otherwise they fall back to the public API.

See the Listings guide for usage and the full filter reference. For a ready-made search UI, see the Web Components instead.

Index

Constructors

Methods

Constructors

constructor

new Listings(
portalReady: Promise<PortalInfo>,
settings?: ISdkSettings,
): Listings
Parameters
- portalReady: Promise<PortalInfo>
- settings: ISdkSettings = {}
Returns Listings

Methods

count

count(params: IListingsSearchParams): Promise<IListingsCountResult>
Parameters
- params: IListingsSearchParams
Returns Promise<IListingsCountResult>

search

search(params: IListingsSearchParams): Promise<IListingsSearchResult>
Parameters
- params: IListingsSearchParams
Returns Promise<IListingsSearchResult>