Package org.jivesoftware.smack.packet

Enum Presence.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Presence.Type>
    Enclosing class:
    Presence
    public static enum Presence.Type
extends java.lang.Enum<Presence.Type>
    An enum to represent the presence type. Note that presence type is often confused with presence mode. Generally, if a user is signed in to a server, they have a presence type of available, even if the mode is away, dnd, etc. The presence type is only unavailable when the user is signing out of the server.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      available
      The user is available to receive messages (default).
      error
      The presence stanza contains an error message.
      probe
      A presence probe as defined in section 4.3 of RFC 6121.
      subscribe
      Request subscription to recipient's presence.
      subscribed
      Grant subscription to sender's presence.
      unavailable
      The user is unavailable to receive messages.
      unsubscribe
      Request removal of subscription to sender's presence.
      unsubscribed
      Grant removal of subscription to sender's presence.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Presence.Type fromString​(java.lang.String string)
      Converts a String into the corresponding types.
      static Presence.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Presence.Type[] 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

    • Method Detail

      • values

        public static Presence.Type[] 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 (Presence.Type c : Presence.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Presence.Type 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

      • fromString

        public static Presence.Type fromString​(java.lang.String string)
        Converts a String into the corresponding types. Valid String values that can be converted to types are: "available", "unavailable", "subscribe", "subscribed", "unsubscribe", "unsubscribed" and "error".
        Parameters:
        string - the String value to covert.
        Returns:
        the corresponding Type.
        Throws:
        java.lang.IllegalArgumentException - when not able to parse the string parameter
        java.lang.NullPointerException - if the string is null