setCustomMessage method

Future<DynamiteResponse<UserStatusSetCustomMessageResponseApplicationJson, void>> setCustomMessage({ String? statusIcon, String? message, int? clearAt, 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:

• $setCustomMessage_Request for the request send by this method.
• $setCustomMessage_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<UserStatusSetCustomMessageResponseApplicationJson, void>> setCustomMessage({
  String? statusIcon,
  String? message,
  int? clearAt,
  bool? oCSAPIRequest,
}) async {
  final _request = $setCustomMessage_Request(
    statusIcon: statusIcon,
    message: message,
    clearAt: clearAt,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $setCustomMessage_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<UserStatusSetCustomMessageResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}