Configuration API: deprecated parameters and stop() method for JavaScript SDK

DeprecatedConfiguration is a current API. These parameters and the stop() method are an older way to set some of its options or shut down the client. New apps should use the replacements. Go to Configuration

This page documents the deprecated uuid, logVerbosity, cipherKey, and useRandomIVs parameters of new PubNub(configuration) in the PubNub JavaScript SDK. It also documents the deprecated stop() method. The parameters still work, and each one has a current replacement in Configuration. New apps use the replacements.

Deprecated parameters

uuid#

type: Type: string

The SDK reads uuid when userId is not set. Setting both throws a PubNubError.

Replacement

userId

logVerbosity#

type: Type: boolean

true sets logLevel to LogLevel.Debug. See Logging.

Replacement

logLevel

cipherKey#

type: Type: string

If SDK configuration sets a cipherKey without an explicit CryptoModule, the SDK defaults to legacy 128-bit encryption. The legacy encryption keeps working without configuration changes. To use 256-bit Advanced Encryption Standard cipher block chaining (AES-CBC) encryption, set the crypto module to the AES-CBC module. Pass the key to cryptoModule instead.

Replacement

cryptoModule

useRandomIVs#

type: Type: boolean

Defaults to true, which makes the initialization vector (IV) random for all requests. Pass useRandomIVs to PubNub.CryptoModule.legacyCryptoModule() instead. false is insecure. Set false only for backward compatibility with apps older than 4.31.0, and never in new apps.

Replacement

cryptoModule

Deprecated stop() method

Deprecated

stop() is deprecated. Use destroy() instead.

stop() is an alias of destroy(). destroy() invalidates all subscriptions and subscription sets and unsubscribes from all channels and channel groups.

stop()#

Alias of destroy(). See Destroy for the parameters.

Replacement

destroy()