SITNavigationRequest

@interface SITNavigationRequest : NSObject

Class that stores relevant information to request navigation updates.

  • Initializes a request to navigate through a route

    Note

    this request will have default values for the distanceToGoalThreshold and outsideRouteThreshold.

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithRoute:(SITRoute *_Nonnull)route;

    Parameters

    route

    the route (returned by SITDirectionManager) you want to navigate

    Return Value

    initialized request

  • Distance in meters at which will be consider that the user has arrived to the destination of a route

    Note

    The minimum value for this parameter is 3 meters and maximum is 15 meters. Default value is 10 meters.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSInteger distanceToGoalThreshold;
  • Distance in meters at which the Navigation Component should consider that the user is outside a route and it’s recommended to recompute a new one.

    Note

    The minimum value is 3 meters and maximum is 15 meters. Default value is 9 meters.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSInteger outsideRouteThreshold;

    Return Value

    distance in meters.

  • Distance in meters at which will be consider that the user has arrived to a change floor indication

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        NSInteger distanceToFloorChangeThreshold;

    Return Value

    distance in meters.

    Note

    Default value is 10 meters.

  • Distance in meters at which will be consider that the user has arrived to the next indication

    Note

    Default value is 5 meters.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        NSInteger distanceToChangeIndicationThreshold;

    Return Value

    distance in meters.

  • SITRoute object considered to navigate

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) SITRoute *_Nonnull route;
  • Time to wait between indications

    Note

    Default value is 0 milliseconds, which means a new indication will be returned every time a new position is computed. If the value is different than 0 the indications may not be synchronized with the SITRouteStep in SITNavigationProgress.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSInteger indicationsInterval;

    Return Value

    time in milliseconds

  • Time to wait until the first indication is returned

    Note

    Default value is 0 milliseconds, which means the first indication will be returned as soon as it is calculated.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSInteger timeToFirstIndication;

    Return Value

    time in milliseconds

  • The step that will be used to round indications distance.

    Note

    Default value is 0, which means the indications will not be rounded.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSInteger roundIndicationsStep;

    Return Value

    step in meters

  • Time (in millis) to ignore the locations received during navigation, when the next indication is a floor change, if the locations are in a wrong floor (not in origin or destination floors). With a value of 0 it won’t ignore any location.

    Note

    Default value is 0, which means unexpected floor changes will not be ignored.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        NSInteger timeToIgnoreUnexpectedFloorChanges;

    Return Value

    time in millis

  • Set a threshold within which the next change floor indication will be returned

    Declaration

    Objective-C

    - (void)setDistanceToChangeFloorThreshold:
        (NSInteger)distanceToChangeFloorThreshold;

    Parameters

    distanceToChangeFloorThreshold

    distance to change floor threshold