<NMExternalRouteProvider> Protocol Reference

Inherits <NSObject>.

Instance Methods
(nullable NMExternalRouteHttpRequest *)	- composeRouteHttpRequestUsingRoutePlan:routeParameters:
(nullable NSArray< NMExternalRoute * > *)	- parseRouteHttpResponse:

Detailed Description

A protocol giving ability to provide the SDK with custom routes.

Method Documentation

composeRouteHttpRequestUsingRoutePlan:routeParameters:()

- (nullable NMExternalRouteHttpRequest *) composeRouteHttpRequestUsingRoutePlan: (nonnull NMRoutePlan *)  routePlan routeParameters: (nonnull NMExternalRouteParameters *)  routeParameters

required

The method is used to compose an external route request based on the specified route plan and route parameters.

Parameters

routePlan	@nonnull The route plan of a new route;
routeParameters	@nonnull The parameters of a new route.

Returns

An NMExternalRouteHttpRequest instance.

parseRouteHttpResponse:()

- (nullable NSArray<NMExternalRoute *> *) parseRouteHttpResponse: (nonnull NSString *)  response

required

The method is used to convert the specified HTTP response to an array of NMExternalRoute objects.

Parameters

response

@nonnull Response for a route HTTP request.

Returns

An array of routes.