@magiclane/maps-sdk
    Preparing search index...

    Class LandmarkBrowseSession

    Represents a session for browsing landmarks in a store.

    This class should not be instantiated directly. Instead, use the LandmarkStore.createLandmarkBrowseSession method to obtain an instance.

    Hierarchy

    • GemAutoreleaseObject
      • LandmarkBrowseSession
    Index

    Constructors

    constructor

    Accessors

    id landmarkCount landmarkStoreId pointerId settings

    Methods

    getLandmarkPosition getLandmarks registerAutoReleaseObject

    Constructors

    Accessors

    • get id(): number

      Get the session id

      Returns number

      The session id

      An exception if it fails.

    • get landmarkCount(): number

      Get the number of landmarks in the session

      Returns number

      The number of landmarks

      An exception if it fails.

    • get landmarkStoreId(): number

      Get the landmark store id

      Returns number

      The LandmarkStore.id

      An exception if it fails.

    • get pointerId(): any

      Returns any

    Methods

    • Get the position of the landmark with the specified Landmark.id

      The position is 0 based

      Parameters

      • landmarkId: number

        The id of the landmark

      Returns number

      The position of the landmark if it is in the session, GemError.notFound.code otherwise

      An exception if it fails.

    • Get the landmarks in the session between the specified start and end index: [start, end)

      Parameters

      • start: number

        The start index

      • end: number

        The end index

      Returns Landmark[]

      The list of landmarks

      An exception if it fails.

    • Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.

      Parameters

      • pointerId: any

        The pointer ID to register

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods