getPreferences method

RoutePreferences? getPreferences(
  1. int index
)

Get preferences of the route specified by index.

Parameters

  • IN index The index of the route in the current sort order.

Returns

  • The route preferences if they exist, null otherwise

Throws

  • An exception if it fails.

Implementation

RoutePreferences? getPreferences(final int index) {
  final OperationResult resultString = objectMethod(
    _pointerId,
    'RouteBookmarks',
    'getPreferences',
    args: index,
  );

  final GemError err =
      GemErrorExtension.fromCode(resultString.data['gemApiError']);

  if (err != GemError.success) {
    return null;
  }

  return RoutePreferences.fromJson(resultString.data['result']);
}