VMMSWayfindingDelegate

Objective-C

@protocol VMMSWayfindingDelegate <NSObject>

Swift

protocol VMMSWayfindingDelegate : NSObjectProtocol

The VMMSMapDelegate protocol defines the required and optional methods for an object to implement.

Since

1.1

Required Methods

  • Called when wayfinding path is found

    Declaration

    Objective-C

    - (void)didFinishFindingWaypath:(nonnull VMMSWaypath *)waypath;

    Swift

    func didFinishFinding(_ waypath: VMMSWaypath)

    Parameters

    waypath

    the Waypath that leads from the starting point to the ending point

  • Called when an error occurred while attemtping to find a waypath.

    Declaration

    Objective-C

    - (void)didFailToFindWaypathWithError:(nonnull NSError *)error;

    Swift

    func didFailToFindWaypathWithError(_ error: Error)

    Parameters

    error

    The exception that was raised during waypath finding.

Optional Methods

  • Called when turn by turn directions are completed

    Declaration

    Objective-C

    - (void)didFinishCreatingTurnByTurnDirections:
    (nonnull NSArray<VMMSMapDirectionStep *> *)turnByTurnDirections;

    Swift

    optional func didFinishCreatingTurn(byTurnDirections turnByTurnDirections: [VMMSMapDirectionStep])

    Parameters

    turnByTurnDirections

    list of directions

  • Called when the system is unable to generate turn by turn directions

    Declaration

    Objective-C

    - (void)didFailToCreateTurnByTurnDirectionsWithError:(nonnull NSError *)error;

    Swift

    optional func didFailToCreateTurnByTurnDirectionsWithError(_ error: Error)

    Parameters

    error

    the exception that was raised