$getUrl_Request method
- @experimental
Get a direct link to a file.
Returns a DynamiteRequest
backing the getUrl operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
fileId
ID of the file.expirationTime
Duration until the link expires.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Direct link returned
- 404: File not found
- 400: Getting direct link is not possible
- 403: Missing permissions to get direct link
See:
- getUrl for a method executing this request and parsing the response.
- $getUrl_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $getUrl_Request({
required int fileId,
required int expirationTime,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final $fileId = _$jsonSerializers.serialize(fileId, specifiedType: const FullType(int));
_parameters['fileId'] = $fileId;
final $expirationTime = _$jsonSerializers.serialize(expirationTime, specifiedType: const FullType(int));
_parameters['expirationTime'] = $expirationTime;
final _path = _i4.UriTemplate('/ocs/v2.php/apps/dav/api/v1/direct{?fileId*,expirationTime*}').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,
);
} else {
throw Exception('Missing authentication for bearer_auth or basic_auth');
}
// coverage:ignore-end
var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
$oCSAPIRequest ??= true;
_request.headers['OCS-APIRequest'] = const _i5.HeaderEncoder().convert($oCSAPIRequest);
return _request;
}