getAppList method

Future<DynamiteResponse<ApiGetAppListResponseApplicationJson, void>> getAppList({
  1. required String newVersion,
  2. ApiGetAppListApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

List available updates for apps.

This endpoint requires admin access.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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:

Implementation

Future<DynamiteResponse<ApiGetAppListResponseApplicationJson, void>> getAppList({
  required String newVersion,
  ApiGetAppListApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getAppListRaw(
    newVersion: newVersion,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}