signalingGetWelcomeMessage method

Future<DynamiteResponse<SignalingGetWelcomeMessageResponseApplicationJson, void>> signalingGetWelcomeMessage({ required int serverId, SignalingGetWelcomeMessageApiVersion? apiVersion, bool? oCSAPIRequest, })

Get the welcome message from a signaling server.

Only available for logged-in users because guests can not use the apps right now. This endpoint requires admin access.

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".
• serverId ID of the signaling server.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Welcome message returned
• 404: Signaling server not found
• 500

See:

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

Implementation

Future<_i1.DynamiteResponse<SignalingGetWelcomeMessageResponseApplicationJson, void>> signalingGetWelcomeMessage({
  required int serverId,
  SignalingGetWelcomeMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $signalingGetWelcomeMessage_Request(
    serverId: serverId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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