com.pubnub.api

Class PubNub

java.lang.Object

com.pubnub.api.PubNub

public class PubNub
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PubNub(@NotNull PNConfiguration initialConfig)

Method Summary

Modifier and Type	Method and Description
@NotNull AddChannelChannelGroup	addChannelsToChannelGroup()
void	addListener(@NotNull SubscribeCallback listener)
@NotNull AddMessageAction	addMessageAction()
@NotNull AddChannelsToPush	addPushNotificationsOnChannels()
@NotNull ListPushProvisions	auditPushChannelProvisions()
@NotNull CreateSpace	createSpace()
@NotNull CreateUser	createUser()
@Nullable java.lang.String	decrypt(java.lang.String inputString) Perform Cryptographic decryption of an input string using cipher key provided by PNConfiguration
@Nullable java.lang.String	decrypt(java.lang.String inputString, java.lang.String cipherKey) Perform Cryptographic decryption of an input string using the cipher key
@NotNull DeleteChannelGroup	deleteChannelGroup()
@NotNull DeleteMessages	deleteMessages()
@NotNull DeleteSpace	deleteSpace()
@NotNull DeleteUser	deleteUser()
void	destroy() Destroy the SDK to cancel all ongoing requests and stop heartbeat timer.
void	disconnect() Perform a disconnect from the listeners
@Nullable java.lang.String	encrypt(java.lang.String inputString) Perform Cryptographic encryption of an input string and the cipher key provided by PNConfiguration
@Nullable java.lang.String	encrypt(java.lang.String inputString, java.lang.String cipherKey) Perform Cryptographic encryption of an input string and the cipher key.
@NotNull FetchMessages	fetchMessages()
@NotNull Publish	fire()
void	forceDestroy() Force destroy the SDK to evict the connection pools and close executors.
@NotNull java.lang.String	getBaseUrl()
@NotNull PNConfiguration	getConfiguration()
@NotNull java.lang.String	getInstanceId()
@NotNull MapperManager	getMapper()
@NotNull GetMembers	getMembers()
@NotNull GetMemberships	getMemberships()
@NotNull GetMessageActions	getMessageActions()
@NotNull GetState	getPresenceState()
@NotNull java.lang.String	getRequestId()
@NotNull GetSpace	getSpace()
@NotNull GetSpaces	getSpaces()
@NotNull java.util.List<java.lang.String>	getSubscribedChannelGroups()
@NotNull java.util.List<java.lang.String>	getSubscribedChannels()
int	getTimestamp()
@Nullable java.lang.String	getToken(@NotNull java.lang.String resourceId, @NotNull PNResourceType resourceType)
@Nullable java.lang.String	getToken(@NotNull TokenManagerProperties tokenManagerProperties)
@NotNull java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>>>	getTokens()
@NotNull java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>>	getTokensByResource(@NotNull PNResourceType resourceType)
@NotNull GetUser	getUser()
@NotNull GetUsers	getUsers()
@NotNull java.lang.String	getVersion()
@NotNull Grant	grant()
@NotNull GrantToken	grantToken()
@NotNull HereNow	hereNow()
@NotNull History	history()
@NotNull ListAllChannelGroup	listAllChannelGroups()
@NotNull AllChannelsChannelGroup	listChannelsForChannelGroup()
@NotNull ManageMembers	manageMembers()
@NotNull ManageMemberships	manageMemberships()
@NotNull MessageCounts	messageCounts()
@NotNull PresenceBuilder	presence()
@NotNull Publish	publish()
void	reconnect() Perform a Reconnect to the network
@NotNull RemoveAllPushChannelsForDevice	removeAllPushNotificationsFromDeviceWithPushToken()
@NotNull RemoveChannelChannelGroup	removeChannelsFromChannelGroup()
void	removeListener(@NotNull SubscribeCallback listener)
@NotNull RemoveMessageAction	removeMessageAction()
@NotNull RemoveChannelsFromPush	removePushNotificationsFromChannels()
@NotNull SetState	setPresenceState()
void	setToken(java.lang.String token)
void	setTokens(@NotNull java.util.List<java.lang.String> tokens)
@NotNull Signal	signal()
void	stop() Deprecated.
@NotNull SubscribeBuilder	subscribe()
@NotNull Time	time()
@NotNull UnsubscribeBuilder	unsubscribe()
void	unsubscribeAll()
@NotNull UpdateSpace	updateSpace()
@NotNull UpdateUser	updateUser()
@NotNull WhereNow	whereNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PubNub

