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.

Author:

Aljoscha Grebe

See Also:

• Invite.getChannel()

Method Summary

Modifier and Type	Method	Description
default ImageProxy	getIcon()	Returns an ImageProxy for this group invite's icon.
default ImageProxy	getIcon(ImageFormat format)	Returns an ImageProxy for this group invite's icon.
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.
default String	getIconUrl(ImageFormat format)	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 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(ImageFormat)

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:

• getIconId()

getIconUrl

@Nullable
default String getIconUrl(@Nonnull
 ImageFormat format)

The icon url of this group or null if the group has no icon.

Parameters:

format - The format in which the image should be

Returns:

The group's icon url

Throws:

IllegalArgumentException - If the format is null

See Also:

• getIconId()
• DiscordAssets.channelIcon(ImageFormat, String, String)

getIcon

@Nullable
default ImageProxy getIcon()

Returns an ImageProxy for this group invite's icon.

Returns:

Possibly-null ImageProxy of this group invite's icon

See Also:

• getIconUrl()

getIcon

@Nullable
default ImageProxy getIcon(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this group invite's icon.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this group invite's icon

Throws:

IllegalArgumentException - If the format is null

See Also:

• getIconUrl(ImageFormat)
• DiscordAssets.channelIcon(ImageFormat, String, String)

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