Message Reactions API for Java SDK

Breaking changes in v9.0.0

PubNub Java SDK version 9.0.0 unifies the codebases for Java and Kotlin SDKs, introduces a new way of instantiating the PubNub client, and changes asynchronous API callbacks and emitted status events. These changes can impact applications built with previous versions (< 9.0.0) of the Java SDK.

For more details about what has changed, refer to Java/Kotlin SDK migration guide.

Add or remove actions on published messages to build features like receipts, reactions, or to associate custom metadata to messages. Clients can subscribe to a channel to receive message reaction events on that channel. They can also fetch past message reactions from Message Persistence independently or when they fetch original messages.

Terminology

All message reactions in code are collectively called message reactions in the docs and the term applies both to reacting to a message (through emojis) and acting on a message (by deleting it).

Add Message Reaction​

Requires Message Persistence

This method requires that Message Persistence is enabled for your key in the Admin Portal.

Add an action on a published message. Returns the added action in the response.

Method(s)​

To add a Message Reaction you can use the following method(s) in the Java SDK:

this.pubnub.addMessageAction()
    .channel(String)
    .messageAction(PNMessageAction);
* required
ParameterDescription
channel *
Type: String
Specifies channel name to publish message reactions to.
messageAction *
Type: PNMessageAction
The message reaction object containing the message reaction's type, value and the publish timetoken of the original message.
async *
Type: Consumer<Result>
Consumer of a Result of type PNAddMessageActionResult.

Basic Usage​

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

import com.pubnub.api.PubNubException;
import com.pubnub.api.java.PubNub;
import com.pubnub.api.java.v2.PNConfiguration;
import com.pubnub.api.UserId;
import com.pubnub.api.enums.PNLogVerbosity;
import com.pubnub.api.models.consumer.message_actions.PNMessageAction;

public class MessageActionApp {
    public static void main(String[] args) throws PubNubException {
        // Configure PubNub instance
        PNConfiguration.Builder configBuilder = PNConfiguration.builder(new UserId("demoUserId"), "demo");
        configBuilder.publishKey("demo");
        configBuilder.logVerbosity(PNLogVerbosity.BODY);
        configBuilder.secure(true);

show all 40 lines

Returns​

The addMessageAction() operation returns a PNAddMessageActionResult which contains the following operations:

MethodDescription
getType()
Type: String
Message reaction's type.
getValue()
Type: String
Message reaction's value.
getUuid()
Type: String
Publisher of the message reaction.
getActionTimetoken()
Type: Long
Timestamp when the message reaction was created.
getMessageTimetoken()
Type: Long
Timestamp when the actual message was created the message reaction belongs to.

PNMessageAction​

MethodDescription
setType()
Type: String
Message reaction's type.
setValue()
Type: String
Message reaction's value.
setMessageTimetoken()
Type: Long
Timestamp of the actual message was created the message reaction belongs to.

Remove Message Reaction​

Requires Message Persistence

This method requires that Message Persistence is enabled for your key in the Admin Portal.

Remove a previously added action on a published message. Returns an empty response.

Method(s)​

To Remove a Message Reaction you can use the following method(s) in the Java SDK:

this.pubnub.removeMessageAction()
    .channel(String)
    .messageTimetoken(Long)
    .actionTimetoken(Long);
* required
ParameterDescription
channel *
Type: String
Specifies channel name to publish message reactions to.
messageTimetoken *
Type: Long
Publish timetoken of the original message
actionTimetoken *
Type: Long
Publish timetoken of the message reaction to be removed.
async *
Type: Consumer<Result>
Consumer of a Result of type PNRemoveMessageActionResult.

Basic Usage​

pubnub.removeMessageAction()
        .channel("my_channel")
        .messageTimetoken(15701761818730000L)
        .actionTimetoken(15701775691010000L)
        .async(result -> { /* check result */ });

Returns​

The removeMessageAction() operation returns a no actionable data.

Get Message Reactions​

Requires Message Persistence

This method requires that Message Persistence is enabled for your key in the Admin Portal.

Get a list of message reactions in a channel. Returns a list of actions sorted by the action's timetoken in ascending order.

Truncated response

Number of message reactions in the response may be truncated when internal limits are hit. If the response is truncated, a more property will be returned with additional parameters. Send iterative calls to Message Persistence adjusting the parameters to fetch more message reactions.

Method(s)​

To Get Message Reactions you can use the following method(s) in the Java SDK:

this.pubnub.getMessageActions()
    .channel(String)
    .start(Long)
    .end(Long)
    .limit(Integer);
* required
ParameterDescription
channel *
Type: String
Default:
n/a
The channel name.
start
Type: Long
Default:
n/a
Message Reaction timetoken denoting the start of the range requested (return values will be less than start).
end
Type: Long
Default:
n/a
Message Reaction timetoken denoting the end of the range requested (return values will be greater than or equal to end).
limit
Type: Integer
Default:
100
Specifies the number of actions to return in response. Default/Maximum is 100.
async *
Type: Consumer<Result>
Default:
n/a
Consumer of a Result of type PNGetMessageActionsResult.

Basic Usage​

pubnub.getMessageActions()
        .channel("my_channel")
        .async(result -> {
            result.onSuccess(res -> {
                List<PNMessageAction> actions = res.getActions();
                for (PNMessageAction action : actions) {
                    System.out.println(action.getType());
                    System.out.println(action.getValue());
                    System.out.println(action.getUuid());
                    System.out.println(action.getActionTimetoken());
                    System.out.println(action.getMessageTimetoken());
                }
            }).onFailure(exception -> {
                exception.printStackTrace();
            });
show all 16 lines

Returns​

The getMessageActions() operation returns a list of PNGetMessageActionsResult objects, each containing the following operations:

MethodDescription
getType()
Type: String
Message reaction's type.
getValue()
Type: String
Message reaction's value.
getUuid()
Type: String
Publisher of the message reaction.
getActionTimetoken()
Type: Long
Timestamp when the message reaction was created.
getMessageTimetoken()
Type: Long
Timestamp when the actual message was created the message reaction belongs to.

Other Examples​

Fetch Messages with paging​

public static void main(String args[]){
    getMessageActionsWithPaging("my_channel", System.currentTimeMillis() * 10_000L, new Callback() {
            @Override
            public void onMore(List<PNMessageAction> actions) {
                System.out.println("Next set of actions: " + actions.size());
            }

            @Override
            public void onDone() {
                System.out.println("All actions fetched");
            }
        });
}

/**
show all 44 lines
Last updated on
On this page