sendMessageRaw method

  1. @experimental
DynamiteRawResponse<BotSendMessageResponseApplicationJson, void> sendMessageRaw({
  1. required String message,
  2. required String token,
  3. String? referenceId,
  4. int? replyTo,
  5. int? silent,
  6. BotSendMessageApiVersion? apiVersion,
  7. bool? oCSAPIRequest,
})

Sends a new chat message to the given room.

The author and timestamp are automatically set to the current user/guest and time.

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:

  • message The message to send.
  • referenceId For the message to be able to later identify it again. Defaults to ''.
  • replyTo Parent id which this message is a reply to. Defaults to 0.
  • silent If sent silent the chat message will not create any notifications. Defaults to 0.
  • apiVersion Defaults to v1.
  • token Conversation token.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 201: Message sent successfully
  • 400: Sending message is not possible
  • 401: Sending message is not allowed
  • 413: Message too long

See:

Implementation

@experimental
DynamiteRawResponse<BotSendMessageResponseApplicationJson, void> sendMessageRaw({
  required String message,
  required String token,
  String? referenceId,
  int? replyTo,
  int? silent,
  BotSendMessageApiVersion? 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,
    );
  }

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

  final $token = jsonSerializers.serialize(token, specifiedType: const FullType(String));
  dynamite_utils.checkPattern($token as String?, RegExp(r'^[a-z0-9]{4,30}$'), 'token');
  _parameters['token'] = $token;

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

  var $replyTo = jsonSerializers.serialize(replyTo, specifiedType: const FullType(int));
  $replyTo ??= 0;
  _parameters['replyTo'] = $replyTo;

  var $silent = jsonSerializers.serialize(silent, specifiedType: const FullType(int));
  $silent ??= 0;
  _parameters['silent'] = $silent;

  var $apiVersion = jsonSerializers.serialize(apiVersion, specifiedType: const FullType(BotSendMessageApiVersion));
  $apiVersion ??= 'v1';
  _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/spreed/api/{apiVersion}/bot/{token}/message{?message*,referenceId*,replyTo*,silent*}',
  ).expand(_parameters);
  return DynamiteRawResponse<BotSendMessageResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {201, 400, 401, 413},
    ),
    bodyType: const FullType(BotSendMessageResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}