adminRaw method

  1. @experimental
DynamiteRawResponse<SettingsAdminResponseApplicationJson, void> adminRaw({
  1. required int batchSetting,
  2. required String soundNotification,
  3. required String soundTalk,
  4. SettingsAdminApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Update default notification settings for new users.

This endpoint requires admin access.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • batchSetting How often E-mails about missed notifications should be sent (hourly: 1; every three hours: 2; daily: 3; weekly: 4).
  • soundNotification Enable sound for notifications ('yes' or 'no').
  • soundTalk Enable sound for Talk notifications ('yes' or 'no').
  • apiVersion Defaults to v2.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Admin settings updated

See:

Implementation

@experimental
DynamiteRawResponse<SettingsAdminResponseApplicationJson, void> adminRaw({
  required int batchSetting,
  required String soundNotification,
  required String soundTalk,
  SettingsAdminApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  final $batchSetting = jsonSerializers.serialize(batchSetting, specifiedType: const FullType(int));
  _parameters['batchSetting'] = $batchSetting;

  final $soundNotification = jsonSerializers.serialize(soundNotification, specifiedType: const FullType(String));
  _parameters['soundNotification'] = $soundNotification;

  final $soundTalk = jsonSerializers.serialize(soundTalk, specifiedType: const FullType(String));
  _parameters['soundTalk'] = $soundTalk;

  var $apiVersion = jsonSerializers.serialize(apiVersion, specifiedType: const FullType(SettingsAdminApiVersion));
  $apiVersion ??= 'v2';
  _parameters['apiVersion'] = $apiVersion;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path = UriTemplate(
    '/ocs/v2.php/apps/notifications/api/{apiVersion}/settings/admin{?batchSetting*,soundNotification*,soundTalk*}',
  ).expand(_parameters);
  return DynamiteRawResponse<SettingsAdminResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(SettingsAdminResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}