setPredefinedMessage method
Future<DynamiteResponse<UserStatusSetPredefinedMessageResponseApplicationJson, void> >
setPredefinedMessage({})
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 totrue
.
Status codes:
- 200: The message was updated successfully
- 400: The clearAt or message-id is invalid
See:
- $setPredefinedMessage_Request for the request send by this method.
- $setPredefinedMessage_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<UserStatusSetPredefinedMessageResponseApplicationJson, void>> setPredefinedMessage({
required String messageId,
int? clearAt,
bool? oCSAPIRequest,
}) async {
final _request = $setPredefinedMessage_Request(
messageId: messageId,
clearAt: clearAt,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $setPredefinedMessage_Serializer();
final _rawResponse =
await _i1.ResponseConverter<UserStatusSetPredefinedMessageResponseApplicationJson, void>(_serializer)
.convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}