setVisibilityRaw method
- @experimental
Update the visibility of a parameter.
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:
paramId
ID of the parameter.visibility
New visibility.targetUserId
ID of the user.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Visibility updated successfully
- 400: Updating visibility is not possible
- 403: Not allowed to edit other users visibility
- 404: User not found
See:
- setVisibility for an operation that returns a
DynamiteResponse
with a stable API.
Implementation
@_i4.experimental
_i1.DynamiteRawResponse<ProfileApiSetVisibilityResponseApplicationJson, void> setVisibilityRaw({
required String paramId,
required String visibility,
required String targetUserId,
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,
);
} else {
throw Exception('Missing authentication for bearer_auth or basic_auth');
}
// coverage:ignore-end
final $paramId = _$jsonSerializers.serialize(paramId, specifiedType: const FullType(String));
_parameters['paramId'] = $paramId;
final $visibility = _$jsonSerializers.serialize(visibility, specifiedType: const FullType(String));
_parameters['visibility'] = $visibility;
final $targetUserId = _$jsonSerializers.serialize(targetUserId, specifiedType: const FullType(String));
_parameters['targetUserId'] = $targetUserId;
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/profile/{targetUserId}{?paramId*,visibility*}').expand(_parameters);
return _i1.DynamiteRawResponse<ProfileApiSetVisibilityResponseApplicationJson, void>(
response: _rootClient.executeRequest(
'put',
_path,
headers: _headers,
validStatuses: const {200},
),
bodyType: const FullType(ProfileApiSetVisibilityResponseApplicationJson),
headersType: null,
serializers: _$jsonSerializers,
);
}