Cocoa Objective-C API & SDK Docs 6.1.0

Unsupported SDK

PubNub no longer supports this SDK, but you are welcome to contribute.

Get code: CocoaPods

CocoaPods is a dependency manager and this is by far the easiest and quickest way to get started with PubNub Cocoa SDK! (If you don't have pods installed yet you can check CocoaPods installation section for installation guide).

Be sure you are running CocoaPods 1.0.0 or above! You can install the latest cocoapods gem:

1gem install cocoapods

If you've already installed you can upgrade to the latest CocoaPods gem using:

1gem update cocoapods

Get code: Git

Add the PubNub Cocoa SDK folder to your project.

Get code: framework

The PubNub framework project allows you to build standalone framework bundles which can be copied right into your application.

To build the framework as a standalone bundle and integrate into project, perform the following:

1. Clone the PubNub master repository

   1git clone git@github.com:pubnub/objective-c.git

2. Navigate to root of the cloned repository

3. Run the CocoaPods pod install command to pull out all required dependencies

   1`pod install`

4. Open the PubNub.xcworkspace from the PubNub repository in Xcode.

5. Select the Framework or Universal Framework target for target platform and hit Cmd+B to build the selected type of framework.

6. Navigate to the Framework directory and find the Products directory.

7. Drag&Drop PubNub.framework bundle from the Products directory to your application.

8. Select the Copy items if needed checkbox and click Finish.

9. Open your project's General tab and scroll to Embedded Binaries.

10. Click on + and select PubNub.framework file.

PubNub-Universal

If the PubNub target has been used, then the framework will be generated only for the selected platform (device or simulator.) If you try to use the framework to compile for another platform, it will crash during run-time. Using the PubNub-Universal build target (which can be used on both device and simulator) will help mitigate any sort of crash scenarios during development.

Now that these steps are complete, let's learn more about how to use the framework in your app.

Using the framework with your app

At this point, you should have the framework added to your application project, we'll need to make your project aware of the PubNub framework.

You need to import the PubNub headers in classes where it will be used.

1#import <PubNub/PubNub.h>

Get code: Carthage

To build the framework as a standalone bundle and integrate into project, perform the following:

1. Install latest Carthage (if required).

2. Create a Cartfile (any location can be used) or use existing file.

   1touch Cartfile

3. Add next line into a Cartfile which will allow to build framework bundles

   1github "pubnub/objective-c" ~> 4.1

4. Update and rebuild the project's dependencies (update command ensure what latest PubNub client code will be used to build framework). build can be used if frameworks has been built before and it will be much faster because git clone will be skipped.

   1carthage update

   Command above will build framework for all configured platforms, but if only one required it can be called like this

   1carthage update --platform ios

   Instead of ios can be used: mac, tvos or watchos

5. Navigate to the Carthage directory and find the Build directory.

6. Navigate to directory which represent your target platform. For example: iOS

7. Drag&Drop PubNub.framework bundle from the Products directory to your application.

8. Select the Copy items if needed checkbox and click Finish.

9. Open your project's General tab and scroll to Embedded Binaries.

10. Click on + and select PubNub.framework file.

Using the framework with your app

At this point, you should have the framework added to your application project, we'll need to make your project aware of the PubNub framework.

You need to import the PubNub headers in classes where it will be used.

1#import <PubNub/PubNub.h>

Get code: source

• Objective-C V4

• View Supported Platforms

Hello World

Include PubNub SDK in your project you need to use CocoaPods

Install CocoaPods gem by following the procedure defined above. To add the PubNub SDK to your project with CocoaPods, there are four basic tasks to complete which are covered below:

1. Create new Xcode project.

2. Create Podfile in new Xcode project root folder

   1touch Podfile

3. The PubNub client can be added as module (only with a deployment target of OS X 10.9 and above):

   1source 'https://github.com/CocoaPods/Specs.git'
   2platform :osx, "10.9"
   3use_frameworks!
   4
   
   5target 'application-target-name' do
   6    pod "PubNub", "~> 4.1"
   7end

   If you have any other pods you'd like to include, or if you have other targets you'd to add (like a test target) add those entries to this Podfile as well. See the CocoaPods documentation for more information on Podfile configuration.

4. Install your pods by running pod install via the command line from the directory that contains your Podfile.

Work within the workspace

After installing your Pods, you should only be working within the workspace generated by CocoaPods or specified by you in Podfile. Always open the newly generated workspace file, not the original project file.

To be able to use PubNub SDK within your application code you need to import it. Import PubNub SDK headers in implementation files for classes where you need to use it using this import statement:

1#import <PubNub/PubNub.h>

Complete application delegate configuration

Add the PNObjectEventListener protocol to AppDelegate in implementation file to anonymous category:

Required UUID

Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.

1#import <PubNub/PubNub.h>
2

3@interface AppDelegate () <PNObjectEventListener>
4

5// Stores reference on PubNub client to make sure what it won't be released.
6@property (nonatomic, strong) PubNub *client;
7

8@end

Required UUID

Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.

1// Initialize and configure PubNub client instance
2PNConfiguration *configuration = [PNConfiguration configurationWithPublishKey:@"demo" subscribeKey:@"demo"];
3configuration.uuid = @"myUniqueUUID";
4

5self.client = [PubNub clientWithConfiguration:configuration];
6[self.client addListener:self];
7

8// Subscribe to demo channel with presence observation
9[self.client subscribeToChannels: @[@"my_channel"] withPresence:YES];
10

11// Handle new message from one of channels on which client has been subscribed.
12- (void)client:(PubNub *)client didReceiveMessage:(PNMessageResult *)message {
13

14    // Handle new message stored in message.data.message
15    if (![message.data.channel isEqualToString:message.data.subscription]) {
16

17        // Message has been received on channel group stored in message.data.subscription.
18    }
19    else {
20

21        // Message has been received on channel stored in message.data.channel.
22    }
23

24    NSLog(@"Received message: %@ on channel %@ at %@", message.data.message[@"msg"],
25        message.data.channel, message.data.timetoken);
26}
27

28// New presence event handling.
29- (void)client:(PubNub *)client didReceivePresenceEvent:(PNPresenceEventResult *)event {
30

31    if (![event.data.channel isEqualToString:event.data.subscription]) {
32

33        // Presence event has been received on channel group stored in event.data.subscription.
34    }
35    else {
36

37        // Presence event has been received on channel stored in event.data.channel.
38    }
39

40    if (![event.data.presenceEvent isEqualToString:@"state-change"]) {
41

42        NSLog(@"%@ \"%@'ed\"\nat: %@ on %@ (Occupancy: %@)", event.data.presence.uuid,
43            event.data.presenceEvent, event.data.presence.timetoken, event.data.channel,
44            event.data.presence.occupancy);
45    }
46    else {
47

48        NSLog(@"%@ changed state at: %@ on %@ to: %@", event.data.presence.uuid,
49            event.data.presence.timetoken, event.data.channel, event.data.presence.state);
50    }
51}
52

53// Handle subscription status change.
54- (void)client:(PubNub *)client didReceiveStatus:(PNStatus *)status {
55

56    if (status.operation == PNSubscribeOperation) {
57

58        // Check whether received information about successful subscription or restore.
59        if (status.category == PNConnectedCategory || status.category == PNReconnectedCategory) {
60

61            // Status object for those categories can be casted to `PNSubscribeStatus` for use below.
62            PNSubscribeStatus *subscribeStatus = (PNSubscribeStatus *)status;
63            if (subscribeStatus.category == PNConnectedCategory) {
64

65                // This is expected for a subscribe, this means there is no error or issue whatsoever.
66

67                // Select last object from list of channels and send message to it.
68                NSString *targetChannel = [client channels].lastObject;
69                [self.client publish: @{ @"msg": @"hello" }
70                    toChannel: targetChannel withCompletion:^(PNPublishStatus *publishStatus) {
71

72                    // Check whether request successfully completed or not.
73                    if (!publishStatus.isError) {
74

75                      // Message successfully published to specified channel.
76                    }
77                    else {
78

79                      /**
80                       Handle message publish error. Check 'category' property to find out
81                       possible reason because of which request did fail.
82                       Review 'errorData' property (which has PNErrorData data type) of status
83                       object to get additional information about issue.
84

85                       Request can be resent using: [publishStatus retry];
86                      */
87                    }
88                }];
89            }
90            else {
91

92                /**
93                 This usually occurs if subscribe temporarily fails but reconnects. This means there was
94                 an error but there is no longer any issue.
95                 */
96            }
97        }
98        else if (status.category == PNUnexpectedDisconnectCategory) {
99

100            /**
101             This is usually an issue with the internet connection, this is an error, handle
102             appropriately retry will be called automatically.
103             */
104        }
105        // Looks like some kind of issues happened while client tried to subscribe or disconnected from
106        // network.
107        else {
108

109            PNErrorStatus *errorStatus = (PNErrorStatus *)status;
110            if (errorStatus.category == PNAccessDeniedCategory) {
111

112                /**
113                 This means that Access Manager does allow this client to subscribe to this channel and channel group
114                 configuration. This is another explicit error.
115                 */
116            }
117            else {
118

119                /**
120                 More errors can be directly specified by creating explicit cases for other error categories
121                 of `PNStatusCategory` such as: `PNDecryptionErrorCategory`,
122                 `PNMalformedFilterExpressionCategory`, `PNMalformedResponseCategory`, `PNTimeoutCategory`
123                 or `PNNetworkIssuesCategory`
124                 */
125            }
126        }
127    }
128}

show all 128 lines

Copy and paste examples

In addition to the Hello World sample code, we also provide some copy and paste snippets of common API functions:

Init

Instantiate a new Pubnub instance. Only the subscribeKey is mandatory. Also include publishKey if you intend to publish from this instance, and the secretKey if you wish to perform Access Manager administrative operations from this Cocoa instance.

Secure your secretKey

It is not a best practice to include the secret key in client-side code for security reasons.

When you init with secretKey, you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels.

Required UUID

Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.

1PNConfiguration *configuration = [PNConfiguration configurationWithPublishKey:@"demo"
2                                                                 subscribeKey:@"demo"];
3configuration.uuid = @"myUniqueUUID";
4self.client = [PubNub clientWithConfiguration:configuration];

PubNub instance as property

PubNub instance should be placed as a property in a long-life object (otherwise PubNub instance will be automatically removed as autoreleased object).

1@property (nonatomic, strong) PubNub *client;

Listeners

Add listeners

Listener's class should conform to PNEventsListener protocol to have access to available callbacks.

1// Adding listener.
2[pubnub addListener:self];
3

4// Callbacks listed below.
5

6- (void)client:(PubNub *)pubnub didReceiveMessage:(PNMessageResult *)message {
7    NSString *channel = message.data.channel; // Channel on which the message has been published
8    NSString *subscription = message.data.subscription; // Wild-card channel or channel on which PubNub client actually subscribed
9    NSNumber *timetoken = message.data.timetoken; // Publish timetoken
10    id msg = message.data.message; // Message payload
11    NSString *publisher = message.data.publisher; // Message publisher
12}
13

14- (void)client:(PubNub *)pubnub didReceiveSignal:(PNSignalResult *)signal {
15    NSString *channel = signal.data.channel; // Channel on which the signal has been published
16    NSString *subscription = signal.data.subscription; // Wild-card channel or channel on which PubNub client actually subscribed
17    NSNumber *timetoken = signal.data.timetoken; // Signal timetoken
18    id msg = signal.data.message; // Signal payload
19    NSString *publisher = signal.data.publisher; // Signal publisher
20}
21

22- (void)client:(PubNub *)pubnub didReceiveMessageAction:(PNMessageActionResult *)action {
23    NSString *channel = action.data.channel; // Channel on which the message has been published
24    NSString *subscription = action.data.subscription; // Wild-card channel or channel on which PubNub client actually subscribed
25    NSString *event = action.data.event; // Can be: added or removed
26    NSString *type = action.data.action.type; // Message reaction type
27    NSString *value = action.data.action.value; // Message reaction value
28    NSNumber *messageTimetoken = action.data.action.messageTimetoken; // Timetoken of the original message
29    NSNumber *actionTimetoken = action.data.action.actionTimetoken; // Timetoken of the message reaction
30    NSString *uuid = action.data.action.uuid; // UUID of user which added / removed message reaction
31}
32

33- (void)client:(PubNub *)pubnub didReceivePresenceEvent:(PNPresenceEventResult *)event {
34    NSString *channel = event.data.channel; // Channel on which presence changes
35    NSString *subscription = event.data.subscription; // Wild-card channel or channel on which PubNub client actually subscribed
36    NSString *presenceEvent = event.data.presenceEvent; // Can be: join, leave, state-change, timeout or interval
37    NSNumber *occupancy = event.data.presence.occupancy; // Number of users subscribed to the channel (not available for state-change event)
38    NSNumber *timetoken = event.data.presence.timetoken; // Presence change timetoken
39    NSString *uuid = event.data.presence.uuid; // UUID of user for which presence change happened
40

41    // Only for 'state-change' event
42    NSDictionary *state = event.data.presence.state; // User state (only for state-change event)
43

44    // Only for 'interval' event
45    NSArray<NSString *> *join = event.data.presence.join; // UUID of users which recently joined channel
46    NSArray<NSString *> *leave = event.data.presence.leave; // UUID of users which recently leaved channel
47    NSArray<NSString *> *timeout = event.data.presence.timeout; // UUID of users which recently timed out on channel
48}
49

50- (void)client:(PubNub *)pubnub didReceiveObjectEvent:(PNObjectEventResult *)event {
51    NSString *channel = event.data.channel; // Channel to which the event belongs
52    NSString *subscription = event.data.subscription; // Wild-card channel or channel on which PubNub client actually subscribed
53    NSString *eventName = event.data.event; // Can be: set or delete
54    NSString *type = event.data.type; // Entity type: channel, uuid or membership
55    NSNumber *timestamp = event.data.timestamp; // Event timestamp
56

57    PNChannelMetadata *channelMetadata = event.data.channelMetadata; // Updated channel metadata (only for channel entity type)
58    PNUUIDMetadata *uuidMetadata = event.data.uuidMetadata; // Updated channel metadata (only for uuid entity type)
59    PNMembership *membership = event.data.membership; // Updated channel metadata (only for membership entity type)
60}
61

62- (void)client:(PubNub *)pubnub didReceiveFileEvent:(PNFileEventResult *)event {
63    NSString *channel = event.data.channel; // Channel to which file has been uploaded
64    NSString *subscription = event.data.subscription; // Wild-card channel or channel on which PubNub client actually subscribed
65    id message = event.data.message; // Message added for uploaded file
66    NSString *publisher = event.data.publisher; // UUID of file uploader
67    NSURL *fileDownloadURL = event.data.file.downloadURL; // URL which can be used to download file
68    NSString *fileIdentifier = event.data.file.identifier; // Unique file identifier
69    NSString *fileName = event.data.file.name; // Name with which file has been stored remotely
70}
71

72- (void)client:(PubNub *)pubnub didReceiveStatus:(PNStatus *)status {
73    PNStatusCategory category = status.category; // One of PNStatusCategory fields to identify status of operation processing
74    PNOperationType operation = status.operation; // One of PNOperationType fields to identify for which operation status received
75    BOOL isError = status.isError; // Whether any kind of error happened.
76    NSInteger statusCode = status.statusCode; // Related request processing status code
77    BOOL isTLSEnabled = status.isTLSEnabled; // Whether secured connection enabled
78    NSString *uuid = status.uuid; // UUID which configured for passed client
79    NSString *authKey = status.authKey; // Auth key configured for passed client
80    NSString *origin = status.origin; // Origin against which request has been sent
81    NSURLRequest *clientRequest = status.clientRequest; // Request which has been used to send last request (may be nil)
82    BOOL willAutomaticallyRetry = status.willAutomaticallyRetry; // Whether client will try to perform automatic retry
83

84    // Following information available when operation == PNSubscribeOperation, because status is PNSubscribeStatus instance in this case
85    PNSubscribeStatus *subscribeStatus = (PNSubscribeStatus *)status;
86    NSNumber *currentTimetoken = subscribeStatus.currentTimetoken; // Timetoken which has been used for current subscribe request
87    NSNumber *lastTimeToken = subscribeStatus.lastTimeToken; // Timetoken which has been used for previous subscribe request
88    NSArray<NSString *> *subscribedChannels = subscribeStatus.subscribedChannels; // List of channels on which client currently subscribed
89    NSArray<NSString *> *subscribedChannelGroups = subscribeStatus.subscribedChannelGroups; // List of channel groups on which client currently subscribed
90    NSString *channel = subscribeStatus.data.channel; // Name of channel for which status has been received
91    NSString *subscription = subscribeStatus.data.subscription; // Wild-card channel or channel on which PubNub client actually subscribed
92    NSNumber *timetoken = subscribeStatus.data.timetoken; // Timetoken at which event arrived
93    NSDictionary *userMetadata = subscribeStatus.data.userMetadata; // Metadata / envelope which has been passed along with event
94

95    // Following information available when isError == YES, because status is PNErrorStatus instance in this case
96    PNErrorStatus *errorStatus = (PNErrorStatus *)status;
97    id associatedObject = errorStatus.associatedObject; // Data which may contain related information (not decrypted message for example)
98    NSArray<NSString *> *erroredChannels = errorStatus.errorData.channels; // List of channels for which error reported (mostly because of Access Manager)
99    NSArray<NSString *> *erroredChannelGroups = errorStatus.errorData.channelGroups; // List of channel groups for which error reported (mostly because of Access Manager)
100    NSString *errorInformation = errorStatus.errorData.information; // Stringified information about error
101    id errorData = errorStatus.errorData.data; // Additional error information from PubNub service
102}

show all 102 lines

Remove listeners

1[pubnub removeListener:self]

Listener status events

Category	Description
PNAcknowledgmentCategory	An API call was successful. This status has additional details based on the type of the successful operation.
PNAccessDeniedCategory	Access Manager permission failure.
PNTimeoutCategory	Server didn't respond in time for reported operation request.
PNNetworkIssuesCategory	No connection to Internet.
PNRequestMessageCountExceededCategory	The SDK announces this error if requestMessageCountThreshold is set, and the number of messages received from PubNub (in-memory cache messages) exceeds the threshold.
PNConnectedCategory	The SDK subscribed to new channels / channel groups.
PNReconnectedCategory	The SDK was able to reconnect to PubNub.
PNDisconnectedCategory	The SDK unsubscribed from channels / channel groups.
PNUnexpectedDisconnectCategory	The SDK unexpectedly lost ability to receive live updated from PubNub.
PNRequestURITooLongCategory	Reported operation request URI too long (too many channels / channel groups).
PNMalformedFilterExpressionCategory	The SDK has been configured with malformed filtering expression.
PNMalformedResponseCategory	The SDK received unexpected PubNub service response.
PNDecryptionErrorCategory	The SDK unable to decrypt received message using configured cipherKey.
PNTLSConnectionFailedCategory	The SDK unable to establish secured connection.
PNTLSUntrustedCertificateCategory	The SDK unable to check certificates trust chain.

Subscribe

Subscribe (listen on) a channel (it's async!):

1/**
2 Subscription results arrive to a listener which should implement the
3 PNObjectEventListener protocol and be registered as follows:
4 */
5[self.client addListener:self];
6[self.client subscribeToChannels: @[@"my_channel1", @"my_channel2"] withPresence:NO];
7

8// Handle a new message from a subscribed channel
9- (void)client:(PubNub *)client didReceiveMessage:(PNMessageResult *)message {
10    // Reference to the channel group containing the chat the message was sent to
11    NSString *subscription = message.data.subscription;
12    NSLog(@"%@ sent message to '%@' at %@: %@", message.data.publisher, message.data.channel,
13            message.data.timetoken, message.data.message);
14}
15

16// Handle a subscription status change
17- (void)client:(PubNub *)client didReceiveStatus:(PNStatus *)status {
18

19    if (status.operation == PNSubscribeOperation) {
20

21        // Check to see if the message is about a successful subscription or restore
22        if (status.category == PNConnectedCategory || status.category == PNReconnectedCategory) {
23

24            // Status object for those categories can be cast to `PNSubscribeStatus` for use below.
25            PNSubscribeStatus *subscribeStatus = (PNSubscribeStatus *)status;
26            if (subscribeStatus.category == PNConnectedCategory) {
27

28                // For a subscribe, this is expected, and means there are no errors or issues
29            }
30            else {
31

32                // This usually occurs if there is a transient error. The subscribe fails but
33                 // then reconnects, and there is no longer any issue.
34            }
35        }
36        else if (status.category == PNUnexpectedDisconnectCategory) {
37

38            // This is usually an issue with the internet connection.
39            // This is an error: handle appropriately, and retry will be called automatically.
40        }
41        // An issue occurred while the client tried to subscribe,
42        // or the client was disconnected from the network
43        else {
44

45            PNErrorStatus *errorStatus = (PNErrorStatus *)status;
46            if (errorStatus.category == PNAccessDeniedCategory) {
47

48                // Access Manager prohibited this client from subscribing to this channel and channel group.
49                // This is another explicit error.
50            }
51            else {
52

53                /**
54                 You can directly specify more errors by creating explicit cases
55                 for other categories of `PNStatusCategory` errors, such as:
56                 - `PNDecryptionErrorCategory`
57                 - `PNMalformedFilterExpressionCategory`
58                 - `PNMalformedResponseCategory`
59                 - `PNTimeoutCategory`
60                 - `PNNetworkIssuesCategory`
61                 */
62            }
63        }
64    }
65    else if (status.operation == PNUnsubscribeOperation) {
66

67        if (status.category == PNDisconnectedCategory) {
68

69            // This is the expected category for an unsubscribe.
70            // There were no errors in unsubscribing from everything.
71        }
72    }
73    else if (status.operation == PNHeartbeatOperation) {
74

75        /**
76         Heartbeat operations can have errors, so check first for an error.
77         For more information on how to configure heartbeat notifications through the status
78         PNObjectEventListener callback, refer to
79         http://www.pubnub.com/docs/sdks/objective-c/api-reference/configuration#configuration_basic_usage
80         */
81

82        if (!status.isError) { /* Heartbeat operation was successful */ }
83        else { /* There was an error with the heartbeat operation: handle it here */ }
84    }
85}
86

87// Handle a new signal from a subscribed channel
88- (void)client:(PubNub *)client didReceiveSignal:(PNSignalResult *)signal {
89    NSLog(@"%@ sent signal to '%@' at %@: %@", signal.data.publisher, signal.data.channel,
90          signal.data.timetoken, signal.data.message);
91}
92

93// Handle new object event from one of channels on which client has been subscribed.
94- (void)client:(PubNub *)client didReceiveObjectEvent:(PNObjectEventResult *)event {
95    NSLog(@"'%@' has been %@'ed at %@", event.data.type, event.data.event,
96        event.data.timestamp);
97}

show all 97 lines

Event listeners

The response of the call is handled by adding a Listener. Please see the Listeners section for more details. Listeners should be added before calling the method.

Publish

Publish a message to a channel:

1[self.client publish: @{@"Dictionary": @[@"with",@"array",@"as", @"value"]}
2           toChannel: @"pubnub" withCompletion:^(PNPublishStatus *status) {
3

4    if (!status.isError) {
5

6        // Message successfully published to specified channel.
7    }
8    else {
9

10        /**
11         Handle message publish error. Check 'category' property to find
12         out possible reason because of which request did fail.
13         Review 'errorData' property (which has PNErrorData data type) of status
14         object to get additional information about issue.
15

16         Request can be resent using: [status retry];
17         */
18    }
19}];

show all 19 lines

Here now

Get occupancy of who's here now on the channel by UUID:

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

1// With PNHereNowUUID client will pull out list of unique identifiers and occupancy information.
2[self.client hereNowForChannel: @"my_channel" withVerbosity:PNHereNowUUID
3                    completion:^(PNPresenceChannelHereNowResult *result,
4                                 PNErrorStatus *status) {
5

6    // Check whether request successfully completed or not.
7    if (!status) {
8

9        /**
10         Handle downloaded presence information using:
11            result.data.uuids - list of uuids.
12            result.data.occupancy - total number of active subscribers.
13         */
14    }
15    else {
16

17        /**
18         Handle presence audit error. Check 'category' property to find
19         out possible reason because of which request did fail.
20         Review 'errorData' property (which has PNErrorData data type) of status
21         object to get additional information about issue.
22

23         Request can be resent using: [status retry];
24         */
25    }
26}];

show all 26 lines

Presence

Subscribe to real-time Presence events, such as join, leave, and timeout, by UUID. Setting the presence attribute to a callback will subscribe to presents events on my_channel:

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

1/**
2 Subscription process results arrive to listener which should adopt to
3 PNObjectEventListener protocol and registered using:
4 */
5[self.client addListener:self];
6[self.client subscribeToPresenceChannels:@[@"my_channel"]];
7

8// New presence event handling.
9- (void)client:(PubNub *)client didReceivePresenceEvent:(PNPresenceEventResult *)event {
10

11    if (![event.data.channel isEqualToString:event.data.subscription]) {
12

13        // Presence event has been received on channel group stored in event.data.subscription.
14    }
15    else {
16

17        // Presence event has been received on channel stored in event.data.channel.
18    }
19

20    if (![event.data.presenceEvent isEqualToString:@"state-change"]) {
21

22        NSLog(@"%@ \"%@'ed\"\nat: %@ on %@ (Occupancy: %@)", event.data.presence.uuid,
23              event.data.presenceEvent, event.data.presence.timetoken, event.data.channel,
24              event.data.presence.occupancy);
25    }
26    else {
27

28        NSLog(@"%@ changed state at: %@ on %@ to: %@", event.data.presence.uuid,
29              event.data.presence.timetoken, event.data.channel, event.data.presence.state);
30    }
31}

show all 31 lines

Event listeners

The response of the call is handled by adding a Listener. Please see the Listeners section for more details. Listeners should be added before calling the method.

History

Retrieve published messages from archival storage:

Requires Message Persistence

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

1[self.client historyForChannel: @"my_channel" start:nil end:nil limit:100
2                withCompletion:^(PNHistoryResult *result, PNErrorStatus *status) {
3

4    if (!status) {
5

6        /**
7         Handle downloaded history using:
8            result.data.start - oldest message time stamp in response
9            result.data.end - newest message time stamp in response
10            result.data.messages - list of messages
11         */
12    }
13    else {
14

15        /**
16         Handle message history download error. Check 'category' property
17         to find out possible reason because of which request did fail.
18         Review 'errorData' property (which has PNErrorData data type) of status
19         object to get additional information about issue.
20

21         Request can be resent using: [status retry];
22         */
23    }
24}];

show all 24 lines

Unsubscribe

Stop subscribing (listening) to a channel.

1/**
2 Unsubscription process results arrive to listener which should adopt to
3 PNObjectEventListener protocol and registered using:
4 */
5[self.client addListener:self];
6[self.client unsubscribeFromChannels: @[@"my_channel1", @"my_channel2"] withPresence:NO];
7

8// Handle subscription status change.
9- (void)client:(PubNub *)client didReceiveStatus:(PNStatus *)status {
10

11    if (status.operation == PNUnsubscribeOperation && status.category == PNDisconnectedCategory) {
12

13        /**
14         This is the expected category for an unsubscribe. This means there was no error in
15         unsubscribing from everything.
16         */
17    }
18}

show all 18 lines

Event listeners

The response of the call is handled by adding a Listener. Please see the Listeners section for more details. Listeners should be added before calling the method.