Presence API for Cocoa Swift SDK

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

Presence lets you track who is online or offline and store custom state information. Presence shows:

• When a user has joined or left a channel
• How many users are subscribed to a particular channel (occupancy)
• Which channels a user or device is subscribed to
• Presence state associated with these users

Learn more about our Presence feature in the Presence overview.

Here now

Requires Presence

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

This method returns information about the current state of a channel, including a list of unique user IDs (universally unique identifiers, UUIDs) currently subscribed to the channel and the total occupancy count of the channel.

Cache

This method has a 3-second response cache time.

Method(s)

To call Here Now you can use the following method(s) in the Swift SDK:

1open func hereNowForChannel(
2    _ channel: String,
3    withCompletion closure: PubNub.PNHereNowCompletionBlock
4)

* required

Parameter	Description
channel * Type: String	Channel name to retrieve the Here Now information.
closure * Type: PNHereNowCompletionBlock	The completion closure has two arguments: result - in case of successful request processing (data field will contain results of presence audition operation); status - in case if error occurred during request processing (errorData contains error information).

1open func hereNowForChannel(
2    _ channel: String,
3    withVerbosity level: PNHereNowVerbosityLevel,
4    completion closure: PubNub.PNHereNowCompletionBlock
5)

* required

Parameter	Description
channel * Type: String	Channel name to retrieve the Here Now information.
level * Type: PNHereNowVerbosityLevel	PNHereNowVerbosityLevel enum filters the response based on the value selected.
closure * Type: PNHereNowCompletionBlock	The completion closure has two arguments: result - in case of successful request processing (data field will contain results of presence audition operation); status - in case if error occurred during request processing (errorData contains error information).

Sample code

Get a list of uuids subscribed to channel

