getSettings method

Future<DynamiteResponse<SignalingGetSettingsResponseApplicationJson, void>> getSettings({
  1. String? token,
  2. SignalingGetSettingsApiVersion? apiVersion,
  3. 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:

  • 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

Future<DynamiteResponse<SignalingGetSettingsResponseApplicationJson, void>> getSettings({
  String? token,
  SignalingGetSettingsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getSettingsRaw(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}