Package io.ably.lib.types

Class ChannelOptions

java.lang.Object

io.ably.lib.types.ChannelOptions

public class ChannelOptions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.Object	cipherParams	Parameters for the cipher.
boolean	encrypted	Whether or not this ChannelOptions is encrypted.

Constructor Summary

Constructors

Constructor	Description
ChannelOptions()

Method Summary

Modifier and Type	Method	Description
static ChannelOptions	fromCipherKey(byte[] key)	Deprecated.
static ChannelOptions	fromCipherKey(java.lang.String base64Key)	Deprecated.
Crypto.ChannelCipher	getCipher()
static ChannelOptions	withCipherKey(byte[] key)	Create ChannelOptions with the given cipher key.
static ChannelOptions	withCipherKey(java.lang.String base64Key)	Create ChannelOptions with the given cipher key.

Methods inherited from class java.lang.Object

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

Field Detail

cipherParams

public java.lang.Object cipherParams

Parameters for the cipher.

encrypted

public boolean encrypted

Whether or not this ChannelOptions is encrypted.

Constructor Detail

ChannelOptions

public ChannelOptions()

Method Detail

getCipher

public Crypto.ChannelCipher getCipher()
                               throws AblyException

Throws:

AblyException

fromCipherKey

@Deprecated
public static ChannelOptions fromCipherKey(byte[] key)
                                    throws AblyException

Deprecated.

Deprecated. Use withCipherKey(byte[]) instead.

Create ChannelOptions from the given cipher key.

Parameters:

key - Byte array cipher key.

Returns:

Created ChannelOptions.

Throws:

AblyException - If something goes wrong.

fromCipherKey

@Deprecated
public static ChannelOptions fromCipherKey(java.lang.String base64Key)
                                    throws AblyException

Deprecated.

Deprecated. Use withCipherKey(String) instead.

Create ChannelOptions from the given cipher key.

Parameters:

base64Key - The cipher key as a base64-encoded String,

Returns:

Created ChannelOptions.

Throws:

AblyException - If something goes wrong.

withCipherKey

public static ChannelOptions withCipherKey(byte[] key)
                                    throws AblyException

Create ChannelOptions with the given cipher key.

Parameters:

key - Byte array cipher key.

Returns:

Created ChannelOptions.

Throws:

AblyException - If something goes wrong.

withCipherKey

public static ChannelOptions withCipherKey(java.lang.String base64Key)
                                    throws AblyException

Create ChannelOptions with the given cipher key.

Parameters:

base64Key - The cipher key as a base64-encoded String,

Returns:

Created ChannelOptions.

Throws:

AblyException - If something goes wrong.