generateNotificationRaw method

  1. @experimental
DynamiteRawResponse<ApiGenerateNotificationResponseApplicationJson, void> generateNotificationRaw({
  1. required String shortMessage,
  2. required String userId,
  3. String? longMessage,
  4. ApiGenerateNotificationApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Generate a notification for a user.

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:

  • shortMessage Subject of the notification.
  • longMessage Message of the notification. Defaults to ''.
  • apiVersion Defaults to v2.
  • userId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Notification generated successfully
  • 400: Generating notification is not possible
  • 404: User not found
  • 500

See:

Implementation

@experimental
DynamiteRawResponse<ApiGenerateNotificationResponseApplicationJson, void> generateNotificationRaw({
  required String shortMessage,
  required String userId,
  String? longMessage,
  ApiGenerateNotificationApiVersion? 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 $shortMessage = jsonSerializers.serialize(shortMessage, specifiedType: const FullType(String));
  _parameters['shortMessage'] = $shortMessage;

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

  var $longMessage = jsonSerializers.serialize(longMessage, specifiedType: const FullType(String));
  $longMessage ??= '';
  _parameters['longMessage'] = $longMessage;

  var $apiVersion =
      jsonSerializers.serialize(apiVersion, specifiedType: const FullType(ApiGenerateNotificationApiVersion));
  $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}/admin_notifications/{userId}{?shortMessage*,longMessage*}',
  ).expand(_parameters);
  return DynamiteRawResponse<ApiGenerateNotificationResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(ApiGenerateNotificationResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}