discord4j.core.event.domain.channel

Class TypingStartEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.channel.ChannelEvent

discord4j.core.event.domain.channel.TypingStartEvent

public class TypingStartEvent
extends ChannelEvent

Dispatched when a user starts typing in a message channel.

This event is dispatched by Discord.

See Also:

Typing Start

Constructor Summary

Constructors

Constructor and Description
TypingStartEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, long channelId, Long guildId, long userId, Instant startTime, Member member)

Method Summary

Modifier and Type	Method and Description
Mono<MessageChannel>	getChannel() Requests to retrieve the MessageChannel the user has started typing in.
Snowflake	getChannelId() Gets the Snowflake ID of the MessageChannel the user has started typing in.
Optional<Snowflake>	getGuildId() Gets the Snowflake ID of the Guild the user has started typing in, if this happened in a guild.
Optional<Member>	getMember() Gets the Member who started typing, if this happened in a guild.
Instant	getStartTime() Gets the time at which the User started typing in this event.
Mono<User>	getUser() Requests to retrieve the User who has started typing in this event.
Snowflake	getUserId() Gets the Snowflake ID of the User who has started typing in this event.
String	toString()

Methods inherited from class discord4j.core.event.domain.Event

getClient, getShardInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TypingStartEvent

public TypingStartEvent(GatewayDiscordClient gateway,
                        ShardInfo shardInfo,
                        long channelId,
                        @Nullable
                        Long guildId,
                        long userId,
                        Instant startTime,
                        @Nullable
                        Member member)

Method Detail

getChannelId

public Snowflake getChannelId()

Gets the Snowflake ID of the MessageChannel the user has started typing in.

Returns:

the ID of the MessageChannel the User is typing in.

getGuildId

public Optional<Snowflake> getGuildId()

Gets the Snowflake ID of the Guild the user has started typing in, if this happened in a guild.

Returns:

The Snowflake ID of the Guild the user has started typing in, if this happened in a guild.

getChannel

public Mono<MessageChannel> getChannel()

Requests to retrieve the MessageChannel the user has started typing in.

Returns:

A Mono where, upon successful completion, emits the MessageChannel the User has started typing in. If an error is received, it is emitted through the Mono.

getUserId

public Snowflake getUserId()

Gets the Snowflake ID of the User who has started typing in this event.

Returns:

The ID of the User who has started typing.

getUser

public Mono<User> getUser()

Requests to retrieve the User who has started typing in this event.

Returns:

A Mono where, upon successful completion, emits the User that has started typing. If an error is received, it is emitted through the Mono.

getStartTime

public Instant getStartTime()

Gets the time at which the User started typing in this event.

Returns:

The time at which the User starting typing.

getMember

public Optional<Member> getMember()

Gets the Member who started typing, if this happened in a guild.

Returns:

The Member who started typing, if this happened in a guild.

toString

public String toString()

Overrides:

toString in class Object