broadcastChatMessage method

Future<DynamiteResponse<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void>> broadcastChatMessage({ required String message, required String token, BreakoutRoomBroadcastChatMessageApiVersion? apiVersion, bool? oCSAPIRequest, })

Broadcast a chat message to all breakout rooms.

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:

• 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:

• $broadcastChatMessage_Request for the request send by this method.
• $broadcastChatMessage_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void>> broadcastChatMessage({
  required String message,
  required String token,
  BreakoutRoomBroadcastChatMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $broadcastChatMessage_Request(
    message: message,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $broadcastChatMessage_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}