$broadcastChatMessage_Request method

@experimental Request $broadcastChatMessage_Request({ required String token, required BreakoutRoomBroadcastChatMessageRequestApplicationJson $body, BreakoutRoomBroadcastChatMessageApiVersion? apiVersion, bool? oCSAPIRequest, })

Broadcast a chat message to all breakout rooms.

Returns a DynamiteRequest backing the broadcastChatMessage operation. 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: Chat message broadcasted successfully
• 400: Broadcasting chat message is not possible
• 413: Chat message too long

See:

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

Implementation

@_i2.experimental
_i3.Request $broadcastChatMessage_Request({
  required String token,
  required BreakoutRoomBroadcastChatMessageRequestApplicationJson $body,
  BreakoutRoomBroadcastChatMessageApiVersion? 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;

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

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}/broadcast')
      .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 = _i6.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

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

  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize(
      $body,
      specifiedType: const FullType(BreakoutRoomBroadcastChatMessageRequestApplicationJson),
    ),
  );
  return _request;
}