setCustomMessageRaw method

  1. @experimental
DynamiteRawResponse<UserStatusSetCustomMessageResponseApplicationJson, void> setCustomMessageRaw({
  1. String? statusIcon,
  2. String? message,
  3. int? clearAt,
  4. bool? oCSAPIRequest,
})

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

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:

  • 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:

Implementation

@experimental
DynamiteRawResponse<UserStatusSetCustomMessageResponseApplicationJson, void> setCustomMessageRaw({
  String? statusIcon,
  String? message,
  int? clearAt,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || 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 $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;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path =
      UriTemplate('/ocs/v2.php/apps/user_status/api/v1/user_status/message/custom{?statusIcon*,message*,clearAt*}')
          .expand(_parameters);
  return DynamiteRawResponse<UserStatusSetCustomMessageResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'put',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(UserStatusSetCustomMessageResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}