SPSmartMapNavigationUserTask

Objective-C

@interface SPSmartMapNavigationUserTask : SPSmartMapUserTask

Swift

class SPSmartMapNavigationUserTask : SPSmartMapUserTask

A class that is responsible for defining a user navigation task.

  • Custom initialize method with localRef and buildingRef

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLocalRef:(nonnull NSString *)localRef
                                    building:(nonnull NSString *)buildingRef;

    Swift

    init(localRef: String, building buildingRef: String)

    Parameters

    localRef

    local reference of the POI that you want to navigate to.

    buildingRef

    building reference of the POI that you want to navigate to.

  • Custom initialize method with map object

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMapObject:(nonnull SPSmartMapObject *)object;

    Swift

    init(mapObject object: SPSmartMapObject)

    Parameters

    object

    The map object that you want to navigate to.

  • Custom initialize method with map objects

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMapObjects:
        (nonnull NSArray<SPSmartMapObject *> *)listOfObjects;

    Swift

    init(mapObjects listOfObjects: [SPSmartMapObject])

    Parameters

    listOfObjects

    The list of map objects that you navigate through

Public methods

  • Call this method if you want to set the origin of the navigation. If the origin is not set, the starting point of the navigation will be the bluedot/user current location

    Declaration

    Objective-C

    - (void)setOrigin:(nonnull SPSmartMapObject *)origin;

    Swift

    func setOrigin(_ origin: SPSmartMapObject)

    Parameters

    origin

    The origin of the navigation.

  • Return localRef of the destination of the navigation task.

    Declaration

    Objective-C

    - (nullable NSString *)getUserTaskLocalRef;

    Swift

    func getLocalRef() -> String?

    Return Value

    LocalRef of the destination of the navigation task.

  • Return buildingRef of the destination of the navigation task.

    Declaration

    Objective-C

    - (nullable NSString *)getUserTaskBuildingRef;

    Swift

    func getBuildingRef() -> String?

    Return Value

    BuildingRef of the destination of the navigation task.

  • Return origin of the navigation task

    Declaration

    Objective-C

    - (nullable SPSmartMapObject *)getOrigin;

    Swift

    func getOrigin() -> SPSmartMapObject?

    Return Value

    origin of the navigation task

  • Return list of map objects that navigation go through

    Declaration

    Objective-C

    - (nullable NSArray<SPSmartMapObject *> *)getNavigationObjects;

    Swift

    func getNavigationObjects() -> [SPSmartMapObject]?

    Return Value

    list of map objects that navigation go through excluding