$deleteMessage_Request method

@experimental Request $deleteMessage_Request({ required String token, required int messageId, ChatDeleteMessageApiVersion? apiVersion, bool? oCSAPIRequest, })

Delete a chat message.

Returns a DynamiteRequest backing the deleteMessage operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• apiVersion Defaults to "v1".
• token
• messageId ID of the message.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Message deleted successfully
• 202: Message deleted successfully, but a bot or Matterbridge is configured, so the information can be replicated elsewhere
• 400: Deleting message is not possible
• 403: Missing permissions to delete message
• 404: Message not found
• 405: Deleting this message type is not allowed

See:

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

Implementation

@_i2.experimental
_i3.Request $deleteMessage_Request({
  required String token,
  required int messageId,
  ChatDeleteMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    $token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = $token;

  final $messageId = _$jsonSerializers.serialize(messageId, specifiedType: const FullType(int));
  _i4.checkNumber(
    $messageId,
    'messageId',
    minimum: 0,
  );
  _parameters['messageId'] = $messageId;

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

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/{messageId}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('delete', _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,
    );
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}