$setStatus_Request method
Update the status type of the current user.
Returns a DynamiteRequest
backing the setStatus operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
statusType
The new status type.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: The status was updated successfully
- 400: The status type is invalid
See:
- setStatus for a method executing this request and parsing the response.
- $setStatus_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $setStatus_Request({
required String statusType,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final $statusType = _$jsonSerializers.serialize(statusType, specifiedType: const FullType(String));
_parameters['statusType'] = $statusType;
final _path =
_i4.UriTemplate('/ocs/v2.php/apps/user_status/api/v1/user_status/status{?statusType*}').expand(_parameters);
final _uri = Uri.parse('${_rootClient.baseURL}$_path');
final _request = _i3.Request('put', _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;
}