Package io.ably.lib.types

Class ChannelOptions

java.lang.Object
io.ably.lib.types.ChannelOptions
public class ChannelOptions extends Object
Passes additional properties to a Channel or Channel object, such as encryption, ChannelMode and channel parameters.

  • Field Details

    • params

      public Map<String,String> params
      Channel Parameters that configure the behavior of the channel.

      Spec: TB2c

    • modes

      public ChannelMode[] modes
      An array of ChannelMode objects.

      Spec: TB2d

    • cipherParams

      public Object cipherParams
      Requests encryption for this channel when not null, and specifies encryption-related parameters (such as algorithm, chaining mode, key length and key). See an example.

      Spec: RSL5a, TB2b

    • encrypted

      public boolean encrypted
      Whether or not this ChannelOptions is encrypted.

    • attachOnSubscribe

      public boolean attachOnSubscribe

      Determines whether calling Channel.subscribe or Presence.subscribe method should trigger an implicit attach.

      Defaults to true.

      Spec: TB4, RTL7g, RTL7h, RTP6d, RTP6e

  • Constructor Details

    • ChannelOptions

      public ChannelOptions()

  • Method Details

    • hasModes

      public boolean hasModes()

    • hasParams

      public boolean hasParams()

    • getModeFlags

      public int getModeFlags()

    • 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(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
      Constructor withCipherKey, that takes a key only.

      Spec: TB3

      Parameters:
      key - A private key used to encrypt and decrypt payloads.
      Returns:
      A ChannelOptions object.
      Throws:
      AblyException - If something goes wrong.

    • withCipherKey

      public static ChannelOptions withCipherKey(String base64Key) throws AblyException
      Constructor withCipherKey, that takes a key only.

      Spec: TB3

      Parameters:
      base64Key - A private key used to encrypt and decrypt payloads.
      Returns:
      A ChannelOptions object.
      Throws:
      AblyException - If something goes wrong.

    • getCipherParamsOrDefault

      public Crypto.CipherParams getCipherParamsOrDefault() throws AblyException
      Internal; returns cipher params or generate default
      Throws:
      AblyException