ChannelOptions

```
public class ChannelOptions

                    
```
Passes additional properties to a io.ably.lib.rest.Channel or io.ably.lib.realtime.Channel object, such as encryption, ChannelMode and channel parameters.

Field Summary

Fields
Modifier and Type	Field	Description
`public Map<String, String>`	`params`
`public Array<ChannelMode>`	`modes`
`public Object`	`cipherParams`
`public boolean`	`encrypted`
`public boolean`	`attachOnSubscribe`

Method Summary

Modifier and Type	Method	Description
`boolean`	`hasModes()`
`boolean`	`hasParams()`
`int`	`getModeFlags()`
`static ChannelOptions`	`fromCipherKey(Array<byte> key)`	Deprecated.
`static ChannelOptions`	`fromCipherKey(String base64Key)`	Deprecated.
`static ChannelOptions`	`withCipherKey(Array<byte> key)`	Constructor withCipherKey, that takes a key only.
`static ChannelOptions`	`withCipherKey(String base64Key)`	Constructor withCipherKey, that takes a key only.
`synchronized Crypto.CipherParams`	`getCipherParamsOrDefault()`	Internal; returns cipher params or generate default

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - hasModes
```
 boolean hasModes()
```
  - hasParams
```
 boolean hasParams()
```
  - getModeFlags
```
 int getModeFlags()
```
  - fromCipherKey
```
@Deprecated() static ChannelOptions fromCipherKey(Array<byte> key)
```
    Deprecated. Use withCipherKey(byte[]) instead.Create ChannelOptions from the given cipher key.
    
    Parameters:
    
    key - Byte array cipher key.
  - fromCipherKey
```
@Deprecated() static ChannelOptions fromCipherKey(String base64Key)
```
    Deprecated. Use withCipherKey(String) instead.Create ChannelOptions from the given cipher key.
    
    Parameters:
    
    base64Key - The cipher key as a base64-encoded String,
  - withCipherKey
```
 static ChannelOptions withCipherKey(Array<byte> key)
```
    Constructor withCipherKey, that takes a key only.
    Spec: TB3
    
    Parameters:
    
    key - A private key used to encrypt and decrypt payloads.
  - withCipherKey
```
 static ChannelOptions withCipherKey(String base64Key)
```
    Constructor withCipherKey, that takes a key only.
    Spec: TB3
    
    Parameters:
    
    base64Key - A private key used to encrypt and decrypt payloads.
  - getCipherParamsOrDefault
```
 synchronized Crypto.CipherParams getCipherParamsOrDefault()
```
    Internal; returns cipher params or generate default