Utility Methods API for Java SDK
Breaking changes in v9.0.0
PubNub Java SDK version 9.0.0 unifies the codebases for Java and Kotlin SDKs, introduces a new way of instantiating the PubNub client, and changes asynchronous API callbacks and emitted status events. These changes can impact applications built with previous versions (< 9.0.0
) of the Java SDK.
For more details about what has changed, refer to Java/Kotlin SDK migration guide.
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)
PushPayloadHelper helper = new PushPayloadHelper();
helper.setApnsPayload(PushPayloadHelper.APNSPayload());
helper.setFcmPayloadV2(PushPayloadHelper.FCMPayloadV2());
helper.setCommonPayload(HashMap<String, Object>());
Map<String, Object> payload = helper.build();
Parameter | Description |
---|---|
helper.setApnsPayload() Type: APNSPayload | Set APNs and APNs2 Payload. Associated devices will receive only the data supplied here within the pn_apns key. |
helper.setFcmPayloadV2() Type: FCMPayloadV2 | Set FCM Payload. Associated devices will receive only the data supplied here within the pn_gcm key. |
helper.setCommonPayload() Type: Map<String, Object> | Set common Payload. Native PubNub subscribers will receive the data provided here, together with the pn_apns , and pn_gcm objects. |
helper.build() *Type: Map<String, Object> | Builds the payload from the values set using the parameters. |
Sample code
Reference code
Create push payload
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)
destroy()
Sample code
Returns
None
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 Java SDK:
public final List<String> getSubscribedChannelGroups()
Sample code
Get subscribed channel groups
Response
List<String>
["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 Java SDK:
public final List<String> getSubscribedChannels()
Sample code
Get subscribed channels
Response
List<String>
["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 Java SDK.
disconnect()
This method doesn't take any arguments.
Sample code
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 Java SDK.
reconnect(long timetoken)
Parameter | Description |
---|---|
timetoken Type: long | Timetoken to reconnect from. |
Sample code
Timetoken to date
The timetokenToInstant()
method of the TimetokenUtil
class converts a PubNub timetoken (a unique identifier for each message sent and received in a PubNub channel that is a number of 100-nanosecond intervals since January 1, 1970) to an Instant
object representing the corresponding date and time.
Use this method when you want to display the timetoken of each message or event in the message history in a human-readable format.
Method signature
Instant TimetokenUtil.timetokenToInstant(long timetoken)
Input
Parameter | Description |
---|---|
timetoken *Type: long Default: n/a | Represents the PubNub timetoken to convert into a human-readable date format. |
Output
Type | Description |
---|---|
Instant | The human-readable date representation of the timetoken. |
Sample code
Convert a timetoken value of 17276954606232118
to a human-readable date and time format.
The output of the method is as follows:
PubNub timetoken: 17276954606232118
Current date: 2024-09-30
Current time: 11:24:20.623211800
Date to timetoken
The instantToTimetoken()
method of the TimetokenUtil
class converts the Instant
object representing the corresponding date and time into a PubNub timetoken (a unique identifier for each message sent and received in a PubNub channel that is a number of 100-nanosecond intervals since January 1, 1970).
Use this method to represent a specific date and time as a PubNub timetoken value, for example, to retrieve messages from a PubNub channel at a particular date and time.
Method signature
long TimetokenUtil.instantToTimetoken(Instant instant)
Input
Parameter | Description |
---|---|
instant *Type: Instant Default: n/a | Represents the date and time to convert into a PubNub timetoken. |
Output
Type | Description |
---|---|
long | Converted timetoken value. |
Sample code
Convert a human-readable date and time, September 30, 2024 12:12:24 GMT
, to a timetoken.
Current date: 2024-09-30
Current time: 12:12:44.123456789
PubNub timetoken: 17276983641234567
Unix timestamp to timetoken
The unixToTimetoken()
method of the TimetokenUtil
class converts a Unix timestamp (a number of seconds since January 1, 1970) to a PubNub timetoken (a unique identifier for each message sent and received in a PubNub channel that is a number of 100-nanosecond intervals since January 1, 1970).
Use this method when you need a timetoken to retrieve historical messages with a specific timestamp range from Message Persistence.
Method signature
This method takes the following parameters:
long TimetokenUtil.unixToTimetoken(long unixTime)
Input
Parameter | Description |
---|---|
unixTime *Type: long Default: n/a | Represents the Unix timestamp to convert into a PubNub timetoken. |
Output
Type | Description |
---|---|
long | Converted timetoken value. |
Sample code
Convert a Unix timestamp value of 1727866935316
representing 2024-10-02 11:02:15.316
to PubNub timetoken:
The output of the method is as follows:
PubNub timetoken: 17278669353160000
Current date: 2024-10-02
Current time: 11:02:15.316
Timetoken to Unix timestamp
The timetokenToUnix()
method of the TimetokenUtil
class converts a PubNub timetoken (a unique identifier for each message sent and received in a PubNub channel that is a number of 100-nanosecond intervals since January 1, 1970) to a Unix timestamp (a number of seconds since January 1, 1970).
Use this method to convert PubNub timetoken for use in another context or system that requires a Unix timestamp.
Method signature
long TimetokenUtil.timetokenToUnix(long timetoken)
Input
Parameter | Description |
---|---|
timetoken *Type: long Default: n/a | Represents the PubNub timetoken to convert into a Unix timestamp. |
Output
Type | Description |
---|---|
long | Converted Unix timestamp value. |
Sample code
Convert a PubNub timetoken 17276954606232118
representing 2024-09-30 11:24:20.623211800
to Unix time:
The output of the method is as follows:
Current date: 2024-09-30
Current time: 11:24:20.623
PubNub timetoken: 17276954606232118