Utility Methods API for Android SDK

Unsupported docs

PubNub no longer maintains Android SDK docs, but our Java SDK or Kotlin SDK are fully compatible with the Android platform and you can use them to build mobile apps, ensuring stable software development.

The methods on this page are utility methods that don't fit into other categories.

Create push payload

This method creates the push payload for use in the appropriate endpoint calls.

Method(s)

1PushPayloadHelper()
2        .setApnsPayload(PushPayloadHelper.APNSPayload)
3        .setFcmPayload(PushPayloadHelper.FCMPayload)
4        .setCommonPayload(Map<String, Object>)
5        .build()

* required

Parameter	Description
setApnsPayload() Type: APNSPayload	Set APNs and APNs2 Payload. Associated devices will receive only the data supplied here within the pn_apns key.
setFcmPayload() Type: FCMPayload	Set FCM Payload. Associated devices will receive only the data supplied here within the pn_fcm key.
setCommonPayload() Type: Map<String, Object>	Set common Payload. Native PubNub subscribers will receive the data provided here, together with the pn_apns, and pn_fcm objects.
build() * Type: Map<String, Object>	Builds the payload from the values set using the parameters.

Sample code

Create push payload

1// Create an instance of PushPayloadHelper
2PushPayloadHelper pushPayloadHelper = new PushPayloadHelper();
3

4// Setup FCM parameters (FCMPayload)
5PushPayloadHelper.FCMPayload fcmPayload = new PushPayloadHelper.FCMPayload();
6// The FCMPayload includes a custom Notification object, which FCM itself uses
7// to display the message automatically to end-user devices on behalf of the
8// client app.
9// Notification messages have a predefined set of user-visible keys
10PushPayloadHelper.FCMPayload.Notification fcmNotification =
11        new PushPayloadHelper.FCMPayload.Notification()
12                .setTitle("Notification title")
13                .setBody("Notification body text")
14                .setImage("http://example.com/image.png");
15fcmPayload.setNotification(fcmNotification);
16// Data messages contain only your user-defined custom key-value pairs
17Map<String, Object> fcmData = new HashMap<>();
18fcmData.put("city", "sf");
19fcmData.put("count", 71);
20fcmData.put("is_private", true);
21fcmPayload.setData(fcmData);
22// Specify top-level objects
23Map<String, Object> fcmCustom = new HashMap<>();
24fcmCustom.put("token", "bk3RNwTe3H0:CI2k_HvvDMExdFQ3P1...");
25fcmCustom.put("topic", "/topic/news/");
26fcmPayload.setCustom(fcmCustom);
27// Set FCM payload
28pushPayloadHelper.setFcmPayload(fcmPayload);
29

30// Setup APNs parameters
31PushPayloadHelper.APNSPayload apnsPayload = new PushPayloadHelper.APNSPayload();
32// Define APS
33PushPayloadHelper.APNSPayload.APS aps = new PushPayloadHelper.APNSPayload.APS()
34        .setAlert("Alert")
35        .setBadge(1)
36        .setSound("Ding");
37// Set APS
38apnsPayload.setAps(aps);
39// Set APNs2 Configurations as a list
40apnsPayload.setApns2Configurations(Arrays.asList(
41        new PushPayloadHelper.APNSPayload.APNS2Configuration()
42                .setCollapseId("invitations")
43                .setExpiration("2019-12-13T22:06:09Z")
44                .setVersion("v1")
45                .setTargets(Arrays.asList(
46                        new PushPayloadHelper.APNSPayload.APNS2Configuration.Target()
47                                .setEnvironment(PNPushEnvironment.DEVELOPMENT)
48                                .setTopic("com.meetings.chat.app")
49                                .setExcludeDevices(Arrays.asList("device1", "device2"))
50                )),
51        new PushPayloadHelper.APNSPayload.APNS2Configuration()
52                .setCollapseId("invitations")
53                .setExpiration("2019-12-15T22:06:09Z")
54                .setVersion("v2")
55                .setTargets(Arrays.asList(
56                        new PushPayloadHelper.APNSPayload.APNS2Configuration.Target()
57                                .setEnvironment(PNPushEnvironment.DEVELOPMENT)
58                                .setTopic("com.meetings.chat.app")
59                                .setExcludeDevices(Arrays.asList("device3", "device4"))
60                ))
61));
62Map<String, Object> apnsCustom = new HashMap<>();
63apnsCustom.put("apns_key_1", "value_1");
64apnsCustom.put("apns_key_2", "value_2");
65apnsPayload.setCustom(apnsCustom);
66// Set APNS payload
67pushPayloadHelper.setApnsPayload(apnsPayload);
68

