getSettingsRaw method

  1. @experimental
DynamiteRawResponse<SignalingGetSettingsResponseApplicationJson, void> getSettingsRaw({
  1. String? token,
  2. SignalingGetSettingsApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Get the signaling settings.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

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

Status codes:

  • 200: Signaling settings returned
  • 401: Recording request invalid
  • 404: Room not found

See:

Implementation

@experimental
DynamiteRawResponse<SignalingGetSettingsResponseApplicationJson, void> getSettingsRaw({
  String? token,
  SignalingGetSettingsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  var $token = jsonSerializers.serialize(token, specifiedType: const FullType(String));
  $token ??= '';
  _parameters['token'] = $token;

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

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path =
      UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/settings{?token*}').expand(_parameters);
  return DynamiteRawResponse<SignalingGetSettingsResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(SignalingGetSettingsResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}