setPredefinedMessage method

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

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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 message-id is invalid

See:

Implementation

Future<_i1.DynamiteResponse<UserStatusSetPredefinedMessageResponseApplicationJson, void>> setPredefinedMessage({
  required UserStatusSetPredefinedMessageRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) async {
  final _request = $setPredefinedMessage_Request(
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $setPredefinedMessage_Serializer();
  return _i1.ResponseConverter<UserStatusSetPredefinedMessageResponseApplicationJson, void>(_serializer)
      .convert(_response);
}