Using message reactions

Message reactions allow users to send back an emoji reaction (for example, a thumbs up or a smiley face) or a custom reaction on a message that they received. These reactions are typically visible to all users in the chat room and displayed with the original message.

User ID / UUID

User ID is also referred to as UUID/uuid in some APIs and server responses but holds the value of the userId parameter you set during initialization.

Add a reaction

Use the addMessageAction to add a reaction to a message in a channel. You can use the method to add an emoji reaction to a message, or to add any custom reaction as long as it's a string.

You need to provide your own emoji library; this isn't included in the PubNub SDKs.

JavaScript

1pubnub.addMessageAction(
2    {
3        channel: 'channel1',
4        messageTimetoken: '15610547826970040',
5        action: {
6            type: 'reaction',
7            value: 'smiley_face',
8        },
9    },
10    function(status, response) {
11        // handle the response
12    }
13);

Swift

1extension MyAppMessageAction: MessageAction {}
2

3let action = MyAppMessageAction(type: "reaction", value: "smiley_face")
4

5pubnub.addMessageAction(
6  channel: "ch-1",
7  message: action,
8  messageTimetoken: 15610547826970040
9) { result in
10  switch result {
11  case let .success(response):
12    print("Successfully Message Reaction Add Response: \(response)")
13  case let .failure(error):
14    print("Error from failed response: \(error.localizedDescription)")
15  }
16})

show all 16 lines

Java

1pubnub.addMessageAction()
2    .channel("ch_1")
3    .messageAction(new PNMessageAction()
4            .setType("reaction")
5            .setValue("smiley_face")
6            .setMessageTimetoken(15610547826970040L)
7    )
8    .async(result -> {
9        result.onSuccess(res -> {
10            System.out.println(res.getType());
11            System.out.println(res.getValue());
12            System.out.println(res.getUuid());
13            System.out.println(res.getActionTimetoken());
14            System.out.println(res.getMessageTimetoken());
15        }).onFailure(exception -> {
16            exception.printStackTrace();
17        });
18    });

show all 18 lines

Unity

1MessageActionAdd messageAct = new MessageActionAdd();
2messageAct.ActionType = "reaction";
3messageAct.ActionValue = "smiley_face";
4

5pubnub.AddMessageActions().Channel("ch-1").MessageAction(messageAct).MessageTimetoken(15610547826970040).Async((result, status) => {
6        if (!status.Error) {
7            Debug.Log("result.ActionTimetoken: " + result.ActionTimetoken);
8            Debug.Log("result.ActionType: " + result.ActionType);
9            Debug.Log("result.ActionValue: " + result.ActionValue);
10            Debug.Log("result.MessageTimetoken: " + result.MessageTimetoken);
11            Debug.Log("result.UserID: " + result.UserId);
12        } else {
13            Debug.Log(status.Error);
14            Debug.Log(status.ErrorData.Info);
15        }
16});

show all 16 lines

Remove a reaction

Use the removeMessageAction() method to remove a reaction from a message by providing an actionTimetoken and messageTimetoken for the original message.

JavaScript

1pubnub.removeMessageAction(
2  {
3    channel: 'ch-1',
4    messageTimetoken: '15610547826970040',
5    actionTimetoken: '15610547826999081',
6  },
7  function(status, response) {
8

9  }
10);

Swift

1pubnub.removeMessageActions(
2  channel: "ch-1",
3  message: 15610547826970040,
4  action: 15610547826999081
5) { result in
6  switch result {
7  case let .success(response):
8    print("Successfully Message Reaction Remove Response: \(response)")
9  case let .failure(error):
10    print("Error from failed response: \(error.localizedDescription)")
11  }
12})

Java

1pubnub.removeMessageAction()
2    .channel("ch-1")
3    .messageTimetoken(15610547826970040L)
4    .actionTimetoken(15610547826999081L)
5    .async(result -> { /* check result */ });

Unity

1pubnub.RemoveMessageActions().ActionTimetoken(15610547826999081).Channel("ch-1").MessageTimetoken(    .messageTimetoken(15610547826970040L)
2).Async((result, status) => {
3        if (!status.Error) {
4            // result has no actionable data
5        } else {
6            Debug.Log(status.Error);
7            Debug.Log(status.ErrorData.Info);
8        }
9});

