broadcastChatMessage method

Future<DynamiteResponse<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void>> broadcastChatMessage({
  1. required String message,
  2. required String token,
  3. BreakoutRoomBroadcastChatMessageApiVersion? apiVersion,
  4. 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:

Implementation

Future<DynamiteResponse<BreakoutRoomBroadcastChatMessageResponseApplicationJson, void>> broadcastChatMessage({
  required String message,
  required String token,
  BreakoutRoomBroadcastChatMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = broadcastChatMessageRaw(
    message: message,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}