-
public class MessageEditsMixin
-
-
Constructor Summary
Constructors Constructor Description MessageEditsMixin(String basePath, ClientOptions clientOptions, ChannelOptions channelOptions, Auth auth)
-
Method Summary
Modifier and Type Method Description MessagegetMessage(Http http, String serial)Retrieves the latest version of a specific message by its serial identifier. voidgetMessageAsync(Http http, String serial, Callback<Message> callback)Asynchronously retrieves the latest version of a specific message by its serial identifier. UpdateDeleteResultupdateMessage(Http http, Message message, MessageOperation operation)Updates an existing message using patch semantics. voidupdateMessageAsync(Http http, Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback)Asynchronously updates an existing message. UpdateDeleteResultdeleteMessage(Http http, Message message, MessageOperation operation)Marks a message as deleted. voiddeleteMessageAsync(Http http, Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback)Asynchronously marks a message as deleted. UpdateDeleteResultappendMessage(Http http, Message message, MessageOperation operation)Appends message text to the end of the message. voidappendMessageAsync(Http http, Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback)Asynchronously appends message text to the end of the message. PaginatedResult<Message>getMessageVersions(Http http, String serial, Array<Param> params)Retrieves all historical versions of a specific message. voidgetMessageVersionsAsync(Http http, String serial, Array<Param> params, Callback<AsyncPaginatedResult<Message>> callback)Asynchronously retrieves all historical versions of a specific message. -
-
Constructor Detail
-
MessageEditsMixin
MessageEditsMixin(String basePath, ClientOptions clientOptions, ChannelOptions channelOptions, Auth auth)
-
-
Method Detail
-
getMessage
@Blocking() Message getMessage(Http http, String serial)
Retrieves the latest version of a specific message by its serial identifier.
This method allows you to fetch the current state of a message, including any updatesor deletions that have been applied since its creation.
- Parameters:
serial- The unique serial identifier of the message to retrieve.
-
getMessageAsync
@NonBlocking() void getMessageAsync(Http http, String serial, Callback<Message> callback)
Asynchronously retrieves the latest version of a specific message by its serial identifier.
- Parameters:
serial- The unique serial identifier of the message to retrieve.callback- A callback to handle the result asynchronously.
-
updateMessage
@Blocking() UpdateDeleteResult updateMessage(Http http, Message message, MessageOperation operation)
Updates an existing message using patch semantics.
Non-null fields in the provided message (name, data, extras) will replace the correspondingfields in the existing message, while null fields will be left unchanged.
- Parameters:
message- A Message object containing the fields to update and the serial identifier.Only non-null fields will be applied to the existing message.
-
updateMessageAsync
@NonBlocking() void updateMessageAsync(Http http, Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback)
Asynchronously updates an existing message.
- Parameters:
message- A Message object containing the fields to update and the serial identifier.callback- A listener to be notified of the outcome of this operation.
-
deleteMessage
@Blocking() UpdateDeleteResult deleteMessage(Http http, Message message, MessageOperation operation)
Marks a message as deleted.
This operation does not remove the message from history; it marks it as deletedwhile preserving the full message history. The deleted message can still beretrieved and will have its action set to MESSAGE_DELETE.
- Parameters:
message- A Message message containing the serial identifier.
-
deleteMessageAsync
@NonBlocking() void deleteMessageAsync(Http http, Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback)
Asynchronously marks a message as deleted.
- Parameters:
message- A Message object containing the serial identifier and operation metadata.callback- A listener to be notified of the outcome of this operation.
-
appendMessage
@Blocking() UpdateDeleteResult appendMessage(Http http, Message message, MessageOperation operation)
Appends message text to the end of the message.
- Parameters:
message- A Message object containing the serial identifier and data to append.operation- operation details such as clientId, description, or metadata
-
appendMessageAsync
@NonBlocking() void appendMessageAsync(Http http, Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback)
Asynchronously appends message text to the end of the message.
- Parameters:
message- A Message object containing the serial identifier and data to append.operation- operation details such as clientId, description, or metadatacallback- A listener to be notified of the outcome of this operation.
-
getMessageVersions
@Blocking() PaginatedResult<Message> getMessageVersions(Http http, String serial, Array<Param> params)
Retrieves all historical versions of a specific message.
This method returns a paginated result containing all versions of the message,ordered chronologically. Each version includes metadata about when and by whomthe message was modified.
- Parameters:
serial- The unique serial identifier of the message.params- Query parameters for filtering or pagination (e.g., limit, start, end).
-
getMessageVersionsAsync
@NonBlocking() void getMessageVersionsAsync(Http http, String serial, Array<Param> params, Callback<AsyncPaginatedResult<Message>> callback)
Asynchronously retrieves all historical versions of a specific message.
- Parameters:
serial- The unique serial identifier of the message.params- Query parameters for filtering or pagination.callback- A callback to handle the result asynchronously.
-
-
-
-