Fetch reactions in channel

Reactions are stored in history alongside messages when they are added by a user.

Use the getMessageActions method to fetch reactions on a channel. The method works much like other PubNub history methods and allows you to pass a start and end timetoken and fetch all message reactions that were published during that time.

JavaScript

1pubnub.getMessageActions(
2  {
3    channel: 'chats.room1',
4    start: '15901706735798836',
5    end: '15901706735370016',
6    limit: 100,
7  },
8  function(status, response) {
9    console.log(status, response);
10  }
11);

Swift

1pubnub.fetchMessageActions(
2  channel: "chats.room1") { result in
3    switch result {
4    case let .success(response):
5      print("Successfully Message Reaction Fetch Response: \(response)")
6

7    case let .failure(error):
8      print("Error from failed response: \(error.localizedDescription)")
9    }
10})

Objective-C

1PNFetchMessageActionsRequest *request =
2    [PNFetchMessageActionsRequest requestWithChannel:@"chats.room1"];
3

4request.start = @(1234567891);
5request.limit = 100;
6

7[self.pubnub fetchMessageActionsWithRequest:request
8      completion:^(PNFetchMessageActionsResult *result, PNErrorStatus *status) {
9

10  if (!status.isError) {
11

12  }
13  else {
14

15  }
16}];

show all 16 lines

Java

1pubnub.getMessageActions()
2    .channel("chats.room1")
3    .async(result -> {
4        result.onSuccess(res -> {
5            List<PNMessageAction> actions = res.getActions();
6            for (PNMessageAction action : actions) {
7                System.out.println(action.getType());
8                System.out.println(action.getValue());
9                System.out.println(action.getUuid());
10                System.out.println(action.getActionTimetoken());
11                System.out.println(action.getMessageTimetoken());
12            }
13        }).onFailure(exception -> {
14            exception.printStackTrace();
15        });
16    });

show all 16 lines

C#

1pubnub.GetMessageActions()
2  .Channel("chats.room1")
3  .Execute(new PNGetMessageActionsResultExt((result, status) =>
4  {
5

6  }));

Return Type: PNGetMessageActionsResult

1{
2  "MessageActions":[{
3    "MessageTimetoken":15610547826970040,
4    "Action":{
5        "type":"reaction",
6        "value":"smiley_face"
7    },
8    "Uuid":"pn-5903a053-592c-4a1e-8bfd-81d92c962968",
9    "ActionTimetoken": 15610547826999081
10  }],
11}

Python

1pubnub.get_message_actions()
2        .channel('chats.room1')
3        .start(15901706735798836) # Some start timetoken or None
4        .end(15901706735370016) # Some end timetoken or None
5        .pn_async(message_action_callback)
6

Fetch messages with reactions

Use the fetchMessages method with the includeMessageActions parameter set to fetch past messages in a channel along with reactions that were added to those messages. When you're fetching messages with their reactions, you can only fetch on a single channel at a time.

Message Reaction events

PubNub triggers events to notify clients when reactions are added to or removed from messages. To receive these events, clients should be subscribed to the channel, and add a messageAction listener in the code.

Event	Description
Message Reaction Added	Generated when a message reaction is added to a message.
Message Reaction Removed	Generated when a message reaction is removed from a message.

Message Reaction Added:

1{
2   "channel":"my_channel",
3   "subscription":null,
4   "timetoken":"15610547826970040",
5   "publisher":"user-1",
6   "message":{
7      "source":"actions",
8      "version":"1.0",
9      "action":"added",
10      "data":{
11         "type":"reaction",
12         "value":"smiley_face",
13         "messageTimetoken":"15610547826970040",
14         "actionTimetoken":"15610547826999081"
15      }
16   }
17}

show all 17 lines

Message Reaction Removed:

1{
2   "channel":"my_channel",
3   "subscription":null,
4   "timetoken":"15610547826970040",
5   "publisher":"user-1",
6   "message":{
7      "source":"actions",
8      "version":"1.0",
9      "action":"removed",
10      "data":{
11         "type":"reaction",
12         "value":"smiley_face",
13         "messageTimetoken":"15610547826970040",
14         "actionTimetoken":"15610547826999081"
15      }
16   }
17}

show all 17 lines