TTMatrixRoute

Objective-C

@interface TTMatrixRoute : TTRequestScheduler

Swift

class TTMatrixRoute : TTRequestScheduler

TomTom Matrix routing API main object.`

  • Deprecated

    since 15.06.2020 - This method is deprecated. Use the ‘initWithKey’ method to init with Key.

    Initializer with info.plist Key.

    Declaration

    Objective-C

    - (instancetype _Nonnull)init;

    Swift

    init()

  • Initializer with key for TomTom API Service.

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithKey:(NSString *_Nonnull)key;

    Swift

    init(key: String)

  • Register delegate to receive callbacks with result or error response.

    Declaration

    Objective-C

    @property (nonatomic, weak) id<TTMatrixRouteResponseDelegate> _Nullable delegate;

    Swift

    weak var delegate: TTMatrixRouteResponseDelegate? { get set }

  • Perform matrix request with given query. Result will be availabe on success/error mothod od delegate.

    Declaration

    Objective-C

    - (void)matrixRouteWithQuery:(TTMatrixRouteQuery *_Nonnull)query;

    Swift

    func matrixRoute(with query: TTMatrixRouteQuery)

    Parameters

    query

    TTMatrixRouteQuery

  • Perform request using completion handler.

    Declaration

    Objective-C

    - (void)matrixRouteWithQuery:(TTMatrixRouteQuery *_Nonnull)query
           completionHandler:
               (void (^_Nonnull)(TTMatrixRouteResponse *_Nullable,
                                 TTResponseError *_Nullable))completionHandler;

    Swift

    func matrixRoute(with query: TTMatrixRouteQuery, completionHandler: @escaping (TTMatrixRouteResponse?, TTResponseError?) -> Void)

    Parameters

    query

    TTMatrixRouteQuery contains data needed to perform request.
    completionHandler

    CompletionHandler that informs the subscriber when a result is available.