Class MemberUpdateEvent
java.lang.Object
discord4j.core.event.domain.Event
discord4j.core.event.domain.guild.GuildEvent
discord4j.core.event.domain.guild.MemberUpdateEvent
Dispatched when a user's nickname or roles change in a guild.
This event is dispatched by Discord.
- See Also:
-
Constructor Summary
ConstructorDescriptionMemberUpdateEvent
(GatewayDiscordClient gateway, ShardInfo shardInfo, long guildId, long memberId, Member old, Set<Long> currentRoleIds, String currentNickname, String currentAvatar, String currentJoinedAt, String currentPremiumSince, Boolean currentPending, String communicationDisabledUntil) -
Method Summary
Modifier and TypeMethodDescriptionGets when the user ends their timeout, if present.getCurrentGuildAvatar
(Image.Format format) Gets the current member's guild avatar.getCurrentGuildAvatarUrl
(Image.Format format) Gets the current member's guild avatar URL, if present.Gets the current nickname of theMember
involved in this event, if present.Gets when the user started boosting the guild, if present.getGuild()
Requests to retrieve theGuild
involved in the event.Gets the current join time of theMember
involved in this event, if present.Requests to retrieve theMember
involved in the event.getOld()
Gets the old version of theMember
involved in the event, if present.boolean
Gets whether the user has currently not yet passed the guild's Membership Screening requirements.toString()
Methods inherited from class discord4j.core.event.domain.Event
getClient, getShardInfo
-
Constructor Details
-
MemberUpdateEvent
public MemberUpdateEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, long guildId, long memberId, @Nullable Member old, Set<Long> currentRoleIds, @Nullable String currentNickname, @Nullable String currentAvatar, @Nullable String currentJoinedAt, @Nullable String currentPremiumSince, @Nullable Boolean currentPending, @Nullable String communicationDisabledUntil)
-
-
Method Details
-
getGuildId
- Returns:
- The ID of the
Guild
involved.
-
getGuild
Requests to retrieve theGuild
involved in the event. -
getMemberId
- Returns:
- The ID of the
Member
involved.
-
getMember
Requests to retrieve theMember
involved in the event. -
getOld
Gets the old version of theMember
involved in the event, if present. This may not be available ifMembers
are not stored.- Returns:
- the old version of the
Member
involved, if present.
-
getCurrentRoleIds
- Returns:
- The IDs of the roles the
Member
is assigned.
-
getCurrentRoles
-
getCurrentNickname
Gets the current nickname of theMember
involved in this event, if present.- Returns:
- The current nickname, if any, of the
Member
involved, if present.
-
getCurrentGuildAvatarUrl
Gets the current member's guild avatar URL, if present.- Parameters:
format
- the format for the URL.- Returns:
- The current member's guild avatar URL, if present.
-
getCurrentGuildAvatar
Gets the current member's guild avatar. This is the avatar at the url given bygetCurrentGuildAvatarUrl(Image.Format)
.- Parameters:
format
- The format for the avatar.- Returns:
- a
Mono
where, upon successful completion, emits the currentguild avatar
of the member. If an error is received, it is emitted through theMono
.
-
getJoinTime
Gets the current join time of theMember
involved in this event, if present. It is typically absent if this event is caused by a lurking stage channel member.- Returns:
- The current join time of the
Member
involved in this event, if present.
-
getCurrentPremiumSince
Gets when the user started boosting the guild, if present.- Returns:
- When the user started boosting the guild, if present.
-
isCurrentPending
public boolean isCurrentPending()Gets whether the user has currently not yet passed the guild's Membership Screening requirements.- Returns:
- Whether the user has currently not yet passed the guild's Membership Screening requirements.
-
getCommunicationDisabledUntil
Gets when the user ends their timeout, if present.- Returns:
- When the user ends their timeout in the server, if present.
-
toString
-