Class UserTypingEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.user.GenericUserEvent

net.dv8tion.jda.api.events.user.UserTypingEvent

All Implemented Interfaces:

GenericEvent

public class UserTypingEvent
extends GenericUserEvent

Indicates that a User started typing. (Similar to the typing indicator in the Discord client)

Requirements

This event requires the GUILD_MESSAGE_TYPING intent to be enabled to fire for guild channels, and DIRECT_MESSAGE_TYPING to fire for private channels.
createDefault(String) and createLight(String) disable these by default!

Can be used to retrieve the User who started typing and when and in which MessageChannel they started typing.

Constructor Summary

Constructors

Constructor	Description
UserTypingEvent(JDA api, long responseNumber, User user, MessageChannel channel, OffsetDateTime timestamp, Member member)

Method Summary

Modifier and Type	Method	Description
MessageChannelUnion	getChannel()	The channel where the typing was started
Guild	getGuild()	Guild in which this users started typing, or null if this was not in a Guild.
Member	getMember()	Member instance for the User, or null if this was not in a Guild.
OffsetDateTime	getTimestamp()	The time when the user started typing
ChannelType	getType()	The ChannelType
boolean	isFromType(ChannelType type)	Whether the user started typing in a channel of the specified type.

Methods inherited from class GenericUserEvent

getUser

Methods inherited from class Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UserTypingEvent

public UserTypingEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 User user,
 @Nonnull
 MessageChannel channel,
 @Nonnull
 OffsetDateTime timestamp,
 @Nullable
 Member member)

Method Details

getTimestamp

@Nonnull
public OffsetDateTime getTimestamp()

The time when the user started typing

Returns:

The time when the typing started

getChannel

@Nonnull
public MessageChannelUnion getChannel()

The channel where the typing was started

Returns:

The channel

isFromType

public boolean isFromType(@Nonnull
 ChannelType type)

Whether the user started typing in a channel of the specified type.

Parameters:

type - ChannelType

Returns:

True, if the user started typing in a channel of the specified type

getType

@Nonnull
public ChannelType getType()

The ChannelType

Returns:

The ChannelType

getGuild

@Nullable
public Guild getGuild()

Guild in which this users started typing, or null if this was not in a Guild.

Returns:

Possibly-null Guild

getMember

@Nullable
public Member getMember()

Member instance for the User, or null if this was not in a Guild.

Returns:

Possibly-null Member