public PubNub(@NotNull
              @NotNull PNConfiguration initialConfig)

Method Detail

getBaseUrl

@NotNull
public @NotNull java.lang.String getBaseUrl()

addListener

public void addListener(@NotNull
                        @NotNull SubscribeCallback listener)

removeListener

public void removeListener(@NotNull
                           @NotNull SubscribeCallback listener)

subscribe

@NotNull
public @NotNull SubscribeBuilder subscribe()

unsubscribe

@NotNull
public @NotNull UnsubscribeBuilder unsubscribe()

presence

@NotNull
public @NotNull PresenceBuilder presence()

addPushNotificationsOnChannels

@NotNull
public @NotNull AddChannelsToPush addPushNotificationsOnChannels()

removePushNotificationsFromChannels

@NotNull
public @NotNull RemoveChannelsFromPush removePushNotificationsFromChannels()

removeAllPushNotificationsFromDeviceWithPushToken

@NotNull
public @NotNull RemoveAllPushChannelsForDevice removeAllPushNotificationsFromDeviceWithPushToken()

auditPushChannelProvisions

@NotNull
public @NotNull ListPushProvisions auditPushChannelProvisions()

whereNow

@NotNull
public @NotNull WhereNow whereNow()

hereNow

@NotNull
public @NotNull HereNow hereNow()

time

@NotNull
public @NotNull Time time()

history

@NotNull
public @NotNull History history()

fetchMessages

@NotNull
public @NotNull FetchMessages fetchMessages()

deleteMessages

@NotNull
public @NotNull DeleteMessages deleteMessages()

messageCounts

@NotNull
public @NotNull MessageCounts messageCounts()

grant

@NotNull
public @NotNull Grant grant()

grantToken

@NotNull
public @NotNull GrantToken grantToken()

getPresenceState

@NotNull
public @NotNull GetState getPresenceState()

setPresenceState

@NotNull
public @NotNull SetState setPresenceState()

publish

@NotNull
public @NotNull Publish publish()

signal

@NotNull
public @NotNull Signal signal()

listAllChannelGroups

@NotNull
public @NotNull ListAllChannelGroup listAllChannelGroups()

listChannelsForChannelGroup

@NotNull
public @NotNull AllChannelsChannelGroup listChannelsForChannelGroup()

addChannelsToChannelGroup

@NotNull
public @NotNull AddChannelChannelGroup addChannelsToChannelGroup()

removeChannelsFromChannelGroup

@NotNull
public @NotNull RemoveChannelChannelGroup removeChannelsFromChannelGroup()

deleteChannelGroup

@NotNull
public @NotNull DeleteChannelGroup deleteChannelGroup()

getUsers

@NotNull
public @NotNull GetUsers getUsers()

getUser

@NotNull
public @NotNull GetUser getUser()

createUser

@NotNull
public @NotNull CreateUser createUser()

updateUser

@NotNull
public @NotNull UpdateUser updateUser()

deleteUser

@NotNull
public @NotNull DeleteUser deleteUser()

getSpaces

@NotNull
public @NotNull GetSpaces getSpaces()

getSpace

@NotNull
public @NotNull GetSpace getSpace()

createSpace

@NotNull
public @NotNull CreateSpace createSpace()

updateSpace

@NotNull
public @NotNull UpdateSpace updateSpace()

deleteSpace

@NotNull
public @NotNull DeleteSpace deleteSpace()

getMemberships

@NotNull
public @NotNull GetMemberships getMemberships()

getMembers

@NotNull
public @NotNull GetMembers getMembers()

manageMemberships

@NotNull
public @NotNull ManageMemberships manageMemberships()

