setCustomOption abstract method

RoutingError? setCustomOption(
  1. String name,
  2. String? value
)

Sets a custom option for routing backend queries.

The custom option is applied to all the queries that IsolineRoutingEngine performs. For a complete list of available parameter names and their valid values, refer to HERE Routing API v8. Note: It's easy to set a wrong option that makes queries invalid, so make sure you read and understand the backend documentation.

  • name An option name. If the engine already has an option with the same name, the option will be overwritten. The option name must be a non-empty string. The option name should't duplicate option names that SDK creates by itself for usage in the query, otherwise the query will callback with the error RoutingError.INTERNAL_ERROR.

  • value An option value. If the value is null, the option will be removed. The option value must be a non-empty string.

Returns RoutingError?. An optional error of setting the option.

It's null if the option has been set successfully. It's RoutingError.INVALID_PARAMETER if the input name and/or value haven't passed internal validation.

Implementation

RoutingError? setCustomOption(String name, String? value);