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:
Invite.getChannel()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getIconId()
The icon id of this group ornull
if the group has no icon.java.lang.String
getIconUrl()
The icon url of this group ornull
if the group has no icon.java.lang.String
getName()
The name of this group ornull
if the group has no name.java.util.List<java.lang.String>
getUsers()
The names of all users in this group.-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Method Detail
-
getIconId
@Nullable java.lang.String getIconId()
The icon id of this group ornull
if the group has no icon.- Returns:
- The group's icon id
- See Also:
getIconUrl()
-
getIconUrl
@Nullable java.lang.String getIconUrl()
The icon url of this group ornull
if the group has no icon.- Returns:
- The group's icon url
- See Also:
getIconId()
-
getName
@Nullable java.lang.String getName()
The name of this group ornull
if the group has no name.- Returns:
- The group's name
-
getUsers
@Nullable java.util.List<java.lang.String> getUsers()
The names of all users in this group. If the users were not included in the invite, this will returnnull
. Users will only be returned when resolving the invite via theInvite.resolve()
method with thewithCounts
boolean set totrue
.- Returns:
- The names of the group's users or null if not preset in the invite
-
-