$setCustomMessage_Request method

@experimental Request $setCustomMessage_Request({ bool? oCSAPIRequest, UserStatusSetCustomMessageRequestApplicationJson? $body, })

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:

• 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({
  bool? oCSAPIRequest,
  UserStatusSetCustomMessageRequestApplicationJson? $body,
}) {
  const _path = '/ocs/v2.php/apps/user_status/api/v1/user_status/message/custom';
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.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 _i5.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = $body != null
      ? json.encode(
          _$jsonSerializers.serialize(
            $body,
            specifiedType: const FullType(UserStatusSetCustomMessageRequestApplicationJson),
          ),
        )
      : json.encode(
          _$jsonSerializers.serialize(
            UserStatusSetCustomMessageRequestApplicationJson(),
            specifiedType: const FullType(UserStatusSetCustomMessageRequestApplicationJson),
          ),
        );
  return _request;
}