69// Common payload for native PubNub subscribers
70Map<String, Object> commonPayload = new HashMap<>();
71commonPayload.put("message", "Hello");
72commonPayload.put("such", "object");
73commonPayload.put("type", 7);
74pushPayloadHelper.setCommonPayload(commonPayload);
75

76// Build the payload
77// Returns a Map which can be used directly as the message for the pubnub.publish() method
78Map<String, Object> payload = pushPayloadHelper.build();
79pubnub.publish()
80        .channel("foo")
81        .message(payload)
82        .async(...);

show all 82 lines

Response

The PushPayloadHelper#build() operation returns a Map<String, Object> which can be passed directly as the message() parameter to the pubnub.publish() method.

Destroy

Destroy frees up the threads and allows for clean exit.

Method(s)

1destroy()

Sample code

1pubnub.destroy();

Returns

None

Encrypt

This function allows to encrypt the data.

Method(s)

To encrypt the data you can use the following method(s) in Android SDK.

1pubnub.encrypt(data, customCipherKey)

* required

Parameter	Description
data * Type: String	The data to encrypt.
customCipherKey Type: String	If it's not provided, the cipher key from config will be used.

Sample code

Encrypt part of message

1JSONParser parser = new JSONParser();
2String stringToParse = "hello world";
3JSONObject json = (JSONObject) parser.parse(stringToParse);
4String encodedKey = "testCypher";
5

6String payload = pubnub.encrypt(json, encodedKey);

Encrypt file input stream

Encrypts input stream with a cipher key.

Method(s)

1pubnub.encryptInputStream(inputStream, cipherKey)

* required

Parameter	Description
inputStream * Type: InputStream Default: n/a	Stream with content to encrypt.
cipherKey Type: String Default: PNConfiguration.getCipherKey()	Cipher key used for encryption.

Sample code

1pubnub.encryptInputStream(InputStream inputStream);
2pubnub.encryptInputStream(InputStream inputStream, String cipherKey);

Returns

InputStream with encrypted data.

Decrypt

This function allows to decrypt the data.

Method(s)

To decrypt the data you can use the following method(s) in Android SDK.

1pubnub.decrypt(data, customCipherKey)

* required

Parameter	Description
data * Type: String	The data to decrypt.
customCipherKey Type: String	If it's not provided, the cipher key from config will be used.

Decrypt file input stream

Decrypts input stream with a cipher key.

Method(s)

1pubnub.decryptInputStream(inputStream, cipherKey)

* required

Parameter	Description
inputStream * Type: InputStream Default: n/a	Stream with content encrypted data.
cipherKey Type: String Default: PNConfiguration.getCipherKey()	Cipher key used for encryption.

Sample code

1FileInputStream encryptedInputStream = new FileInputStream("./cat_picture_encrypted.jpg");
2InputStream decryptedInputStream = pubnub.decryptInputStream(encryptedInputStream, "myCipherKey");

Returns

InputStream with decrypted data.

Get subscribed channel groups

Returns all the subscribed channel groups in a List of type String.

Method(s)

To Get Subscribe Channel Groups you can use the following method(s) in the Android SDK:

1public final List<String> getSubscribedChannelGroups()

Sample code

Get subscribed channel groups

1List<String> groups = pubnub.getSubscribedChannelGroups();

Response

List<String>

1["channelGroup1", "channelGroup2"]

Get subscribed channels

Returns all the subscribed channels in a List of type String.

Method(s)

To Get Subscribed Channels you can use the following method(s) in the Android SDK:

1public final List<String> getSubscribedChannels()

Sample code

Get subscribed channels

1List<String> channels = pubnub.getSubscribedChannels();

Response

List<String>

1["channel1", "channel2"]

Disconnect

Call the disconnect method to force the SDK to stop all requests to PubNub server when there are active subscribe channels.

Method(s)

To disconnect the data transmission you can use the following method(s) in Android SDK.

1disconnect()

This method doesn't take any arguments.

Sample code

1pubnub.disconnect();

Reconnect

Call the reconnect method to force the SDK to try and reach out PubNub.

Method(s)

To reconnect the data you can use the following method(s) in Android SDK.

1reconnect()

This method doesn't take any arguments.

Sample code

1pubnub.reconnect();