setCustomMessage method

Future<DynamiteResponse<UserStatusSetCustomMessageResponseApplicationJson, void>> setCustomMessage({
  1. String? statusIcon,
  2. String? message,
  3. int? clearAt,
  4. bool? oCSAPIRequest,
})

Set the message to a custom 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:

  • 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

Future<DynamiteResponse<UserStatusSetCustomMessageResponseApplicationJson, void>> setCustomMessage({
  String? statusIcon,
  String? message,
  int? clearAt,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setCustomMessageRaw(
    statusIcon: statusIcon,
    message: message,
    clearAt: clearAt,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}