$generateNotification_Request method

@experimental Request $generateNotification_Request({ required String shortMessage, required String userId, String? longMessage, ApiGenerateNotificationApiVersion? apiVersion, bool? oCSAPIRequest, })

Generate a notification for a user.

This endpoint requires admin access.

Returns a DynamiteRequest backing the generateNotification operation. 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:

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

Implementation

@_i2.experimental
_i3.Request $generateNotification_Request({
  required String shortMessage,
  required String userId,
  String? longMessage,
  ApiGenerateNotificationApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  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;

  final _path = _i4.UriTemplate(
    '/ocs/v2.php/apps/notifications/api/{apiVersion}/admin_notifications/{userId}{?shortMessage*,longMessage*}',
  ).expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _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 _i5.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}