Package net.dv8tion.jda.api.entities

Enum Invite.TargetType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Invite.TargetType>
    Enclosing interface:
    Invite
    public static enum Invite.TargetType
extends java.lang.Enum<Invite.TargetType>
    A TargetType indicates additional action to be taken by the client on accepting the invite, typically connecting external services or launching external applications depending on the specific TargetType. Some actions might not be available or show up on certain devices.
    See Also:
    Invite.InviteTarget.getType()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EMBEDDED_APPLICATION
      The invite points to an application in a voice channel.
      NONE
      The invite does not have a target type, Invite.getTarget() will return null.
      STREAM
      The invite points to a user's stream in a voice channel.
      UNKNOWN
      Unknown Discord invite target type.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Invite.TargetType fromId​(int id)
      Static accessor for retrieving a target type based on its Discord id key.
      int getId()
      The Discord id key used to represent the target type.
      static Invite.TargetType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Invite.TargetType[] 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

    • Method Detail

      • values

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

      • valueOf

        public static Invite.TargetType 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 represent the target type.
        Returns:
        The id key used by discord for this channel type.

      • fromId

        @Nonnull
public static Invite.TargetType fromId​(int id)
        Static accessor for retrieving a target type based on its Discord id key.
        Parameters:
        id - The id key of the requested target type.
        Returns:
        The TargetType that is referred to by the provided key. If the id key is unknown, UNKNOWN is returned.