Package org.javacord.api.entity

Enum DiscordClient

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DiscordClient>
    public enum DiscordClient
extends java.lang.Enum<DiscordClient>
    Represents the three different Discord clients.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DESKTOP
      The Discord desktop client.
      MOBILE
      The Discord mobile client.
      WEB
      The Discord web client.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Gets the name of client, as it appears in the Discord REST-api.
      static DiscordClient valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DiscordClient[] 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

      • DESKTOP

        public static final DiscordClient DESKTOP
        The Discord desktop client.

        Does not differentiate between operating systems like Windows or Linux.

      • MOBILE

        public static final DiscordClient MOBILE
        The Discord mobile client.

        Does not differentiate between the iOS app and the Android app.

      • WEB

        public static final DiscordClient WEB
        The Discord web client.

    • Method Detail

      • values

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

      • valueOf

        public static DiscordClient 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

      • getName

        public java.lang.String getName()
        Gets the name of client, as it appears in the Discord REST-api.
        Returns:
        The name of the client.