signalingGetSettings method
Future<DynamiteResponse<SignalingGetSettingsResponseApplicationJson, void> >
signalingGetSettings({
- SignalingGetSettingsApiVersion? apiVersion,
- String? token,
- bool? oCSAPIRequest,
Get the signaling settings.
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. Defaults to""
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Signaling settings returned
- 401: Recording request invalid
- 404: Room not found
See:
- $signalingGetSettings_Request for the request send by this method.
- $signalingGetSettings_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<SignalingGetSettingsResponseApplicationJson, void>> signalingGetSettings({
SignalingGetSettingsApiVersion? apiVersion,
String? token,
bool? oCSAPIRequest,
}) async {
final _request = $signalingGetSettings_Request(
apiVersion: apiVersion,
token: token,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $signalingGetSettings_Serializer();
return _i1.ResponseConverter<SignalingGetSettingsResponseApplicationJson, void>(_serializer).convert(_response);
}