getTranslationInfos method

Future<Response<BuiltList<TranslationInfo>>> getTranslationInfos({ CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, })

Get Translation info (getTranslationInfos) Fetch the list of customized locales and corresponding details such as language display name, country display name and translation progress percentage. Response example: ```json { \"localeCode\": \"uk_UA\", \"language\": \"Ukrainian (українська)\", \"country\": \"Україна\", \"progress\": 32 }, { \"localeCode\": \"es_ES\", \"language\": \"Spanish (español)\", \"country\": \"España\", \"progress\": 79 } ``` Security check is performed to verify that the user has 'READ' permission for the white labeling resource.

Parameters:

• cancelToken - A CancelToken that can be used to cancel the operation
• headers - Can be used to add additional headers to the request
• extras - Can be used to add flags to the request
• validateStatus - A ValidateStatus callback that can be used to determine request success based on the HTTP status of the response
• onSendProgress - A ProgressCallback that can be used to get the send progress
• onReceiveProgress - A ProgressCallback that can be used to get the receive progress

Returns a Future containing a Response with a BuiltList<TranslationInfo> as data Throws DioException if API call or serialization fails

Implementation

Future<Response<BuiltList<TranslationInfo>>> getTranslationInfos({
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final _path = r'/api/translation/info';
  final _options = Options(
    method: r'GET',
    headers: <String, dynamic>{
      ...?headers,
    },
    extra: <String, dynamic>{
      'secure': <Map<String, String>>[
        {
          'type': 'apiKey',
          'name': 'ApiKeyForm',
          'keyName': 'X-Authorization',
          'where': 'header',
        },{
          'type': 'http',
          'scheme': 'loginPassword',
          'name': 'HttpLoginForm',
        },
      ],
      ...?extra,
    },
    validateStatus: validateStatus,
  );

  final _response = await _dio.request<Object>(
    _path,
    options: _options,
    cancelToken: cancelToken,
    onSendProgress: onSendProgress,
    onReceiveProgress: onReceiveProgress,
  );

  BuiltList<TranslationInfo>? _responseData;

  try {
    final rawResponse = _response.data;
    _responseData = rawResponse == null ? null : _serializers.deserialize(
      rawResponse,
      specifiedType: const FullType(BuiltList, [FullType(TranslationInfo)]),
    ) as BuiltList<TranslationInfo>;

  } catch (error, stackTrace) {
    throw DioException(
      requestOptions: _response.requestOptions,
      response: _response,
      type: DioExceptionType.unknown,
      error: error,
      stackTrace: stackTrace,
    );
  }

  return Response<BuiltList<TranslationInfo>>(
    data: _responseData,
    headers: _response.headers,
    isRedirect: _response.isRedirect,
    requestOptions: _response.requestOptions,
    redirects: _response.redirects,
    statusCode: _response.statusCode,
    statusMessage: _response.statusMessage,
    extra: _response.extra,
  );
}