Package discord4j.core.object.entity

Class Member

java.lang.Object

discord4j.core.object.entity.User

discord4j.core.object.entity.PartialMember

discord4j.core.object.entity.Member

All Implemented Interfaces:

DiscordObject, Entity

public final class Member
extends PartialMember

A Discord guild member.

See Also:

Guild Member Object

Nested Class Summary

Nested classes/interfaces inherited from class discord4j.core.object.entity.User

User.Flag

Constructor Summary

Constructors

Constructor	Description
Member(GatewayDiscordClient gateway, discord4j.discordjson.json.MemberData data, long guildId)	Constructs a Member with an associated GatewayDiscordClient and Discord data.

Method Summary

Modifier and Type	Method	Description
Mono<Member>	asFullMember()	Requests to retrieve the full Member instance corresponding to this partial member.
Mono<Member>	asMember(Snowflake guildId)	Requests to retrieve this user as a Member.
discord4j.discordjson.json.MemberData	getMemberData()	Gets the data of the member.
boolean	isPending()	Gets whether the user has not yet passed the guild's Membership Screening requirements.
String	toString()

Methods inherited from class discord4j.core.object.entity.PartialMember

addRole, addRole, ban, ban, ban, edit, edit, edit, getBasePermissions, getColor, getDisplayName, getEffectiveAvatar, getEffectiveAvatarUrl, getGuild, getGuild, getGuildAvatar, getGuildAvatarUrl, getGuildId, getHighestRole, getHighestRole, getJoinTime, getNickname, getNicknameMention, getPremiumTime, getPresence, getRoleIds, getRoles, getRoles, getVoiceState, hasAnimatedGuildAvatar, hasHigherRoles, isHigher, isHigher, kick, kick, removeRole, removeRole, unban, unban

Methods inherited from class discord4j.core.object.entity.User

asMember, equals, getAccentColor, getAvatar, getAvatar, getAvatarUrl, getAvatarUrl, getBanner, getBanner, getBannerUrl, getBannerUrl, getClient, getDefaultAvatarUrl, getDiscriminator, getId, getMention, getPrivateChannel, getPublicFlags, getTag, getUserData, getUsername, hasAnimatedAvatar, hasAnimatedBanner, hashCode, isBot

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Member

public Member(GatewayDiscordClient gateway,
              discord4j.discordjson.json.MemberData data,
              long guildId)

Constructs a Member with an associated GatewayDiscordClient and Discord data.

Parameters:

gateway - The GatewayDiscordClient associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

guildId - The ID of the guild this user is associated to.

Method Detail

asMember

public Mono<Member> asMember(Snowflake guildId)

Description copied from class: User

Requests to retrieve this user as a Member.

Overrides:

asMember in class User

Parameters:

guildId - The ID of the guild to associate this user as a Member.

Returns:

A Mono where, upon successful completion, emits this user as a member. If an error is received, it is emitted through the Mono.

getMemberData

public discord4j.discordjson.json.MemberData getMemberData()

Gets the data of the member.

Overrides:

getMemberData in class PartialMember

Returns:

The data of the member.

asFullMember

public Mono<Member> asFullMember()

Description copied from class: PartialMember

Requests to retrieve the full Member instance corresponding to this partial member.

Overrides:

asFullMember in class PartialMember

Returns:

A Mono where, upon successful completion, emits the member this user is associated to. If an error is received, it is emitted through the Mono.

isPending

public boolean isPending()

Gets whether the user has not yet passed the guild's Membership Screening requirements.

Returns:

Whether the user has not yet passed the guild's Membership Screening requirements.

toString

public String toString()

Overrides:

toString in class PartialMember