Interface GroupChannel

All Superinterfaces:

Channel, Formattable, IDetachableEntity, IMentionable, ISnowflake, MessageChannel

public interface GroupChannel
extends MessageChannel, IDetachableEntity

Represents a Group DM channel.

This is only used for user-installed apps.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON_URL	Deprecated. Replaced by DiscordAssets.channelIcon(ImageFormat, String, String)

Fields inherited from interface Channel

MAX_NAME_LENGTH

Method Summary

Modifier and Type	Method	Description
default ImageProxy	getIcon()	Returns an ImageProxy for this group channel's icon.
default ImageProxy	getIcon(ImageFormat format)	Returns an ImageProxy for this group channel's icon.
String	getIconId()	The Discord hash-id of the group channel icon image.
default String	getIconUrl()	The URL of the group channel icon image.
default String	getIconUrl(ImageFormat format)	The URL of the group channel icon image.
default String	getOwnerId()	Returns the ID of the user which owns this GroupChannel.
long	getOwnerIdLong()	Returns the ID of the user which owns this GroupChannel.
default RestAction<User>	retrieveOwner()	Retrieves the User which owns this GroupChannel.

Methods inherited from interface Channel

delete, formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface IDetachableEntity

isDetached

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface MessageChannel

addReactionById, addReactionById, canTalk, deleteMessageById, deleteMessageById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, endPollById, endPollById, getHistory, getHistoryAfter, getHistoryAfter, getHistoryAfter, getHistoryAround, getHistoryAround, getHistoryAround, getHistoryBefore, getHistoryBefore, getHistoryBefore, getHistoryFromBeginning, getIterableHistory, getLatestMessageId, getLatestMessageIdLong, pinMessageById, pinMessageById, purgeMessages, purgeMessages, purgeMessagesById, purgeMessagesById, purgeMessagesById, removeReactionById, removeReactionById, retrieveMessageById, retrieveMessageById, retrievePinnedMessages, retrievePollVotersById, retrievePollVotersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, sendFiles, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageComponents, sendMessageComponents, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendMessagePoll, sendTyping, unpinMessageById, unpinMessageById

Field Details

ICON_URL

@Deprecated
static final String ICON_URL

Deprecated.

Replaced by DiscordAssets.channelIcon(ImageFormat, String, String)

Template for getIconUrl().

See Also:

• Constant Field Values

Method Details

getIconId

@Nullable
String getIconId()

The Discord hash-id of the group channel icon image. If no icon has been set, this returns null.

Returns:

Possibly-null String containing the group channel's icon hash-id.

getIconUrl

@Nullable
default String getIconUrl()

The URL of the group channel icon image. If no icon has been set, this returns null.

Returns:

Possibly-null String containing the group channel's icon URL.

getIconUrl

@Nullable
default String getIconUrl(@Nonnull
 ImageFormat format)

The URL of the group channel icon image. If no icon has been set, this returns null.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null String containing the group channel's icon URL.

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.channelIcon(ImageFormat, String, String)

getIcon

@Nullable
default ImageProxy getIcon()

Returns an ImageProxy for this group channel's icon.

Returns:

Possibly-null ImageProxy of this group channel's icon

See Also:

• getIconUrl()

getIcon

@Nullable
default ImageProxy getIcon(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this group channel's icon.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this group channel's icon

Throws:

IllegalArgumentException - If the format is null

See Also:

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

getOwnerIdLong

long getOwnerIdLong()

Returns the ID of the user which owns this GroupChannel.

Returns:

The ID of the user which owns this GroupChannel

getOwnerId

@Nonnull
default String getOwnerId()

Returns the ID of the user which owns this GroupChannel.

Returns:

The ID of the user which owns this GroupChannel

retrieveOwner

@Nonnull
@CheckReturnValue
default RestAction<User> retrieveOwner()

Retrieves the User which owns this GroupChannel.

Returns:

A RestAction to retrieve the User which owns this GroupChannel.