Package io.ably.lib.types

Enum ChannelMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ChannelMode>
    public enum ChannelMode
extends java.lang.Enum<ChannelMode>
    Describes the possible flags used to configure client capabilities, using ChannelOptions.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      presence
      The client can enter the presence set.
      presence_subscribe
      The client can receive presence messages.
      publish
      The client can publish messages.
      subscribe
      The client can subscribe to messages.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getMask()  
      static java.util.Set<ChannelMode> toSet​(int flags)  
      static ChannelMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ChannelMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • presence

        public static final ChannelMode presence
        The client can enter the presence set.

      • publish

        public static final ChannelMode publish
        The client can publish messages.

      • subscribe

        public static final ChannelMode subscribe
        The client can subscribe to messages.

      • presence_subscribe

        public static final ChannelMode presence_subscribe
        The client can receive presence messages.

    • Method Detail

      • values

        public static ChannelMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ChannelMode c : ChannelMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ChannelMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getMask

        public int getMask()

      • toSet

        public static java.util.Set<ChannelMode> toSet​(int flags)