VMMSMapDelegate

@protocol VMMSMapDelegate <NSObject>

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

Since

1.0

Optional Methods

  • Called when the VMD file is done loading SUCCESSFULLY

    Since

    1.1

    Warning

    Deprecated in 1.2.1. Use didFinishLoadingVenueMapData:customMapInfo: instead.

    Declaration

    Swift

    - (void)didFinishLoadingMap:(VMMSMap *)vmd
              customMapInfo:(VMMSCustomMapInfo *)customMapInfo;

    Parameters

    vmd

    a VMMSMap object
    customMapInfo

    a VMMSCustommapInfo object

  • Called when the VMD file is done loading SUCCESSFULLY

    Since

    1.2.1

    Declaration

    Swift

    - (void)didFinishLoadingVenueMapData:(VMMSMap *)vmd
                       customMapInfo:(VMMSCustomMapInfo *)customMapInfo;

    Parameters

    vmd

    a VMMSMap object
    customMapInfo

    a VMMSCustommapInfo object

  • Called when the VMD file FAILS to load

    Warning

    Deprecated in 1.2.1. Use didFinishLoadingVenueMapData:customMapInfo: instead.

    Declaration

    Swift

    - (void)didFailToLoadMapWithError:(NSError *)error;

    Parameters

    error

    the exception that was raised during load

  • Since

    1.2.1

    Declaration

    Swift

    - (void)didFailToLoadVenueMapDataWithError:(NSError *)error;

  • Called when the VMD is done loading SUCCESSFULLY

    Since

    1.0

    Warning

    Deprecated in 1.1. Use didFinishLoadingMap:customMapInfo: instead

    Declaration

    Swift

    - (void)didFinishLoadingMap:(VMMSMap *)map;

    Parameters

    map

    a Map object with waypoint data

  • Called when the custom map info is done loading SUCCESSFULLY

    Since

    1.0

    Warning

    Deprecated in 1.1. Use didFinishLoadingMap:customMapInfo: instead

    Declaration

    Swift

    - (void)didFinishLoadingCustomMapInfo:(VMMSCustomMapInfo *)info;

    Parameters

    info

    a VMMSCustomMapInfo object

  • Called when an error occurred while parsing the custom map info

    Since

    1.0

    Warning

    Deprecated in 1.1. Use didFailToLoadMapWithError: instead

    Declaration

    Swift

    - (void)didFailToLoadCustomMapInfoWithError:(NSError *)error;

    Parameters

    error

    The exception that was raised

  • Called when wayfinding path is found

    Since

    1.0

    Warning

    Deprecated in 1.1. Use VMMSWayfindingDelegate instead

    Declaration

    Swift

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

    Parameters

    waypath

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

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

    Since

    1.0

    Warning

    Deprecated in 1.1. Use VMMSWayfindingDelegate instead

    Declaration

    Swift

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

    Parameters

    error

    The exception that was raised during waypath finding.

  • Called when turn by turn directions are completed

    Since

    1.0

    Warning

    Deprecated in 1.1. Use VMMSWayfindingDelegate instead

    Declaration

    Swift

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

    Parameters

    turnByTurnDirections

    list of directions

  • DEPRECATED - Use VMMSWayfindingDelegate instead Called when the system is unable to generate turn by turn directions

    Since

    1.0

    Warning

    Deprecated in 1.1. Use VMMSWayfindingDelegate instead

    Declaration

    Swift

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

    Parameters

    error

    the exception that was raised