LandmarkBrowseSessionContext

Objective-C


@interface LandmarkBrowseSessionContext : NSObject

Swift

class LandmarkBrowseSessionContext : NSObject

This class encapsulates landmark browse session context information.

    • Initializes and returns a newly allocated object.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStoreId:(int)identifier;

    Swift

    init(storeId identifier: Int32)

    Parameters

    identifier

    The identifier of a LandmarkStoreContext.

  • Initializes and returns a newly allocated object.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStoreId:(int)identifier
                               settings:(LandmarkBrowseSessionContextSettings)
                                            setting;

    Swift

    init(storeId identifier: Int32, settings setting: LandmarkBrowseSessionContextSettings)

    Parameters

    identifier

    The identifier of a LandmarkStoreContext.
    setting

    The settings for LandmarkBrowseSessionContext.

  • Gets the session settings.

    Declaration

    Objective-C

    - (LandmarkBrowseSessionContextSettings)getSettings;

    Swift

    func getSettings() -> LandmarkBrowseSessionContextSettings

  • Gets the session id.

    Declaration

    Objective-C

    - (int)getId;

    Swift

    func getId() -> Int32

  • Gets the belonging landmark store id.

    Declaration

    Objective-C

    - (int)getLandmarkStoreId;

    Swift

    func getLandmarkStoreId() -> Int32

  • Gets the number of all landmarks within the session.

    Declaration

    Objective-C

    - (int)getLandmarkCount;

    Swift

    func getLandmarkCount() -> Int32

  • Gets the landmarks between the specified indexes.

    Declaration

    Objective-C

    - (nonnull NSArray<LandmarkObject *> *)getLandmarksFrom:(int)fromIndex
                                                     to:(int)toIndex;

    Swift

    func getLandmarksFrom(_ fromIndex: Int32, to toIndex: Int32) -> [LandmarkObject]

    Parameters

    fromIndex

    The from index.
    toIndex

    The to index.

  • Gets the landmark position in browsing set for the given landmark id.

    Declaration

    Objective-C

    - (int)getLandmarkPos:(int)lmkId;

    Swift

    func getLandmarkPos(_ lmkId: Int32) -> Int32

    Return Value

    The position on success.