MMMNavigationRequest

Objective-C

@interface MMMNavigationRequest : NSObject

Swift

class MMMNavigationRequest : NSObject

Info about a navigation request that is passed to handlers.

  • A sequence of hops the request has started with. This is never changed during lifetime of the request.

    Declaration

    Objective-C

    @property (nonatomic, readonly) MMMNavigationPath *_Nonnull originalPath;

    Swift

    var originalPath: MMMNavigationPath { get }

  • The current sequence of hops to follow. Handlers can adjust this.

    Declaration

    Objective-C

    @property (nonatomic, readonly) MMMNavigationPath *_Nonnull path;

    Swift

    var path: MMMNavigationPath { get }

  • Called by the handler when all the hops in the path were followed through.

    Declaration

    Objective-C

    - (void)didFinishSuccessfully:(BOOL)successfully;

    Swift

    func didFinishSuccessfully(_ successfully: Bool)

  • Called by the handler to indicate that the sequence of hops (possibly changed) should be continued by another handler. The handler is supposed to conform to MMMNavigationHandler protocol and this will be checked for in this method. The parameter here is not described as id to make it more convenient to call this method.

    Declaration

    Objective-C

    - (void)continueWithPath:(nonnull MMMNavigationPath *)path
                 handler:(nonnull id)handler;

    Swift

    func `continue`(with path: MMMNavigationPath, handler: Any)