$publicShareAuthCreateRoom_Request method

@experimental Request $publicShareAuthCreateRoom_Request({ required String shareToken, PublicShareAuthCreateRoomApiVersion? apiVersion, 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.

Returns a DynamiteRequest backing the publicShareAuthCreateRoom operation. 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:

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

Implementation

@_i2.experimental
_i3.Request $publicShareAuthCreateRoom_Request({
  required String shareToken,
  PublicShareAuthCreateRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  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;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/publicshareauth{?shareToken*}').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;
}