manageMembers

@NotNull
public @NotNull ManageMembers manageMembers()

addMessageAction

@NotNull
public @NotNull AddMessageAction addMessageAction()

getMessageActions

@NotNull
public @NotNull GetMessageActions getMessageActions()

removeMessageAction

@NotNull
public @NotNull RemoveMessageAction removeMessageAction()

decrypt

@Nullable
public @Nullable java.lang.String decrypt(java.lang.String inputString)
                                             throws PubNubException

Perform Cryptographic decryption of an input string using cipher key provided by PNConfiguration

Parameters:

inputString - String to be encrypted

Returns:

String containing the encryption of inputString using cipherKey

Throws:

PubNubException

decrypt

@Nullable
public @Nullable java.lang.String decrypt(java.lang.String inputString,
                                                    java.lang.String cipherKey)
                                             throws PubNubException

Perform Cryptographic decryption of an input string using the cipher key

Parameters:

inputString - String to be encrypted

cipherKey - cipher key to be used for encryption

Returns:

String containing the encryption of inputString using cipherKey

Throws:

PubNubException - throws exception in case of failed encryption

encrypt

@Nullable
public @Nullable java.lang.String encrypt(java.lang.String inputString)
                                             throws PubNubException

Perform Cryptographic encryption of an input string and the cipher key provided by PNConfiguration

Parameters:

inputString - String to be encrypted

Returns:

String containing the encryption of inputString using cipherKey

Throws:

PubNubException

encrypt

@Nullable
public @Nullable java.lang.String encrypt(java.lang.String inputString,
                                                    java.lang.String cipherKey)
                                             throws PubNubException

Perform Cryptographic encryption of an input string and the cipher key.

Parameters:

inputString - String to be encrypted

cipherKey - cipher key to be used for encryption

Returns:

String containing the encryption of inputString using cipherKey

Throws:

PubNubException - throws exception in case of failed encryption

getTimestamp

public int getTimestamp()

getInstanceId

@NotNull
public @NotNull java.lang.String getInstanceId()

Returns:

instance uuid.

getRequestId

@NotNull
public @NotNull java.lang.String getRequestId()

Returns:

request uuid.

getVersion

@NotNull
public @NotNull java.lang.String getVersion()

Returns:

version of the SDK.

stop

@Deprecated
public void stop()

Deprecated.

Stop the SDK and terminate all listeners.

destroy

public void destroy()

Destroy the SDK to cancel all ongoing requests and stop heartbeat timer.

forceDestroy

public void forceDestroy()

Force destroy the SDK to evict the connection pools and close executors.

reconnect

public void reconnect()

Perform a Reconnect to the network

disconnect

public void disconnect()

Perform a disconnect from the listeners

fire

@NotNull
public @NotNull Publish fire()

getSubscribedChannels

@NotNull
public @NotNull java.util.List<java.lang.String> getSubscribedChannels()

getSubscribedChannelGroups

@NotNull
public @NotNull java.util.List<java.lang.String> getSubscribedChannelGroups()

unsubscribeAll

public void unsubscribeAll()

setToken

public void setToken(java.lang.String token)
              throws PubNubException

Throws:

PubNubException

setTokens

public void setTokens(@NotNull
                      @NotNull java.util.List<java.lang.String> tokens)
               throws PubNubException

Throws:

PubNubException

getToken

@Nullable
public @Nullable java.lang.String getToken(@NotNull
                                                     @NotNull java.lang.String resourceId,
                                                     @NotNull
                                                     @NotNull PNResourceType resourceType)

getToken

@Nullable
public @Nullable java.lang.String getToken(@NotNull
                                                     @NotNull TokenManagerProperties tokenManagerProperties)

getTokens

@NotNull
public @NotNull java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>>> getTokens()

getTokensByResource

@NotNull
public @NotNull java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> getTokensByResource(@NotNull
                                                                                                                                      @NotNull PNResourceType resourceType)

getConfiguration

@NotNull
public @NotNull PNConfiguration getConfiguration()

getMapper

@NotNull
public @NotNull MapperManager getMapper()