Constructor Detail

• MessageEditsMixin

  MessageEditsMixin(String basePath, ClientOptions clientOptions, ChannelOptions channelOptions, Auth auth)

Method Detail

• getMessage

   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

   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

   void 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

   void updateMessageAsync(Http http, Message message, MessageOperation operation, CompletionListener listener)

  Asynchronously updates an existing message.

  Parameters:

  message - A Message object containing the fields to update and the serial identifier.

  listener - A listener to be notified of the outcome of this operation.

• deleteMessage

   void 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

   void deleteMessageAsync(Http http, Message message, MessageOperation operation, CompletionListener listener)

  Asynchronously marks a message as deleted.

  Parameters:

  message - A Message object containing the serial identifier and operation metadata.

  listener - A listener to be notified of the outcome of this operation.

• getMessageVersions

   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

   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.