joinCallRaw method
- @experimental
- required String token,
- CallJoinCallFlags? flags,
- CallJoinCallForcePermissions? forcePermissions,
- CallJoinCallSilent? silent,
- CallJoinCallRecordingConsent? recordingConsent,
- CallJoinCallApiVersion? apiVersion,
- bool? oCSAPIRequest,
Join a call.
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:
flags
In-Call flags.forcePermissions
In-call permissions.silent
Join the call silently. Defaults to0
.recordingConsent
When the user ticked a checkbox and agreed with being recorded (Only needed when theconfig => call => recording-consent
capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} and the conversationrecordingConsent
value is {@see RecordingService::CONSENT_REQUIRED_YES} ). Defaults to0
.apiVersion
Defaults tov4
.token
oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Call joined successfully
- 404: Call not found
- 400: No recording consent was given
See:
- joinCall for an operation that returns a
DynamiteResponse
with a stable API.
Implementation
@_i4.experimental
_i1.DynamiteRawResponse<CallJoinCallResponseApplicationJson, void> joinCallRaw({
required String token,
CallJoinCallFlags? flags,
CallJoinCallForcePermissions? forcePermissions,
CallJoinCallSilent? silent,
CallJoinCallRecordingConsent? recordingConsent,
CallJoinCallApiVersion? 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) {
_i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_headers.addAll(
authentication.headers,
);
}
// coverage:ignore-end
final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
_i2.checkPattern(
$token as String?,
RegExp(r'^[a-z0-9]{4,30}$'),
'token',
);
_parameters['token'] = $token;
final $flags = _$jsonSerializers.serialize(flags, specifiedType: const FullType(CallJoinCallFlags));
_parameters['flags'] = $flags;
final $forcePermissions =
_$jsonSerializers.serialize(forcePermissions, specifiedType: const FullType(CallJoinCallForcePermissions));
_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;
var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
$oCSAPIRequest ??= true;
_headers['OCS-APIRequest'] = const _i2.HeaderEncoder().convert($oCSAPIRequest);
final _path = _i3.UriTemplate(
'/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}{?flags*,forcePermissions*,silent*,recordingConsent*}',
).expand(_parameters);
return _i1.DynamiteRawResponse<CallJoinCallResponseApplicationJson, void>(
response: _rootClient.executeRequest(
'post',
_path,
headers: _headers,
validStatuses: const {
200,
404,
},
),
bodyType: const FullType(CallJoinCallResponseApplicationJson),
headersType: null,
serializers: _$jsonSerializers,
);
}