$ringAttendee_Request method

  1. @experimental
Request $ringAttendee_Request({
  1. required String token,
  2. required int attendeeId,
  3. CallRingAttendeeApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Ring an attendee.

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

Parameters:

  • apiVersion Defaults to "v4".
  • token
  • attendeeId ID of the attendee to ring.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Attendee rang successfully
  • 404: Attendee could not be found
  • 400: Ringing attendee is not possible

See:

Implementation

@_i2.experimental
_i3.Request $ringAttendee_Request({
  required String token,
  required int attendeeId,
  CallRingAttendeeApiVersion? 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 __attendeeId = _$jsonSerializers.serialize(attendeeId, specifiedType: const FullType(int));
  _parameters['attendeeId'] = __attendeeId;

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

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}/ring/{attendeeId}').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 = _i6.IterableExtension(_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;
}