Message Actions API for PubNub C# SDK

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 action events on that channel. They can also fetch past message actions from Message Persistence independently or when they fetch original messages.

Add Message Action

Requires Message Persistence add-on

This method requires that the Message Persistence add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Description

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

Method(s)

To Add a Message Action you can use the following method(s) in the C# V4 SDK:

pubnub.AddMessageAction().Channel(string).MessageTimetoken(long).Action(PNMessageAction)
ParameterTypeRequiredDescription
ChannelstringYesSpecifies channel name to publish message actions to.
MessageTimetokenlongYesTimestamp when the actual message was created the message action belongs to.
ActionPNMessageActionYesSpecify the action you want to publish of type PNMessageAction.

PNMessageAction

ParameterTypeRequiredDescription
TypestringYesMessage action's type.
ValuestringYesMessage action's value.

Basic Usage

pubnub.AddMessageAction()
.Channel("my_channel")
.MessageTimetoken(5610547826969050)
.Action(new PNMessageAction { Type = "reaction", Value = "smiley_face" })
.Execute(new PNAddMessageActionResultExt((result, status) =>
{
//result is of type PNAddMessageActionResult.
}));

Returns

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

Remove Message Action

Requires Message Persistence add-on

This method requires that the Message Persistence add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Description

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

Method(s)

To Remove a Message Action you can use the following method(s) in the C# V4 SDK:

pubnub.RemoveMessageAction().Channel(string).MessageTimetoken(long).ActionTimetoken(long).Uuid(string)
ParameterTypeRequiredDescription
ChannelstringYesSpecifies channel name to publish message actions to.
MessageTimetokenlongYesPublish timetoken of the original message
ActionTimetokenlongYesPublish timetoken of the message action to be removed.
UuidstringYesUUID of the message.

Basic Usage

pubnub.RemoveMessageAction()
.Channel("my_channel")
.MessageTimetoken(15701761818730000)
.ActionTimetoken(15701775691010000)
.Uuid("mytestuuid")
.Execute(new PNRemoveMessageActionResultExt((result, status) =>
{
//empty result of type PNRemoveMessageActionResult.
}));

Returns

The RemoveMessageAction() operation returns a no actionable data.

Get Message Actions

Requires Message Persistence add-on

This method requires that the Message Persistence add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Description

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

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 storage adjusting the parameters to fetch more message actions.

Method(s)

To Get Message Actions you can use the following method(s) in the C# V4 SDK:

pubnub.GetMessageActions().Channel(string).Start(long).End(long).Limit(int)
ParameterTypeRequiredDefaultDescription
ChannelstringYesThe channel name.
StartlongOptionalMessage Action timetoken denoting the start of the range requested (return values will be less than start).
EndlongOptionalMessage Action timetoken denoting the end of the range requested (return values will be greater than or equal to end).
LimitintOptional100Specifies the number of actions to return in response. Default/Maximum is 100.

Basic Usage

pubnub.GetMessageActions()
.Channel("my_channel")
.Execute(new PNGetMessageActionsResultExt((result, status) =>
{
//result is of type PNGetMessageActionsResult.
}));

Returns

{
"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
Last updated on