Message Actions API for Unity SDK

Use message actions to add or remove metadata on published messages. Common uses include receipts and reactions. Clients subscribe to a channel to receive message action events. Clients can also fetch past message actions from Message Persistence, either independently or when fetching original messages.

Reactions

"Message Reactions" is a specific application of the Message Actions API for emoji or social reactions.

Message Actions vs. Message Reactions

Message Actions is the flexible, low-level API for adding any metadata to messages (read receipts, delivery confirmations, custom data), while Message Reactions specifically refers to using Message Actions for emoji/social reactions.

In PubNub Core and Chat SDKs, the same underlying Message Actions API is referred to as Message Reactions when used for emoji reactions - it's the same functionality, just different terminology depending on the use case.

Add message action

Requires Message Persistence

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

Add an action to a published message. The response includes the added action.

Method(s)

Use this Unity method:

pubnub.AddMessageAction()
    .Channel(string)
    .MessageTimetoken(long)
    .Action(PNMessageAction)
    .Execute(System.Action<PNAddMessageActionResult, PNStatus>)

* required

Parameter	Description
Channel * Type: string	Channel name to add the message action to.
MessageTimetoken * Type: long	Timetoken of the target message.
Action * Type: PNMessageAction	Message action payload.
Execute * Type: System.Action	System.Action of type PNAddMessageActionResult.
ExecuteAsync Type: None	Returns Task<PNResult<PNAddMessageActionResult>>.

PNMessageAction

* required

Parameter	Description
Type * Type: string	Message action type.
Value * Type: string	Message action value.

Sample code

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.

Returns

The AddMessageAction() operation returns a PNAddMessageActionResult which contains the following properties:

Property Name	Type	Description
MessageTimetoken	long	Timetoken of the message to be associated with message action.
ActionTimetoken	long	Timetoken of the message action that will be associated with the message.
Action	PNMessageAction	Message action payload.
→ Type	string	Type of the message action.
→ Value	string	Value of the message action.
Uuid	string	UUID associated with the message action.

{
    "MessageTimetoken":15610547826969050,
    "ActionTimetoken":15610547826970050,
    "Action":{
        "type":"reaction",
        "value":"smiley_face"
    },
    "Uuid":"user-456"
}

Remove message action

Requires Message Persistence

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

Remove a previously added action from a published message. The response is empty.

Method(s)

Use this Unity method:

pubnub.RemoveMessageAction()
    .Channel(string)
    .MessageTimetoken(long)
    .ActionTimetoken(long)
    .Uuid(string)
    .Execute(System.Action<PNRemoveMessageActionResult, PNStatus>)

* required

Parameter	Description
Channel * Type: string	Channel name to remove the message action from.
MessageTimetoken * Type: long	Publish timetoken of the original message.
ActionTimetoken * Type: long	Publish timetoken of the message action to be removed.
Uuid * Type: string	UUID of the message.
Execute * Type: System.Action	System.Action of type PNRemoveMessageActionResult.
ExecuteAsync Type: None	Returns Task<PNResult<PNRemoveMessageActionResult>>.

Sample code

Returns

The RemoveMessageAction() operation returns no actionable data.

Get message actions

Requires Message Persistence

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

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

Truncated response

The number of message actions 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 actions.

Method(s)

Use this Unity method:

pubnub.GetMessageActions()
    .Channel(string)
    .Start(long)
    .End(long)
    .Limit(int)
    .Execute(System.Action<PNGetMessageActionsResult, PNStatus>)

* required

Parameter	Description
Channel * Type: string Default: n/a	The channel name.
Start Type: long Default: n/a	Message Action timetoken denoting the start of the range requested (return values will be greater than or equal to start).
End Type: long Default: n/a	Message Action timetoken denoting the end of the range requested (return values will be less than end).
Limit Type: int Default: 100	Specifies the number of actions to return in response. Default/Maximum is 100.
Execute * Type: System.Action Default: n/a	System.Action of type PNGetMessageActionsResult.
ExecuteAsync Type: None Default: n/a	Returns Task<PNResult<PNGetMessageActionsResult>>.

Sample code

Returns

The GetMessageActions() operations returns PNGetMessageActionsResult which contains the following properties:

Property Name	Type	Description
Message Actions	List<PNMessageActionItem>	List of Message Actions.
More	MoreInfo	Pagination information.

The PNMessageActionItem has the following properties:

Property Name	Type	Description
→  MessageTimetoken	long	Timetoken associated with the message.
→  Action	PNMessageAction	Message Action payload.
→  →  Type	string	Type of the Message Action.
→  →  Value	string	Value of the Message Action.
→  Uuid	string	UUID associated with the action.
→  ActionTimetoken	long	Timetoken associated with the action.

The More has the following properties:

Property Name	Type	Description
→  →  Start	long	Timetoken denoting the start of the requested range.
→  →  End	long	Timetoken denoting the end of the requested range.
→  →  Limit	int	Number of Message Actions returned in response.

{
    "MessageActions":
    [{
        "MessageTimetoken":15610547826969050,
    "Action":{
        "type":"reaction",
        "value":"smiley_face"
    },
    "Uuid":"pn-5903a053-592c-4a1e-8bfd-81d92c962968",
    "ActionTimetoken":15717253483027900
    }],
    "More": {
        "Start": 15610547826970050,
        "End": 15645905639093361,
        "Limit": 2

show all 17 lines