createRoomRaw method

  1. @experimental
DynamiteRawResponse<PublicShareAuthCreateRoomResponseApplicationJson, void> createRoomRaw({
  1. required String shareToken,
  2. PublicShareAuthCreateRoomApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Creates a new room for video verification (requesting the password of a share).

The new room is a public room associated with a "share:password" object with the ID of the share token. Unlike normal rooms in which the owner is the user that created the room these are special rooms always created by a guest or user on behalf of a registered user, the sharer, who will be the owner of the room. The share must have "send password by Talk" enabled; an error is returned otherwise.

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:

  • shareToken Token of the file share.
  • apiVersion Defaults to v1.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 201: Room created successfully
  • 404: Share not found

See:

  • createRoom for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<PublicShareAuthCreateRoomResponseApplicationJson, void> createRoomRaw({
  required String shareToken,
  PublicShareAuthCreateRoomApiVersion? 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 $shareToken = _$jsonSerializers.serialize(shareToken, specifiedType: const FullType(String));
  _parameters['shareToken'] = $shareToken;

  var $apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(PublicShareAuthCreateRoomApiVersion));
  $apiVersion ??= 'v1';
  _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}/publicshareauth{?shareToken*}').expand(_parameters);
  return _i1.DynamiteRawResponse<PublicShareAuthCreateRoomResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      headers: _headers,
      validStatuses: const {201},
    ),
    bodyType: const FullType(PublicShareAuthCreateRoomResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}