Package net.dv8tion.jda.api.entities

Interface Widget.Member

All Superinterfaces:
Formattable, IMentionable, ISnowflake
Enclosing interface:
Widget
public static interface Widget.Member extends IMentionable
Represents a member of a guild
See Also:

  • Method Details

    • isBot

      boolean isBot()
      Returns whether or not the given member is a bot account
      Returns:
      true if the member is a bot, false otherwise

    • getName

      @Nonnull String getName()
      Returns the username of the member
      Returns:
      the username of the member

    • getDiscriminator

      @Nonnull String getDiscriminator()
      Gets the discriminator of the member
      Returns:
      the never-null discriminator of the member

    • getAvatarId

      @Nullable String getAvatarId()
      Gets the avatar hash of the member, or null if they do not have an avatar set.
      Returns:
      possibly-null String containing the avatar hash of the member

    • getAvatarUrl

      @Nullable String getAvatarUrl()
      Gets the avatar url of the member, or null if they do not have an avatar set.
      Returns:
      possibly-null String containing the avatar url of the member

    • getAvatar

      @Nullable ImageProxy getAvatar()
      Returns an ImageProxy for this user's avatar image.
      Returns:
      Possibly-null ImageProxy of this user's avatar image
      See Also:

    • getDefaultAvatarId

      @Nonnull String getDefaultAvatarId()
      Gets the asset id of the member's default avatar
      Returns:
      never-null String containing the asset id of the member's default avatar

    • getDefaultAvatarUrl

      @Nonnull String getDefaultAvatarUrl()
      Gets the url of the member's default avatar
      Returns:
      never-null String containing the url of the member's default avatar

    • getDefaultAvatar

      @Nonnull ImageProxy getDefaultAvatar()
      Returns an ImageProxy for this user's default avatar image.
      Returns:
      Never-null ImageProxy of this user's default avatar image
      See Also:

    • getEffectiveAvatarUrl

      @Nonnull String getEffectiveAvatarUrl()
      The URL for the user's avatar image
      If they do not have an avatar set, this will return the URL of their default avatar
      Returns:
      Never-null String containing the member's effective avatar url.

    • getEffectiveAvatar

      @Nonnull ImageProxy getEffectiveAvatar()
      Returns an ImageProxy for this user's effective avatar image.
      Returns:
      Never-null ImageProxy of this user's effective avatar image
      See Also:

    • getNickname

      @Nullable String getNickname()
      Gets the nickname of the member. If they do not have a nickname on the guild, this will return null;
      Returns:
      possibly-null String containing the nickname of the member

    • getEffectiveName

      @Nonnull String getEffectiveName()
      Gets the visible name of the member. If they have a nickname set, this will be their nickname. Otherwise, it will be their username.
      Returns:
      never-null String containing the member's effective (visible) name

    • getOnlineStatus

      @Nonnull OnlineStatus getOnlineStatus()
      Gets the online status of the member. The widget does not show offline members, so this status should never be offline
      Returns:
      the OnlineStatus of the member

    • getActivity

      @Nullable Activity getActivity()
      The game that the member is currently playing.
      This game cannot be a stream. If the user is not currently playing a game, this will return null.
      Returns:
      Possibly-null Activity containing the game that the member is currently playing.

    • getVoiceState

      @Nonnull Widget.VoiceState getVoiceState()
      The current voice state of the member.
      If the user is not in voice, this will return a VoiceState with a null channel.
      Returns:
      never-null VoiceState of the member

    • getWidget

      @Nonnull Widget getWidget()
      Gets the widget that to which this member belongs
      Returns:
      the Widget that holds this member