Enum MessageType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MessageType>

    public enum MessageType
    extends java.lang.Enum<MessageType>
    Represents the different types of Messages that can be received from Discord.
    A normal text based message is DEFAULT.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CALL
      Specialized message used for Groups as a System-Message showing that a Call was started.
      CHANNEL_ICON_CHANGE
      Specialized message used for Groups as a System-Message showing that the icon of the Group was changed.
      CHANNEL_NAME_CHANGE
      Specialized message used for Groups as a System-Message showing that the name of the Group was changed.
      CHANNEL_PINNED_ADD
      Specialized message used in MessageChannels as a System-Message to announce new pins
      DEFAULT
      The normal text messages received when a user or bot sends a Message.
      GUILD_MEMBER_JOIN
      Specialized message used to welcome new members in a Guild
      RECIPIENT_ADD
      Specialized messages used for Groups as a System-Message showing that a new User has been added to the Group.
      RECIPIENT_REMOVE
      Specialized messages used for Groups as a System-Message showing that a new User has been removed from the Group.
      UNKNOWN
      Unknown MessageType.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static MessageType fromId​(int id)
      Used to retrieve a MessageType based on the Discord id key.
      int getId()
      The Discord id key used to reference the MessageType.
      static MessageType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MessageType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • DEFAULT

        public static final MessageType DEFAULT
        The normal text messages received when a user or bot sends a Message.
      • RECIPIENT_ADD

        public static final MessageType RECIPIENT_ADD
        Specialized messages used for Groups as a System-Message showing that a new User has been added to the Group.
      • RECIPIENT_REMOVE

        public static final MessageType RECIPIENT_REMOVE
        Specialized messages used for Groups as a System-Message showing that a new User has been removed from the Group.
      • CALL

        public static final MessageType CALL
        Specialized message used for Groups as a System-Message showing that a Call was started.
      • CHANNEL_NAME_CHANGE

        public static final MessageType CHANNEL_NAME_CHANGE
        Specialized message used for Groups as a System-Message showing that the name of the Group was changed.
      • CHANNEL_ICON_CHANGE

        public static final MessageType CHANNEL_ICON_CHANGE
        Specialized message used for Groups as a System-Message showing that the icon of the Group was changed.
      • CHANNEL_PINNED_ADD

        public static final MessageType CHANNEL_PINNED_ADD
        Specialized message used in MessageChannels as a System-Message to announce new pins
      • GUILD_MEMBER_JOIN

        public static final MessageType GUILD_MEMBER_JOIN
        Specialized message used to welcome new members in a Guild
      • UNKNOWN

        public static final MessageType UNKNOWN
        Unknown MessageType.
    • Method Detail

      • values

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

        public static MessageType 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
      • getId

        public int getId()
        The Discord id key used to reference the MessageType.
        Returns:
        the Discord id key.
      • fromId

        public static MessageType fromId​(int id)
        Used to retrieve a MessageType based on the Discord id key.
        If the id provided is not a known id, UNKNOWN is returned
        Parameters:
        id - The Discord key id of the requested MessageType.
        Returns:
        A MessageType with the same Discord id key as the one provided, or UNKNOWN.