$joinCall_Request method

  1. @experimental
Request $joinCall_Request({
  1. required String token,
  2. int? flags,
  3. int? forcePermissions,
  4. CallJoinCallSilent? silent,
  5. CallJoinCallRecordingConsent? recordingConsent,
  6. CallJoinCallApiVersion? apiVersion,
  7. bool? oCSAPIRequest,
})

Join a call.

Returns a DynamiteRequest backing the joinCall operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • flags In-Call flags.
  • forcePermissions In-call permissions.
  • silent Join the call silently. Defaults to 0.
  • recordingConsent When the user ticked a checkbox and agreed with being recorded (Only needed when the config => call => recording-consent capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} and the conversation recordingConsent value is {@see RecordingService::CONSENT_REQUIRED_YES} ). Defaults to 0.
  • apiVersion Defaults to "v4".
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Call joined successfully
  • 404: Call not found
  • 400: No recording consent was given

See:

  • joinCall for a method executing this request and parsing the response.
  • $joinCall_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $joinCall_Request({
  required String token,
  int? flags,
  int? forcePermissions,
  CallJoinCallSilent? silent,
  CallJoinCallRecordingConsent? recordingConsent,
  CallJoinCallApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    $token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = $token;

  final $flags = _$jsonSerializers.serialize(flags, specifiedType: const FullType(int));
  _i4.checkNumber(
    $flags,
    'flags',
    maximum: 15,
    minimum: 0,
  );
  _parameters['flags'] = $flags;

  final $forcePermissions = _$jsonSerializers.serialize(forcePermissions, specifiedType: const FullType(int));
  _i4.checkNumber(
    $forcePermissions,
    'forcePermissions',
    maximum: 255,
    minimum: 0,
  );
  _parameters['forcePermissions'] = $forcePermissions;

  var $silent = _$jsonSerializers.serialize(silent, specifiedType: const FullType(CallJoinCallSilent));
  $silent ??= 0;
  _parameters['silent'] = $silent;

  var $recordingConsent =
      _$jsonSerializers.serialize(recordingConsent, specifiedType: const FullType(CallJoinCallRecordingConsent));
  $recordingConsent ??= 0;
  _parameters['recordingConsent'] = $recordingConsent;

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

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}{?flags*,forcePermissions*,silent*,recordingConsent*}',
  ).expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _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,
    );
  }

// 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;
}