getValue method

Future<DynamiteResponse<AppConfigGetValueResponseApplicationJson, void>> getValue({
  1. required String app,
  2. required String key,
  3. String? defaultValue,
  4. bool? oCSAPIRequest,
})

Get a the config value of an app.

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:

  • defaultValue Default returned value if the value is empty. Defaults to ''.
  • app ID of the app.
  • key Key.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Value returned
  • 403: App is not allowed

See:

Implementation

Future<DynamiteResponse<AppConfigGetValueResponseApplicationJson, void>> getValue({
  required String app,
  required String key,
  String? defaultValue,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getValueRaw(
    app: app,
    key: key,
    defaultValue: defaultValue,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}