$sendMessage_Request method

  1. @experimental
Request $sendMessage_Request({
  1. required String message,
  2. required String token,
  3. String? actorDisplayName,
  4. String? referenceId,
  5. int? replyTo,
  6. ChatSendMessageSilent? silent,
  7. ChatSendMessageApiVersion? apiVersion,
  8. 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.

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

Parameters:

  • message the message to send.
  • actorDisplayName for guests. Defaults to "".
  • 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
  • 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

@_i2.experimental
_i3.Request $sendMessage_Request({
  required String message,
  required String token,
  String? actorDisplayName,
  String? referenceId,
  int? replyTo,
  ChatSendMessageSilent? silent,
  ChatSendMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $message = _$jsonSerializers.serialize(message, specifiedType: const FullType(String));
  _parameters['message'] = $message;

  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    $token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = $token;

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

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

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

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

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

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}{?message*,actorDisplayName*,referenceId*,replyTo*,silent*}',
  ).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,
    );
  }

// 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;
}