setReminderRaw method

  1. @experimental
DynamiteRawResponse<ChatSetReminderResponseApplicationJson, void> setReminderRaw({
  1. required int timestamp,
  2. required String token,
  3. required int messageId,
  4. ChatSetReminderApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Set a reminder for a chat message.

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:

  • timestamp Timestamp of the reminder.
  • apiVersion Defaults to v1.
  • token
  • messageId ID of the message.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 201: Reminder created successfully
  • 404: Message not found

See:

  • setReminder for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<ChatSetReminderResponseApplicationJson, void> setReminderRaw({
  required int timestamp,
  required String token,
  required int messageId,
  ChatSetReminderApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.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 $timestamp = _$jsonSerializers.serialize(timestamp, specifiedType: const FullType(int));
  _parameters['timestamp'] = $timestamp;

  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i2.checkPattern(
    $token as String?,
    RegExp(r'^[a-z0-9]{4,30}$'),
    'token',
  );
  _parameters['token'] = $token;

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

  var $apiVersion = _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(ChatSetReminderApiVersion));
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

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

  final _path =
      _i3.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/{messageId}/reminder{?timestamp*}')
          .expand(_parameters);
  return _i1.DynamiteRawResponse<ChatSetReminderResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      headers: _headers,
      validStatuses: const {201},
    ),
    bodyType: const FullType(ChatSetReminderResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}