@meridian/web-sdk
    Preparing search index...

    Interface OpenStreamOptions

    Options passed to API.openStream.

    interface OpenStreamOptions {
        floorID?: string;
        locationID: string;
        onClose?: () => void;
        onException?: (error: Error) => void;
        onInitialTags?: (tags: TagData[]) => void;
        onOpen?: () => void;
        onTagUpdate?: (tag: TagData) => void;
        resourceIDs?: string[];
        resourceType?: "LOCATION" | "TAG" | "FLOOR" | "LABEL" | "ZONE";
    }
    Index

    Properties

    floorID? locationID onClose? onException? onInitialTags? onOpen? onTagUpdate? resourceIDs? resourceType?

    Properties

    floorID?: string

    Meridian floor ID

    locationID: string

    Meridian location ID

    onClose?: () => void

    Called when the stream closes

    onException?: (error: Error) => void

    Called when an error happens

    onInitialTags?: (tags: TagData[]) => void

    Called with ALL tags on first load

    onOpen?: () => void

    Called when the stream opens

    onTagUpdate?: (tag: TagData) => void

    Called when a tag location updates

    resourceIDs?: string[]

    Default: [floorID] if resourceType === "FLOOR" OR [locationID] if resourceType === "LOCATION", Valid values: [locationID | floorIDs | tagIDs | tagLabelIDs | zoneIDs]

    resourceType?: "LOCATION" | "TAG" | "FLOOR" | "LABEL" | "ZONE"

    Default: "FLOOR" if floorID is defined Valid values: "LOCATION" | "TAG" | "FLOOR" | "LABEL" | "ZONE"

    Settings

    Member Visibility

    On This Page

    Properties