sendMessage method

Sends a new chat message to the given room.

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

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • apiVersion Defaults to "v1".
  • 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
  • 404: Actor not found
  • 413: Message too long
  • 429: Mention rate limit exceeded (guests only)

See:

Implementation

Future<_i1.DynamiteResponse<ChatSendMessageResponseApplicationJson, ChatChatSendMessageHeaders>> sendMessage({
  required String token,
  required ChatSendMessageRequestApplicationJson $body,
  ChatSendMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $sendMessage_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $sendMessage_Serializer();
  return _i1.ResponseConverter<ChatSendMessageResponseApplicationJson, ChatChatSendMessageHeaders>(_serializer)
      .convert(_response);
}