setRecordingConsent method

Future<DynamiteResponse<RoomSetRecordingConsentResponseApplicationJson, void>> setRecordingConsent({
  1. required int recordingConsent,
  2. required String token,
  3. RoomSetRecordingConsentApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Set recording consent requirement for this conversation.

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:

  • recordingConsent New consent setting for the conversation (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.).
  • apiVersion Defaults to v4.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Recording consent requirement set successfully
  • 400: Setting recording consent requirement is not possible
  • 412: No recording server is configured

See:

Implementation

Future<DynamiteResponse<RoomSetRecordingConsentResponseApplicationJson, void>> setRecordingConsent({
  required int recordingConsent,
  required String token,
  RoomSetRecordingConsentApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setRecordingConsentRaw(
    recordingConsent: recordingConsent,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}