sendMessages method

Future<DynamiteResponse<SignalingSendMessagesResponseApplicationJson, void>> sendMessages({
  1. required String messages,
  2. required String token,
  3. SignalingSendMessagesApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Send signaling messages.

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:

  • messages JSON encoded messages.
  • apiVersion Defaults to v3.
  • token Token of the room.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Signaling message sent successfully
  • 400: Sending signaling message is not possible

See:

Implementation

Future<DynamiteResponse<SignalingSendMessagesResponseApplicationJson, void>> sendMessages({
  required String messages,
  required String token,
  SignalingSendMessagesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = sendMessagesRaw(
    messages: messages,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}