Package com.mewna.catnip.entity.channel

Interface GroupDMChannel

All Superinterfaces:
Channel, DMChannel, Entity, HasApplication, HasIcon, HasOwner, MessageChannel, RequiresCatnip, Snowflake, Timestamped
All Known Implementing Classes:
GroupDMChannelImpl
public interface GroupDMChannel extends DMChannel, HasIcon, HasApplication
A DM with a group of users.
Since:
9/12/18
Author:
natanbc

  • Method Details

    • recipients

      @Nonnull @CheckReturnValue List<User> recipients()
      Returns:
      The list of users in the group DM.

    • ownerId

      @Nonnull @CheckReturnValue default String ownerId()
      Specified by:
      ownerId in interface HasOwner
      Returns:
      The ID of the user who owns the group DM.

    • ownerIdAsLong

      @CheckReturnValue long ownerIdAsLong()
      Specified by:
      ownerIdAsLong in interface HasOwner
      Returns:
      The ID of the user who owns the group DM.

    • isUserDM

      @CheckReturnValue default boolean isUserDM()
      Specified by:
      isUserDM in interface Channel
      Returns:
      Whether or not this channel is a DM with a single user.

    • isGroupDM

      @CheckReturnValue default boolean isGroupDM()
      Specified by:
      isGroupDM in interface Channel
      Returns:
      Whether or not this channel is a group DM with at least 1 other user.

    • iconUrl

      @Nullable default String iconUrl(@Nonnull ImageOptions options)
      Specified by:
      iconUrl in interface HasIcon
      Returns:
      The icon's CDN URL, with the specified options applied. Will be null if HasIcon.icon() is null, except in the case of a User.