Package net.dv8tion.jda.api.entities

Interface Invite.Group

All Superinterfaces:
ISnowflake
Enclosing interface:
Invite
public static interface Invite.Group extends ISnowflake
POJO for the group information provided by an invite.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIconId()
    The icon id of this group or null if the group has no icon.
    String
    getIconUrl()
    The icon url of this group or null if the group has no icon.
    String
    getName()
    The name of this group or null if the group has no name.
    List<String>
    getUsers()
    The names of all users in this group.

    Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

    getId, getIdLong, getTimeCreated

  • Method Details

    • getIconId

      @Nullable String getIconId()
      The icon id of this group or null if the group has no icon.
      Returns:
      The group's icon id
      See Also:

    • getIconUrl

      @Nullable String getIconUrl()
      The icon url of this group or null if the group has no icon.
      Returns:
      The group's icon url
      See Also:

    • getName

      @Nullable String getName()
      The name of this group or null if the group has no name.
      Returns:
      The group's name

    • getUsers

      @Nullable List<String> getUsers()
      The names of all users in this group. If the users were not included in the invite, this will return null. Users will only be returned when resolving the invite via the Invite.resolve() method with the withCounts boolean set to true.
      Returns:
      The names of the group's users or null if not preset in the invite