Class WidgetUtil.Widget.Member

    • Method Detail

      • isBot

        public 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
        public String getName()
        Returns the username of the member
        Returns:
        the username of the member
      • getIdLong

        public long getIdLong()
        Description copied from interface: ISnowflake
        The Snowflake id of this entity. This is unique to every entity and will never change.
        Specified by:
        getIdLong in interface ISnowflake
        Returns:
        Long containing the Id.
      • getAsMention

        @Nonnull
        public String getAsMention()
        Description copied from interface: IMentionable
        Retrieve a Mention for this Entity. For the public Role (@everyone), this will return the literal string "@everyone".
        Specified by:
        getAsMention in interface IMentionable
        Returns:
        A resolvable mention.
      • getDiscriminator

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

        @Nullable
        public 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
        public 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
      • getDefaultAvatarId

        @Nonnull
        public 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
        public String getDefaultAvatarUrl()
        Gets the url of the member's default avatar
        Returns:
        never-null String containing the url of the member's default avatar
      • getEffectiveAvatarUrl

        @Nonnull
        public 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.
      • getNickname

        @Nullable
        public 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
        public 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
        public 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
        public 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
        public WidgetUtil.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
        public WidgetUtil.Widget getWidget()
        Gets the widget that to which this member belongs
        Returns:
        the Widget that holds this member
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object