$admin_Request method
- @experimental
- required SettingsAdminRequestApplicationJson $body,
- SettingsAdminApiVersion? apiVersion,
- bool? oCSAPIRequest,
Update default notification settings for new users.
This endpoint requires admin access.
Returns a DynamiteRequest
backing the admin operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
apiVersion
Defaults to"v2"
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Admin settings updated
See:
- admin for a method executing this request and parsing the response.
- $admin_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $admin_Request({
required SettingsAdminRequestApplicationJson $body,
SettingsAdminApiVersion? apiVersion,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
var __apiVersion = _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(SettingsAdminApiVersion));
__apiVersion ??= 'v2';
_parameters['apiVersion'] = __apiVersion;
final _path = _i4.UriTemplate('/ocs/v2.php/apps/notifications/api/{apiVersion}/settings/admin').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 = _i5.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 _i6.HeaderEncoder().convert(__oCSAPIRequest);
_request.headers['Content-Type'] = 'application/json';
_request.body = json
.encode(_$jsonSerializers.serialize($body, specifiedType: const FullType(SettingsAdminRequestApplicationJson)));
return _request;
}