$setCustomMessage_Request method

@experimental Request $setCustomMessage_Request({ String? statusIcon, String? message, int? clearAt, bool? oCSAPIRequest, })

Set the message to a custom message for the current user.

Returns a DynamiteRequest backing the setCustomMessage operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• statusIcon Icon of the status.
• message Message of the status.
• clearAt When the message should be cleared.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: The message was updated successfully
• 400: The clearAt or icon is invalid or the message is too long

See:

• setCustomMessage for a method executing this request and parsing the response.
• $setCustomMessage_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $setCustomMessage_Request({
  String? statusIcon,
  String? message,
  int? clearAt,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $statusIcon = _$jsonSerializers.serialize(statusIcon, specifiedType: const FullType(String));
  _parameters['statusIcon'] = $statusIcon;

  final $message = _$jsonSerializers.serialize(message, specifiedType: const FullType(String));
  _parameters['message'] = $message;

  final $clearAt = _$jsonSerializers.serialize(clearAt, specifiedType: const FullType(int));
  _parameters['clearAt'] = $clearAt;

  final _path = _i4.UriTemplate(
    '/ocs/v2.php/apps/user_status/api/v1/user_status/message/custom{?statusIcon*,message*,clearAt*}',
  ).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;
}