MBNNRouteInterface.h 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxNavigationNative/MBNNRouterOrigin.h>
  4. @class MBNNRouteInfo;
  5. @class MBNNWaypoint;
  6. NS_SWIFT_NAME(RouteInterface)
  7. @protocol MBNNRouteInterface
  8. /**
  9. * Unique route id.
  10. * For routes, whose directions response contains uuid: UUID + "#" + routeIndex
  11. * Example: d77PcddF8rhGUc3ORYGfcwcDfS_8QW6r1iXugXD0HOgmr9CWL8wn0g==#0
  12. * For routes, whose directions response nit contains uuid: "local@" + generateUuid() + "#" + routeIndex
  13. * Example: local@84438c3e-f608-47e9-88cc-cddf341d2fb1#0
  14. */
  15. - (nonnull NSString *)getRouteId;
  16. /** UUID from directions response object. This UUID can be used to refresh route. */
  17. - (nonnull NSString *)getResponseUuid;
  18. /**
  19. * Route index in routes array from direction's response.
  20. * This index can be used to refresh route and find route object in `getResponseJson().routes` JSON array.
  21. */
  22. - (uint32_t)getRouteIndex;
  23. /** This is a full directions route response. To find single route JSON in response use `getRouteIndex()`. */
  24. - (nonnull NSString *)getResponseJson;
  25. /** Directions route URI that used to request this route. */
  26. - (nonnull NSString *)getRequestUri;
  27. /** Router origin from router. Describes which kind of router presents response. */
  28. - (MBNNRouterOrigin)getRouterOrigin;
  29. /**
  30. * Get generic information about the route.
  31. * Example: get all route alerts on the route
  32. */
  33. - (nonnull MBNNRouteInfo *)getRouteInfo;
  34. /** Waypoints from direction's routes response. */
  35. - (nonnull NSArray<MBNNWaypoint *> *)getWaypoints;
  36. /**
  37. * Return a JSON array with Waypoints. This is a part of Directions API routes response.
  38. * If there were no waypoints in `response` duaring a parsing with `parseDirectionsResponse`,
  39. * they will be added based on `response` and `request`.
  40. */
  41. - (nonnull NSString *)getWaypointsJson;
  42. @end