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

Accessors

id landmarkCount landmarkStoreId pointerId settings

Methods

getLandmarkPosition getLandmarks registerAutoReleaseObject

Constructors

constructor

new LandmarkBrowseSession(id: number): LandmarkBrowseSession
Internal
Parameters
- id: number
Returns LandmarkBrowseSession
Overrides GemAutoreleaseObject.constructor
- Defined in core/landmarkbrowsesession.ts:28

Accessors

id

get id(): number
Get the session id

Returns number
The session id

Throws
An exception if it fails.
- Defined in core/landmarkbrowsesession.ts:44

landmarkCount

get landmarkCount(): number
Get the number of landmarks in the session

Returns number
The number of landmarks

Throws
An exception if it fails.
- Defined in core/landmarkbrowsesession.ts:76

landmarkStoreId

get landmarkStoreId(): number
Get the landmark store id

Returns number
The LandmarkStore.id

Throws
An exception if it fails.
- Defined in core/landmarkbrowsesession.ts:60

pointerId

get pointerId(): number
Returns number
- Defined in core/landmarkbrowsesession.ts:34

settings

get settings(): LandmarkBrowseSessionSettings
Get the browse session settings

Modifying the returned object will have no effect on the session

Returns LandmarkBrowseSessionSettings
The settings

Throws
An exception if it fails.
- Defined in core/landmarkbrowsesession.ts:133

Methods

getLandmarkPosition

getLandmarkPosition(landmarkId: number): number
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

Throws
An exception if it fails.
- Defined in core/landmarkbrowsesession.ts:114

getLandmarks

getLandmarks(start: number, end: number): Landmark[]
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

Throws
An exception if it fails.
- Defined in core/landmarkbrowsesession.ts:94

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
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
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:14