$getAppList_Request method

  1. @experimental
Request $getAppList_Request({
  1. required String newVersion,
  2. ApiGetAppListApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

List available updates for apps.

This endpoint requires admin access.

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

Parameters:

  • apiVersion Defaults to "v1".
  • newVersion Server version to check updates for.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Apps returned
  • 404: New versions not found

See:

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

Implementation

@_i2.experimental
_i3.Request $getAppList_Request({
  required String newVersion,
  ApiGetAppListApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final __newVersion = _$jsonSerializers.serialize(newVersion, specifiedType: const FullType(String));
  _parameters['newVersion'] = __newVersion;

  var __apiVersion = _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(ApiGetAppListApiVersion));
  __apiVersion ??= 'v1';
  _parameters['apiVersion'] = __apiVersion;

  final _path = _i4.UriTemplate('/ocs/v2.php/apps/updatenotification/api/{apiVersion}/applist/{newVersion}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i5.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i6.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}