$signalingGetWelcomeMessage_Request method

@experimental Request $signalingGetWelcomeMessage_Request({ 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 DynamiteRequest backing the signalingGetWelcomeMessage operation. 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 for a method executing this request and parsing the response.
• $signalingGetWelcomeMessage_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $signalingGetWelcomeMessage_Request({
  required int serverId,
  SignalingGetWelcomeMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $serverId = _$jsonSerializers.serialize(serverId, specifiedType: const FullType(int));
  _i4.checkNumber(
    $serverId,
    'serverId',
    minimum: 0,
  );
  _parameters['serverId'] = $serverId;

  var $apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(SignalingGetWelcomeMessageApiVersion));
  $apiVersion ??= 'v3';
  _parameters['apiVersion'] = $apiVersion;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/welcome/{serverId}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}