setPredefinedMessage method

Future<DynamiteResponse<UserStatusSetPredefinedMessageResponseApplicationJson, void>> setPredefinedMessage({
  1. required String messageId,
  2. int? clearAt,
  3. bool? oCSAPIRequest,
})

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:

  • messageId ID of the predefined message.
  • 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 message-id is invalid

See:

Implementation

Future<_i1.DynamiteResponse<UserStatusSetPredefinedMessageResponseApplicationJson, void>> setPredefinedMessage({
  required String messageId,
  int? clearAt,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setPredefinedMessageRaw(
    messageId: messageId,
    clearAt: clearAt,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}