$findRecommended_Request method
Find recommended sharees.
Returns a DynamiteRequest
backing the findRecommended operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
itemType
Limit to specific item types.shareType
Limit to specific share types.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Recommended sharees returned
See:
- findRecommended for a method executing this request and parsing the response.
- $findRecommended_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $findRecommended_Request({
required String itemType,
ShareesapiFindRecommendedShareType? shareType,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final __itemType = _$jsonSerializers.serialize(itemType, specifiedType: const FullType(String));
_parameters['itemType'] = __itemType;
final __shareType =
_$jsonSerializers.serialize(shareType, specifiedType: const FullType(ShareesapiFindRecommendedShareType));
_parameters['shareType'] = __shareType;
final _path = _i6.UriTemplate('/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended{?itemType*,shareType*}')
.expand(_parameters);
final _uri = Uri.parse('${_rootClient.baseURL}$_path');
final _request = _i3.Request('get', _uri);
_request.headers['Accept'] = 'application/json';
// coverage:ignore-start
final authentication = _i4.IterableExtension(_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;
}