signalingPullMessages method

Future<DynamiteResponse<SignalingPullMessagesResponseApplicationJson, void>> signalingPullMessages({ required String token, SignalingPullMessagesApiVersion? apiVersion, bool? oCSAPIRequest, })

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

• 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 messages returned
• 404: Session, room or participant not found
• 409: Session killed
• 400: Getting signaling messages is not possible

See:

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

Implementation

Future<_i1.DynamiteResponse<SignalingPullMessagesResponseApplicationJson, void>> signalingPullMessages({
  required String token,
  SignalingPullMessagesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $signalingPullMessages_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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