broadcastChatMessageRaw method

  1. @experimental
DynamiteRawResponse<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void> broadcastChatMessageRaw({
  1. required String message,
  2. required String token,
  3. BreakoutRoomBroadcastChatMessageApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Broadcast a chat message to all breakout rooms.

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 Message to broadcast.
  • apiVersion Defaults to v1.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 201: Chat message broadcasted successfully
  • 400: Broadcasting chat message is not possible
  • 413: Chat message too long

See:

Implementation

@experimental
DynamiteRawResponse<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void> broadcastChatMessageRaw({
  required String message,
  required String token,
  BreakoutRoomBroadcastChatMessageApiVersion? 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,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// 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 $apiVersion = jsonSerializers.serialize(
    apiVersion,
    specifiedType: const FullType(BreakoutRoomBroadcastChatMessageApiVersion),
  );
  $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}/breakout-rooms/{token}/broadcast{?message*}')
      .expand(_parameters);
  return DynamiteRawResponse<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {201},
    ),
    bodyType: const FullType(BreakoutRoomBroadcastChatMessageResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}