TTInstruction

Objective-C

@interface TTInstruction : NSObject

Swift

class TTInstruction : NSObject

A TTInstruction object contains parameters with information about the actual road.

  • Distance from the start of the route to the point of the instruction.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger routeOffsetInMetersValue;

    Swift

    var routeOffsetInMetersValue: Int { get }

  • Estimated travel time in seconds. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger travelTimeInSecondsValue;

    Swift

    var travelTimeInSecondsValue: Int { get }

  • Latitude, longitude pair.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CLLocationCoordinate2D position;

    Swift

    var position: CLLocationCoordinate2D { get }

  • If specified, guidance instructions will be returned. Possible values: coded - returns raw instruction data without human-readable messages. text - returns raw instructions data with human-readable messages in plain text. tagged - returns raw instruction data with tagged human-readable messages to permit formatting.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull instructionType;

    Swift

    var instructionType: String { get }

  • Street name of the next significant road segment after the maneuver, or of the street that should be followed.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull street;

    Swift

    var street: String { get }

  • An aggregate for roadNumber elements.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<NSString *> *_Nonnull roadNumbers;

    Swift

    var roadNumbers: [String] { get }

  • The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by “,” and possibly aggregated by “-”, e.g., “10, 13-15”.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull exitNumber;

    Swift

    var exitNumber: String { get }

  • 3-character ISO 3166-1 alpha-3 country code.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull countryCode;

    Swift

    var countryCode: String { get }

  • Text on a signpost which is most relevant to the maneuver, or to the direction that should be followed.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull signpostText;

    Swift

    var signpostText: String { get }

  • Type of the junction at which the maneuver takes place.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull junctionType;

    Swift

    var junctionType: String { get }

  • Indicates the direction of an instruction. If junctionType indicates a turn

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger turnAngleInDecimalDegreesValue;

    Swift

    var turnAngleInDecimalDegreesValue: Int { get }

  • Indicates which exit to take at a roundabout.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger roundaboutExitNumberValue;

    Swift

    var roundaboutExitNumberValue: Int { get }

  • It is possible to optionally combine the instruction with the next one. This can be used to build messages like “Turn left and then turn right”.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL possibleCombineWithNext;

    Swift

    var possibleCombineWithNext: Bool { get }

  • Indicates left-hand vs. right-hand side driving at the point of the maneuver.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull drivingSide;

    Swift

    var drivingSide: String { get }

  • A code identifying the maneuver (e.g. ‘Turn right’).

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull maneuver;

    Swift

    var maneuver: String { get }

  • A human-readable message for the maneuver.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull message;

    Swift

    var message: String { get }

  • A human-readable message for the maneuver combined with the message from the next instruction.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull combinedMessage;

    Swift

    var combinedMessage: String { get }