Message Reactions API for PubNub Cocoa Swift SDK

This SDK has been replaced by a new PubNub Swift SDK written purely in Swift. Check it out here

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 Reaction

Requires Message Persistence

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

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 Swift SDK:

open func addMessageAction(with: PNAddMessageActionRequest, completion: PNAddMessageActionCompletionBlock?)

Parameter	Type	Required	Description
`request`	PNAddMessageActionRequest	Yes	`Add message action` request with all information about new `message action` which will be passed to PubNub service.
`closure`	PNAddMessageActionCompletionBlock	No	`Add message action` request completion `closure`.

PNAddMessageActionRequest

Parameter	Type	Required	Description
`type`	String	Yes	What feature this message action represents. Maximum `15` characters.
`value`	String	Yes	Value which should be added with message action type.
`channel`	String	Yes	Name of channel which stores the message for which `action` should be added.
`messageTimetoken`	NSNumber	Yes	Timetoken (PubNub's high precision timestamp) of message to which `action` should be added.

Basic Usage

let request = PNAddMessageActionRequest(channel: "chat", messageTimetoken: 1234567890)
request.type = "reaction"
request.value = "smile"

self.client.addMessageAction(with: request, completion: { status in
    if !status.isError {
        /**
         * Message action successfully added.
         * Created message action information available here: status.data.action
         */
    } else {
        if status.statusCode == 207 {
            // Message action has been added, but event not published.
        } else {
            /**
show all 23 lines

Response

Response objects which is returned by client when add message action Message Reaction API is used:

open class PNAddMessageActionData : PNServiceData {
    // Added message action.
    open var action: PNMessageAction? { get }
}

open class PNAddMessageActionStatus : PNAcknowledgmentStatus {
    // Add message action request processed information.
    open var data: PNAddMessageActionData { get }
}

Add Message Reaction (Builder Pattern)

Requires Message Persistence

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

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 Swift SDK:

addMessageAction()
    .channel(String)
    .messageTimetoken(NSNumber)
    .type(String)
    .value(String)
    .performWithCompletion(PNAddMessageActionCompletionBlock?)

Parameter	Type	Required	Description
`channel`	String	Yes	Name of channel which store message for which `action` should be added.
`messageTimetoken`	NSNumber	Yes	Timetoken of message for which `action` should be added.
`type`	String	Yes	What feature this `message action` represents.
`value`	String	Yes	Value which should be stored along with `message action`.
`closure`	PNAddMessageActionCompletionBlock	No	`Add message action` request completion `closure`.

Basic Usage

self.client.addMessageAction()
    .channel("chat")
    .name(1234567890)
    .type("reaction")
    .value("smile")
    .performWithCompletion({ status in
        if !status.isError {
            /**
             * Message action successfully added.
             * Created message action information available here: status.data.action
             */
        } else {
            if status.statusCode == 207 {
                // Message action has been added, but event not published.
            } else {
show all 24 lines

Response

Response objects which is returned by client when add message action Message Reaction API is used:

open class PNAddMessageActionData : PNServiceData {
    // Added message action.
    open var action: PNMessageAction? { get }
}

open class PNAddMessageActionStatus : PNAcknowledgmentStatus {
    // Add message action request processed information.
    open var data: PNAddMessageActionData { get }
}

Remove Message Reaction

Requires Message Persistence

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

Remove a peviously 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 Swift SDK:

open func removeMessageAction(
    with request: PNRemoveMessageActionRequest,
    completion: PNRemoveMessageActionCompletionBlock?
)

Parameter	Type	Required	Description
`request`	PNRemoveMessageActionRequest	Yes	`Remove message action` request with information about existing `message action`.
`closure`	PNRemoveMessageActionCompletionBlock	No	`Remove message action` request completion `closure`.

PNRemoveMessageActionRequest

Parameter	Type	Required	Description
`actionTimetoken`	NSNumber	Yes	Message action addition timetoken.
`channel`	NSString	Yes	Name of channel which store message for which action should be removed.
`messageTimetoken`	NSNumber	Yes	Timetoken (PubNub's high precision timestamp) of message to which `action` should be removed.

Basic Usage

let request = PNRemoveMessageActionRequest(channel: "chat", messageTimetoken: 1234567890)
request.actionTimetoken = 1234567891

self.client.removeMessageAction(with: request, completion: { status in
    if !status.isError {
        // Message action successfully removed.
    } else {
        /**
         * Handle remove message action error. Check 'category' property to find out possible
         * issue because of which request did fail.
         *
         * Request can be resent using: status.retry()
         */
    }
})

Response

Response objects which is returned by client when remove message action Message Reaction API is used:

open class PNErrorData : PNServiceData {
    // Stringified error information.
    open var information: String { get }
}

open class PNAcknowledgmentStatus : PNErrorStatus {
    // Whether status object represent error or not.
    open var isError: Bool { get }

    // Additional information related to error status object.
    open var data: PNErrorData { get }
}

Remove Message Reaction (Builder Pattern)

Requires Message Persistence

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

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

Method(s)

removeMessageAction()
    .channel(String)
    .messageTimetoken(NSNumber)
    .actionTimetoken(NSNumber)
    .performWithCompletion(PNRemoveMessageActionCompletionBlock?)

Parameter	Type	Required	Description
`channel`	String	Yes	Name of channel which store message for which `action` should be removed.
`messageTimetoken`	NSNumber	Yes	Timetoken of message for which `action` should be removed.
`actionTimetoken`	NSNumber	Yes	`Action` addition timetoken.
`closure`	PNCreateSpaceCompletionBlock	No	`Remove message action` request completion `closure`.

Basic Usage

self.client.removeMessageAction()
    .channel("channel")
    .messageTimetoken(1234567890)
    .actionTimetoken(1234567891)
    .performWithCompletion({ status in
        if !status.isError {
            // Message action successfully removed.
        } else {
            /**
             * Handle remove message action error. Check 'category' property to find out possible
             * issue because of which request did fail.
             *
             * Request can be resent using: status.retry()
            */
        }
show all 16 lines

Response

Response objects which is returned by client when remove message action Message Reaction API is used:

open class PNErrorData : PNServiceData {
    // Stringified error information.
    open var information: String { get }
}

open class PNAcknowledgmentStatus : PNErrorStatus {
    // Whether status object represent error or not.
    open var isError: Bool { get }

    // Additional information related to error status object.
    open var data: PNErrorData { get }
}

Get Message Reactions

Requires Message Persistence

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

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

Method(s)

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

open func fetchMessageActions(
    with request: PNFetchMessageActionsRequest,
    completion: PNFetchMessageActionsCompletionBlock
)

Parameter	Type	Required	Description
`request`	PNFetchMessageActionsRequest	Yes	`Fetch message actions` request with all information which should be used to fetch existing `messages actions`.
`closure`	PNFetchMessageActionsCompletionBlock	Yes	`Fetch message actions` request completion `closure`.

PNFetchMessageActionsRequest

Parameter	Type	Required	Description
`start`	NSNumber	Yes	Return values will be less than `start`.
`end`	NSNumber	Yes	Return values will be greater than or equal to `end`.
`limit`	UInt	Yes	Number of messages actions to return in response.
`channel`	String	Yes	Name of `channel` from which list of message actions should be retrieved.

Basic Usage

self.client.fetchMessageActions()
    .channel("chat")
    .start(1234567891)
    .limit(200)
    .performWithCompletion({ (result, status) in
        if !(status?.isError ?? false) {
            /**
             * Message actions successfully fetched.
             * Result object has following information:
             *     result.data.actions - list of message action instances
             *     result.data.start - fetched messages actions time range start (oldest message
             *         action timetoken).
             *     result.data.end - fetched messages actions time range end (newest action timetoken).
            */
        } else {
show all 23 lines

Response

Response objects which is returned by client when fetch message actions Message Reaction API is used:

open class PNFetchMessageActionsData : PNServiceData {
    // List of fetched messages actions.
    open var actions: [PNMessageAction] { get }

    /**
     * Fetched messages actions time range start (oldest message action timetoken).
     *
     * This timetoken can be used as 'start' value to fetch older messages actions.
    */
    open var start: NSNumber { get }

    // Fetched messages actions time range end (newest action timetoken).
    open var end: NSNumber { get }
}

show all 19 lines

Error response which is used in case of Message Reaction API call failure:

open class PNErrorData : PNServiceData {
    // Stringified error information.
    open var information: String { get }
}

open class PNErrorStatus : PNStatus {
    // Whether status object represent error or not.
    open var isError: Bool { get }

    // Additional information related to error status object.
    open var data: PNErrorData { get }
}

Get Message Reactions (Builder Pattern)

Requires Message Persistence

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

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

Method(s)

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

fetchMessageActions()
    .channel(String)
    .start(NSNumber)
    .end(NSNumber)
    .limit(UInt)
    .performWithCompletion(PNFetchMessageActionsCompletionBlock)

Parameter	Type	Required	Description
`channel`	String	Yes	Name of channel from which list of messages `actions` should be retrieved.
`start`	NSNumber	No	`Message action` timetoken denoting the start of the range requested. Return values will be less than start.
`end`	NSNumber	No	`Message action` timetoken denoting the end of the range requested. Return values will be greater than or equal to end.
`limit`	UInt	No	Number of `message actions` to return in response.
`closure`	PNFetchMessageActionsCompletionBlock	Yes	`Fetch message actions` request completion `closure`.

Basic Usage

self.client.fetchMessageActions()
    .channel("chat")
    .start(1234567891)
    .limit(200)
    .performWithCompletion({ (result, status) in
        if !(status?.isError ?? false) {
            /**
             * Message actions successfully fetched.
             * Result object has following information:
             *     result.data.actions - list of message action instances
             *     result.data.start - fetched messages actions time range start (oldest message
             *         action timetoken).
             *     result.data.end - fetched messages actions time range end (newest action timetoken).
            */
        } else {
show all 23 lines

Response

Response objects which is returned by client when fetch message actions Message Reaction API is used:

open class PNFetchMessageActionsData : PNServiceData {
    // List of fetched messages actions.
    open var actions: [PNMessageAction] { get }

    /**
     * Fetched messages actions time range start (oldest message action timetoken).
     *
     * This timetoken can be used as 'start' value to fetch older messages actions.
    */
    open var start: NSNumber { get }

    // Fetched messages actions time range end (newest action timetoken).
    open var end: NSNumber { get }
}

show all 19 lines

Error response which is used in case of Message Reaction API call failure:

open class PNErrorData : PNServiceData {
    // Stringified error information.
    open var information: String { get }
}

open class PNErrorStatus : PNStatus {
    // Whether status object represent error or not.
    open var isError: Bool { get }

    // Additional information related to error status object.
    open var data: PNErrorData { get }
}

Add Message Reaction​

Requires Message Persistence

Method(s)​

PNAddMessageActionRequest​

Basic Usage​

Response​

Add Message Reaction (Builder Pattern)​

Requires Message Persistence

Method(s)​

Basic Usage​

Response​

Remove Message Reaction​

Requires Message Persistence

Method(s)​

PNRemoveMessageActionRequest​

Basic Usage​

Response​

Remove Message Reaction (Builder Pattern)​

Requires Message Persistence

Method(s)​

Basic Usage​

Response​

Get Message Reactions​

Requires Message Persistence

Method(s)​

PNFetchMessageActionsRequest​

Basic Usage​

Response​

Get Message Reactions (Builder Pattern)​

Requires Message Persistence

Method(s)​

Basic Usage​

Response​

Add Message Reaction

Method(s)

PNAddMessageActionRequest

Basic Usage

Response

Add Message Reaction (Builder Pattern)

Method(s)

Basic Usage

Response

Remove Message Reaction

Method(s)

PNRemoveMessageActionRequest

Basic Usage

Response

Remove Message Reaction (Builder Pattern)

Method(s)

Basic Usage

Response

Get Message Reactions

Method(s)

PNFetchMessageActionsRequest

Basic Usage

Response

Get Message Reactions (Builder Pattern)

Method(s)

Basic Usage

Response