$getFavicon_Request method

  1. @experimental
Request $getFavicon_Request({
  1. String? app,
})

Return a 32x32 favicon as png.

Returns a DynamiteRequest backing the getFavicon operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • app ID of the app. Defaults to "core".

Status codes:

  • 200: Favicon returned
  • 404: Favicon not found
  • 500

See:

  • getFavicon for a method executing this request and parsing the response.
  • $getFavicon_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getFavicon_Request({String? app}) {
  final _parameters = <String, Object?>{};
  var $app = _$jsonSerializers.serialize(app, specifiedType: const FullType(String));
  $app ??= 'core';
  _parameters['app'] = $app;

  final _path = _i4.UriTemplate('/index.php/apps/theming/favicon/{app}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'image/x-icon';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  return _request;
}