Interface IOfferApi

Interface for the available Offer API functionality

interface IOfferApi {
    getOffer: ((offerGuid: string) => Promise<ILeafletOffer>);
    getOffers: (() => Promise<ILeafletOffer[]>);
    getOfferElement: ((offerGuid: string) => Promise<undefined | null | HTMLElement>);
    inView: (() => Promise<string[]>);
    onEnterViewport: ((callback: ((offerGuid: string) => unknown)) => Subscriber);
    onLeaveViewport: ((callback: ((offerGuid: string) => unknown)) => Subscriber);
    onClick: ((callback: ((offerGuid: string) => unknown)) => Subscriber);
}

Properties

getOffer getOffers getOfferElement inView onEnterViewport onLeaveViewport onClick

Properties

getOffer

getOffer: ((offerGuid: string) => Promise<ILeafletOffer>)

Get an offer by GUID

getOffers

getOffers: (() => Promise<ILeafletOffer[]>)

Get all offers in leafletF

getOfferElement

getOfferElement: ((offerGuid: string) => Promise<undefined | null | HTMLElement>)

Get an offer element by GUID

inView

inView: (() => Promise<string[]>)

Get all offers in view

onEnterViewport

onEnterViewport: ((callback: ((offerGuid: string) => unknown)) => Subscriber)

Subscribe to offers entering the viewport

onLeaveViewport

onLeaveViewport: ((callback: ((offerGuid: string) => unknown)) => Subscriber)

Subscribe to offers leaving the viewport

onClick

onClick: ((callback: ((offerGuid: string) => unknown)) => Subscriber)

Subscribe to clicks on offers

Settings

Member Visibility

On This Page

Properties