1// With .UUID client will pull out list of unique identifiers and occupancy information.
2self.client.hereNowForChannel("my_channel", withVerbosity: .UUID,
3                              completion: { (result, status) in
4

5    if status == nil {
6

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

15        /**
16         Handle presence audit error. Check 'category' property to find
17         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

Response

Response objects which is returned by client when Here Now API for channel used:

1open class PNPresenceGlobalHereNowData : PNServiceData {
2

3    // Active channels list.
4    open var channels: [String : [AnyHashable : Any]] { get }
5    // Total number of active channels.
6    open var totalChannels: NSNumber { get }
7    // Total number of subscribers.
8    open var totalOccupancy: NSNumber { get }
9}
10

11open class PNPresenceChannelGroupHereNowData : PNPresenceGlobalHereNowData {
12

13}
14

15open class PNPresenceChannelGroupHereNowResult : PNResult {
16

17    // Stores reference on channel group presence request processing information.
18    open var data: PNPresenceChannelGroupHereNowData { get }
19}

show all 19 lines

Other examples

Returning state

Requires Presence

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

1/**
2    With .state client aside from occupancy and unique identifiers will will pull out
3    state information associated with them.
4    */
5self.client.hereNowForChannel("my_channel", withVerbosity: .state,
6                                completion: { (result, status) in
7

8    if status == nil {
9

10        /**
11            Handle downloaded presence information using:
12            result.data.uuids - list of uuids. Each uuid entry will have next
13                                fields: "uuid" - identifier and "state" if it
14                                has been provided.
15            result.data.occupancy - total number of active subscribers.
16            */
17    }
18    else {
19

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

26            Request can be resent using: status.retry()
27            */
28    }
29})

show all 29 lines

Example response

1{
2    "status" : 200,
3    "message" : "OK",
4    "service" : "Presence",
5    "uuids" : [
6        {
7            "uuid" : "myUUID0"
8        },
9        {
10            "state" : {
11                "abcd" : {
12                    "age" : 15
13                }
14            },
15            "uuid" : "myUUID1"
16        },
17        {
18            "uuid" : "b9eb408c-bcec-4d34-b4c4-fabec057ad0d"
19        },
20        {
21            "state" : {
22                "abcd" : {
23                    "age" : 15
24                }
25            },
26            "uuid" : "myUUID2"
27        },
28        {
29            "state" : {
30                "abcd" : {
31                    "age" : 24
32                }
33            },
34            "uuid" : "myUUID9"
35        }
36    ],
37    "occupancy" : 5
38}

show all 38 lines

Return occupancy only

Requires Presence

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

You can return only the occupancy information for a single channel by specifying the channel and setting UUIDs to false:

1// With .occupancy client will pull out only occupancy information.
2self.client.hereNowForChannel("my_channel", withVerbosity: .occupancy,
3                                completion: { (result, status) in
4

5    if status == nil {
6

7        /**
8            Handle downloaded presence information using:
9                result.data.occupancy - total number of active subscribers.
10            */
11    }
12    else {
13

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

20            Request can be resent using: status.retry()
21            */
22    }
23})

show all 23 lines

Example response

1{
2    "status": 200,
3    "message": "OK",
4    "payload": {
5        "channels": {
6            "81d8d989-b95f-443c-a726-04fac323b331": {
7                "uuids": [ "70fc1140-22b5-4abc-85b2-ff8c17b24d59" ],
8                "occupancy": 1
9            },
10            "81b7a746-d153-49e2-ab70-3037a75cec7e": {
11                "uuids": [ "91363e7f-584b-49cc-822c-52c2c01e5928" ],
12                "occupancy": 1
13            },
14            "c068d15e-772a-4bcd-aa27-f920b7a4eaa8": {
15                "uuids": [ "ccfac1dd-b3a5-4afd-9fd9-db11aeb65395" ],
16                "occupancy": 1
17            }
18        },
19        "total_channels": 3,
20        "total_occupancy": 3
21    },
22    "service": "Presence"
23}

show all 23 lines

Here now for channel groups

Request information about subscribers on specific channel group. This API method will retrieve the list of UUIDs along with their state for each remote data object and the number of subscribers.

Method(s)

To do Here Now for Channel Groups you can use the following method(s) in the Swift SDK:

1open func hereNowForChannelGroup(
2    _ group: String,
3    withCompletion closure: PubNub.PNChannelGroupHereNowCompletionBlock
4)

* required

Parameter	Description
group * Type: String	Channel Group name to retrieve the Here Now information.
closure * Type: PNChannelGroupHereNowCompletionBlock	The completion closure has two arguments: result - in case of successful request processing (data field will contain results of presence audition operation); status - in case if error occurred during request processing (errorData contains error information).

1open func hereNowForChannelGroup(
2    _ group: String,
3    withVerbosity level: PNHereNowVerbosityLevel,
4    completion closure: PubNub.PNChannelGroupHereNowCompletionBlock
5)

* required

Parameter	Description
group * Type: String	Channel Group name to retrieve the Here Now information.
level * Type: PNHereNowVerbosityLevel	PNHereNowVerbosityLevel enum filters the response based on the value selected.
closure * Type: PNChannelGroupHereNowCompletionBlock	The completion closure has two arguments: result - in case of successful request processing (data field will contain results of presence audition operation); status - in case if error occurred during request processing (errorData contains error information).

Sample code

Here now for channel groups

1self.client.hereNowForChannelGroup("my_group", withCompletion: { (result, status) in
2

3    if status == nil {
4

5        /**
6         Handle downloaded presence information using:
7            result.data.channels - dictionary with active channels and presence information on
8                                   each. Each channel will have next fields: "uuids" - list of
9                                   subscribers; occupancy - number of active subscribers.
10                                   Each uuids entry has next fields: "uuid" - identifier and
11                                   "state" if it has been provided.
12            result.data.totalChannels - total number of active channels.
13            result.data.totalOccupancy - total number of active subscribers.
14         */
15    }
16    else {
17

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

24         Request can be resent using: status.retry()
25         */
26    }
27})

show all 27 lines

Response

Response objects which is returned by client when Here Now API for channel group used:

1open class PNPresenceGlobalHereNowData : PNServiceData {
2

3    // Active channels list.
4    open var channels: [String : [AnyHashable : Any]] { get }
5    // Total number of active channels.
6    open var totalChannels: NSNumber { get }
7    // Total number of subscribers.
8    open var totalOccupancy: NSNumber { get }
9}
10

11open class PNPresenceChannelGroupHereNowData : PNPresenceGlobalHereNowData {
12

13}
14

15open class PNPresenceChannelGroupHereNowResult : PNResult {
16

17    // Stores reference on channel group presence request processing information.
18    open var data: PNPresenceChannelGroupHereNowData { get }
19}

show all 19 lines

Where now

Requires Presence

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

This method returns the list of channels a UUID is subscribed to.

Timeout events

If the app restarts (or the page refreshes) within the heartbeat window, no timeout event is generated.

Method(s)

To call whereNowUUID you can use the following method(s) in the Swift SDK:

1open func whereNowUUID(
2    _ uuid: String,
3    withCompletion closure: PubNub.PNWhereNowCompletionBlock
4)

* required

Parameter	Description
uuid * Type: String	The UUID for which request should be performed.
closure * Type: PNWhereNowCompletionBlock	The completion closure which will be called when the processing is complete, has two arguments: result - in case of successful processing (data will contain results of presence operation); status - in case of error while processing (errorDatacontains error information).

Sample code

You simply need to define the uuid and the callback function to be used to send the data to as in the example below.

Get a list of channels a UUID is subscribed to

1self.client.whereNowUUID(self.client.uuid(), withCompletion: { (result, status) in
2

3    if status == nil {
4

5        // Handle downloaded presence 'where now' information using: result.data.channels
6    }
7    else {
8

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

15         Request can be resent using: status.retry()
16         */
17    }
18})

show all 18 lines

Response

Response objects which is returned by client when Where Now API is used:

1open class PNPresenceWhereNowData : PNServiceData {
2

3    // List of channels on which client subscribed.
4    open var channels: [String] { get }
5}
6

7open class PNPresenceWhereNowResult : PNResult {
8

9    // Stores reference on client presence request processing information.
10    open var data: PNPresenceWhereNowData { get }
11}

User state

Requires Presence

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

Clients can set a dynamic custom state (score, game state, location) for their users on one or more channels and store it on a channel as long as the user stays subscribed.

The state is not persisted, and when the client disconnects, the state data is lost. For more information, refer to Presence State.

Method(s)

Set state

Set state on channels

1open func setState(
2    _ state: [String: Any]?,
3    forUUID uuid: String,
4    onChannel channel: String,
5    withCompletion closure: PubNub.PNSetStateCompletionBlock? = nil
6)

* required

Parameter	Description
state Type: [String : Any]	Reference on dictionary which should be bound to uuid on specified channel.If value is nil, state will be removed for uuid on channel.
uuid * Type: String	The unique user identifier for which state should be bound.
channel * Type: String	Channel name against which the store state information is stored.
closure Type: PNChannelStateCompletionBlock	The completion closure which will be called when the processing is complete, has one argument: request processing status - in case of error while processing (errorDatacontains error information).

Set state on channel groups

1open func setState(
2    _ state: [String: Any]?,
3    forUUID uuid: String,
4    onChannelGroup group: String,
5    withCompletion closure: PubNub.PNSetStateCompletionBlock? = nil
6)

* required

Parameter	Description
state Type: [String : Any]	Reference on dictionary which should be bound to uuid on specified channel group.If value is nil, state will be removed for uuid on group.
uuid * Type: String	The unique user identifier for which state should be bound.
group * Type: String!	Channel Group name against which the store state information is stored.
closure Type: PNChannelStateCompletionBlock	The completion closure which will be called when the processing is complete, has one argument: request processing status - in case of error while processing (errorDatacontains error information).

Get state

Get state from channels

1open func stateForUUID(
2    _ uuid: String,
3    onChannel channel: String,
4    withCompletion closure: PubNub.PNChannelStateCompletionBlock
5)

* required

Parameter	Description
uuid * Type: String	The unique user identifier for which state should be retrieved.
channel * Type: String	Channel name to retrieve the state information.
closure * Type: PNChannelStateCompletionBlock	The completion closure which will be called when the processing is complete, has two arguments: result - in case of successful processing (data will contain results of client state retrieve operation); status - in case of error while processing (errorDatacontains error information).

Get state from channel groups

1open func stateForUUID(
2    _ uuid: String,
3    onChannelGroup group: String,
4    withCompletion closure: PubNub.PNChannelGroupStateCompletionBlock
5)

* required

Parameter	Description
uuid * Type: String	The unique user identifier for which state should be retrieved.
group * Type: String	Channel Group name to retrieve the state information.
closure * Type: PNChannelGroupStateCompletionBlock	The completion closure which will be called when the processing is complete, has two arguments: result - in case of successful processing (data will contain results of client state retrieve operation); status - in case of error while processing (errorDatacontains error information).

Sample code

Set state

1self.client.setState(["Key": "Value"], forUUID: self.client.uuid(), onChannel: "my_channel",
2                     withCompletion: { (status) in
3

4    if !status.isError {
5

6        // Client state successfully modified on specified channel.
7    }
8    else {
9

10        /**
11         Handle client state modification error. Check 'category' property
12         to find 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

Get state

1self.client.stateForUUID(self.client.uuid(), onChannel: "chat",
2                         withCompletion: { (result, status) in
3

4    if status == nil {
5

6        // Handle downloaded state information using: result.data.state
7    }
8    else{
9

10        /**
11         Handle client state audit error. Check 'category' property
12         to find 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

Response

Set state

Response objects which is returned by client when Set State API for channels used:

1open class PNClientStateUpdateData : PNChannelClientStateData {
2

3}
4

5open class PNClientStateUpdateStatus : PNErrorStatus {
6

7    // Stores reference on client state for channel request processing information.
8    open var data: PNClientStateUpdateData { get }
9}

Get state

Response objects which is returned by client when Get State API for channel used:

1open class PNChannelClientStateData : PNServiceData {
2

3    // User-provided client state information.
4    open var state: [String : Any] { get }
5}
6

7open class PNChannelClientStateResult : PNResult {
8

9    // Stores reference on client state for channel request processing information.
10    open var data: PNChannelClientStateData { get }
11}

Response objects which is returned by client when Get State API for channel group used:

1open class PNChannelGroupClientStateData : PNServiceData {
2

3    // Multi channel client state information.
4    open var channels: [String : [AnyHashable : Any]] { get }
5}
6

7open class PNChannelGroupClientStateResult : PNResult {
8

9    // Stores reference on client state for channel group request processing information.
10    open var data: PNChannelGroupClientStateData { get }
11}

User state (builder pattern)

Requires Presence

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

The state API is used to set/get key/value pairs specific to a subscriber uuid.

State information is supplied as a JSON object of key/value pairs.

Method(s)

Set state

1state().set()
2    .uuid(String)
3    .state([String: Any])
4    .channels([String])
5    .channelGroups([String])
6    .performWithCompletion(PNSetStateCompletionBlock)

* required

Parameter	Description
uuid Type: String	Unique user identifier for which state should be bound. Current PubNub user ID will be used by default if not set or set to nil.
state Type: [String: Any]	Data which should be bound to specified uuid on channels / channelGroups.
channels Type: [String]	List of the channel names which will store provided state information for uuid. Not required if channelGroups is set.
channelGroups Type: [String]	List of channel group names which will store provided state information for uuid. Not required if channels is set.
completion Type: PNSetStateCompletionBlock	State modification for user on channel / channel group completion closure which pass only one argument - request status reports state change was successful or not (errorData contains error information in case of failure).

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

Get state

1state().audit()
2    .uuid(String)
3    .channels([String])
4    .channelGroups([String])
5    .performWithCompletion(PNGetStateCompletionBlock)

* required

Parameter	Description
uuid Type: String	Unique user identifier for which state should be retrieved. Current PubNub user ID will be used by default if not set or set to nil.
channels Type: [String]	List of the channel names from which state information for uuid will be pulled out. Not required if channelGroups is set.
channelGroups Type: [String]	List of channel group names from which state information for uuid will be pulled out. Not required if channels is set.
completion * Type: PNGetStateCompletionBlock	State audition for user on channel / channel group completion closure which pass two arguments: result - in case of successful request processing data field will contain results of client state retrieve operation; status - in case of error occurred during request processing.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

Sample code

Set state

1self.client.state().set().state(["state": "test"])
2    .channels(["channel1", "channel12"])
3    .channelGroups(["group1", "group2"])
4    .performWithCompletion({ (status) in
5

6        if !status.isError {
7            // Client state successfully modified on specified channels and groups.
8        } else {
9            /**
10             Handle client state modification error. Check 'category' property
11             to find out possible reason because of which request did fail.
12             Review 'errorData' property (which has PNErrorData data type) of status
13             object to get additional information about issue.
14

15             Request can be resent using: status.retry()
16            */
17        }
18    });

show all 18 lines

Get state

1self.client.state().audit().uuid("PubNub")
2    .channels(["channel1", "channel12"])
3    .channelGroups(["group1", "group2"])
4    .performWithCompletion({ (result, status) in
5

6        if status == nil {
7            // Handle downloaded state information using: result.data.channels
8        } else {
9            /**
10             Handle client state audit error. Check 'category' property
11             to find out possible reason because of which request did fail.
12             Review 'errorData' property (which has PNErrorData data type) of status
13             object to get additional information about issue.
14

15             Request can be resent using: status.retry()
16            */
17        }
18    });

show all 18 lines